Skip to main content

CoinApiDataClientConfigBuilder

nautilus_coinapi::config

Struct CoinApiDataClientConfigBuilder 

Source 
pub struct CoinApiDataClientConfigBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> CoinApiDataClientConfigBuilder<S>

Source

pub fn build(self) -> CoinApiDataClientConfig
where S: IsComplete,

Finish building and return the requested object

Source

pub fn api_key( self, value: SecretString, ) -> CoinApiDataClientConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). API key; None falls back to the COINAPI_API_KEY environment variable.

Source

pub fn maybe_api_key( self, value: Option<SecretString>, ) -> CoinApiDataClientConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). API key; None falls back to the COINAPI_API_KEY environment variable.

Source

pub fn base_url_http( self, value: String, ) -> CoinApiDataClientConfigBuilder<SetBaseUrlHttp<S>>
where S::BaseUrlHttp: IsUnset,

Optional (Some / Option setters). Optional override for the REST base URL, including its version prefix.

Source

pub fn maybe_base_url_http( self, value: Option<String>, ) -> CoinApiDataClientConfigBuilder<SetBaseUrlHttp<S>>
where S::BaseUrlHttp: IsUnset,

Optional (Some / Option setters). Optional override for the REST base URL, including its version prefix.

Source

pub fn base_url_ws( self, value: String, ) -> CoinApiDataClientConfigBuilder<SetBaseUrlWs<S>>
where S::BaseUrlWs: IsUnset,

Optional (Some / Option setters). Optional override for the WebSocket URL.

Source

pub fn maybe_base_url_ws( self, value: Option<String>, ) -> CoinApiDataClientConfigBuilder<SetBaseUrlWs<S>>
where S::BaseUrlWs: IsUnset,

Optional (Some / Option setters). Optional override for the WebSocket URL.

Source

pub fn proxy_url( self, value: SecretString, ) -> CoinApiDataClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

Optional (Some / Option setters). Optional explicit proxy URL for HTTP and WebSocket transports.

Source

pub fn maybe_proxy_url( self, value: Option<SecretString>, ) -> CoinApiDataClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

Optional (Some / Option setters). Optional explicit proxy URL for HTTP and WebSocket transports.

Source

pub fn instruments( self, value: Vec<CoinApiInstrumentSelection>, ) -> CoinApiDataClientConfigBuilder<SetInstruments<S>>
where S::Instruments: IsUnset,

Optional (Some / Option setters). Default: <Vec<CoinApiInstrumentSelection> as Default>::default().

Instruments loaded on connect and served by instrument requests.

Source

pub fn maybe_instruments( self, value: Option<Vec<CoinApiInstrumentSelection>>, ) -> CoinApiDataClientConfigBuilder<SetInstruments<S>>
where S::Instruments: IsUnset,

Optional (Some / Option setters). Default: <Vec<CoinApiInstrumentSelection> as Default>::default().

Instruments loaded on connect and served by instrument requests.

Source

pub fn credit_budget( self, value: u64, ) -> CoinApiDataClientConfigBuilder<SetCreditBudget<S>>
where S::CreditBudget: IsUnset,

Optional (Some / Option setters). Default: CoinApiHttpConfig::default().credit_budget.

Conservative lifetime REST credit allowance for this client; see CoinApiHttpConfig.

Source

pub fn maybe_credit_budget( self, value: Option<u64>, ) -> CoinApiDataClientConfigBuilder<SetCreditBudget<S>>
where S::CreditBudget: IsUnset,

Optional (Some / Option setters). Default: CoinApiHttpConfig::default().credit_budget.

Conservative lifetime REST credit allowance for this client; see CoinApiHttpConfig.

Source

pub fn max_retries( self, value: u32, ) -> CoinApiDataClientConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

Optional (Some / Option setters). Default: CoinApiHttpConfig::default().retry.max_retries.

Maximum retries for a failed REST request.

Source

pub fn maybe_max_retries( self, value: Option<u32>, ) -> CoinApiDataClientConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

Optional (Some / Option setters). Default: CoinApiHttpConfig::default().retry.max_retries.

Maximum retries for a failed REST request.

Source

pub fn http_timeout_secs( self, value: u64, ) -> CoinApiDataClientConfigBuilder<SetHttpTimeoutSecs<S>>
where S::HttpTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default:

CoinApiHttpConfig::default()
    .retry
    .operation_timeout_ms
    .expect("default REST timeout is set") / 1_000

Positive per-attempt REST timeout in seconds, including concurrency admission.

Source

pub fn maybe_http_timeout_secs( self, value: Option<u64>, ) -> CoinApiDataClientConfigBuilder<SetHttpTimeoutSecs<S>>
where S::HttpTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default:

CoinApiHttpConfig::default()
    .retry
    .operation_timeout_ms
    .expect("default REST timeout is set") / 1_000

Positive per-attempt REST timeout in seconds, including concurrency admission.

Source

pub fn max_concurrent_requests( self, value: usize, ) -> CoinApiDataClientConfigBuilder<SetMaxConcurrentRequests<S>>
where S::MaxConcurrentRequests: IsUnset,

Optional (Some / Option setters). Default: CoinApiHttpConfig::default().max_concurrent_requests.

Maximum simultaneous REST requests for this client instance.

Source

pub fn maybe_max_concurrent_requests( self, value: Option<usize>, ) -> CoinApiDataClientConfigBuilder<SetMaxConcurrentRequests<S>>
where S::MaxConcurrentRequests: IsUnset,

Optional (Some / Option setters). Default: CoinApiHttpConfig::default().max_concurrent_requests.

Maximum simultaneous REST requests for this client instance.

Source

pub fn retry_delay_initial_ms( self, value: u64, ) -> CoinApiDataClientConfigBuilder<SetRetryDelayInitialMs<S>>
where S::RetryDelayInitialMs: IsUnset,

Optional (Some / Option setters). Default: CoinApiHttpConfig::default().retry.initial_delay_ms.

Initial REST retry delay in milliseconds.

Source

pub fn maybe_retry_delay_initial_ms( self, value: Option<u64>, ) -> CoinApiDataClientConfigBuilder<SetRetryDelayInitialMs<S>>
where S::RetryDelayInitialMs: IsUnset,

Optional (Some / Option setters). Default: CoinApiHttpConfig::default().retry.initial_delay_ms.

Initial REST retry delay in milliseconds.

Source

pub fn retry_delay_max_ms( self, value: u64, ) -> CoinApiDataClientConfigBuilder<SetRetryDelayMaxMs<S>>
where S::RetryDelayMaxMs: IsUnset,

Optional (Some / Option setters). Default: CoinApiHttpConfig::default().retry.max_delay_ms.

Maximum REST retry backoff in milliseconds; provider retry delays can exceed it.

Source

pub fn maybe_retry_delay_max_ms( self, value: Option<u64>, ) -> CoinApiDataClientConfigBuilder<SetRetryDelayMaxMs<S>>
where S::RetryDelayMaxMs: IsUnset,

Optional (Some / Option setters). Default: CoinApiHttpConfig::default().retry.max_delay_ms.

Maximum REST retry backoff in milliseconds; provider retry delays can exceed it.

Source

pub fn retry_max_elapsed_ms( self, value: u64, ) -> CoinApiDataClientConfigBuilder<SetRetryMaxElapsedMs<S>>
where S::RetryMaxElapsedMs: IsUnset,

Optional (Some / Option setters). Default:

CoinApiHttpConfig::default()
    .retry
    .max_elapsed_ms
    .expect("default REST elapsed budget is set")

Positive total REST elapsed budget in milliseconds, including admission and retries.

Source

pub fn maybe_retry_max_elapsed_ms( self, value: Option<u64>, ) -> CoinApiDataClientConfigBuilder<SetRetryMaxElapsedMs<S>>
where S::RetryMaxElapsedMs: IsUnset,

Optional (Some / Option setters). Default:

CoinApiHttpConfig::default()
    .retry
    .max_elapsed_ms
    .expect("default REST elapsed budget is set")

Positive total REST elapsed budget in milliseconds, including admission and retries.

Source

pub fn transport_backend( self, value: TransportBackend, ) -> CoinApiDataClientConfigBuilder<SetTransportBackend<S>>
where S::TransportBackend: IsUnset,

Optional (Some / Option setters). Default: <TransportBackend as Default>::default().

WebSocket transport backend.

Source

pub fn maybe_transport_backend( self, value: Option<TransportBackend>, ) -> CoinApiDataClientConfigBuilder<SetTransportBackend<S>>
where S::TransportBackend: IsUnset,

Optional (Some / Option setters). Default: <TransportBackend as Default>::default().

WebSocket transport backend.

Source

pub fn book_snapshot_timeout_secs( self, value: u64, ) -> CoinApiDataClientConfigBuilder<SetBookSnapshotTimeoutSecs<S>>
where S::BookSnapshotTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_BOOK_SNAPSHOT_TIMEOUT_SECS.

Seconds to wait for an order book snapshot after a subscription, reconnect, or recovery request; zero disables the deadline.

Source

pub fn maybe_book_snapshot_timeout_secs( self, value: Option<u64>, ) -> CoinApiDataClientConfigBuilder<SetBookSnapshotTimeoutSecs<S>>
where S::BookSnapshotTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_BOOK_SNAPSHOT_TIMEOUT_SECS.

Seconds to wait for an order book snapshot after a subscription, reconnect, or recovery request; zero disables the deadline.

Source

pub fn price_precisions( self, value: HashMap<InstrumentId, u8>, ) -> CoinApiDataClientConfigBuilder<SetPricePrecisions<S>>
where S::PricePrecisions: IsUnset,

Optional (Some / Option setters). Default: <HashMap<InstrumentId, u8> as Default>::default().

Price precision by selected instrument, replacing the CoinAPI price resolution when it is coarser than the prices the venue quotes.

Source

pub fn maybe_price_precisions( self, value: Option<HashMap<InstrumentId, u8>>, ) -> CoinApiDataClientConfigBuilder<SetPricePrecisions<S>>
where S::PricePrecisions: IsUnset,

Optional (Some / Option setters). Default: <HashMap<InstrumentId, u8> as Default>::default().

Price precision by selected instrument, replacing the CoinAPI price resolution when it is coarser than the prices the venue quotes.

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more