Skip to main content

DeribitDataClientConfigBuilder

Struct DeribitDataClientConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> DeribitDataClientConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

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

Optional (Some / Option setters). Optional API key for authenticated endpoints.

Source

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

Optional (Some / Option setters). Optional API key for authenticated endpoints.

Source

pub fn api_secret( self, value: SecretString, ) -> DeribitDataClientConfigBuilder<SetApiSecret<S>>
where S::ApiSecret: IsUnset,

Optional (Some / Option setters). Optional API secret for authenticated endpoints.

Source

pub fn maybe_api_secret( self, value: Option<SecretString>, ) -> DeribitDataClientConfigBuilder<SetApiSecret<S>>
where S::ApiSecret: IsUnset,

Optional (Some / Option setters). Optional API secret for authenticated endpoints.

Source

pub fn product_types( self, value: Vec<DeribitProductType>, ) -> DeribitDataClientConfigBuilder<SetProductTypes<S>>
where S::ProductTypes: IsUnset,

Optional (Some / Option setters). Default: vec![DeribitProductType::Future].

Product types to load (e.g., Future, Option, Spot).

Source

pub fn maybe_product_types( self, value: Option<Vec<DeribitProductType>>, ) -> DeribitDataClientConfigBuilder<SetProductTypes<S>>
where S::ProductTypes: IsUnset,

Optional (Some / Option setters). Default: vec![DeribitProductType::Future].

Product types to load (e.g., Future, Option, Spot).

Source

pub fn environment( self, value: DeribitEnvironment, ) -> DeribitDataClientConfigBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

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

The Deribit environment (mainnet or testnet).

Source

pub fn maybe_environment( self, value: Option<DeribitEnvironment>, ) -> DeribitDataClientConfigBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

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

The Deribit environment (mainnet or testnet).

Source

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

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

Source

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

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

Source

pub fn base_url_ws( self, value: String, ) -> DeribitDataClientConfigBuilder<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>, ) -> DeribitDataClientConfigBuilder<SetBaseUrlWs<S>>
where S::BaseUrlWs: IsUnset,

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

Source

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

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

Source

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

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

Source

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

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

HTTP timeout in seconds.

Source

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

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

HTTP timeout in seconds.

Source

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

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

Maximum retry attempts for requests.

Source

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

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

Maximum retry attempts for requests.

Source

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

Optional (Some / Option setters). Default: 1_000.

Initial retry delay in milliseconds.

Source

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

Optional (Some / Option setters). Default: 1_000.

Initial retry delay in milliseconds.

Source

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

Optional (Some / Option setters). Default: 10_000.

Maximum retry delay in milliseconds.

Source

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

Optional (Some / Option setters). Default: 10_000.

Maximum retry delay in milliseconds.

Source

pub fn heartbeat_interval_secs( self, value: u64, ) -> DeribitDataClientConfigBuilder<SetHeartbeatIntervalSecs<S>>
where S::HeartbeatIntervalSecs: IsUnset,

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

Heartbeat interval in seconds for WebSocket connection.

Source

pub fn maybe_heartbeat_interval_secs( self, value: Option<u64>, ) -> DeribitDataClientConfigBuilder<SetHeartbeatIntervalSecs<S>>
where S::HeartbeatIntervalSecs: IsUnset,

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

Heartbeat interval in seconds for WebSocket connection.

Source

pub fn auth_timeout_secs( self, value: u64, ) -> DeribitDataClientConfigBuilder<SetAuthTimeoutSecs<S>>
where S::AuthTimeoutSecs: IsUnset,

Optional (Some / Option setters). Optional WebSocket authentication timeout (seconds), defaulting to AUTHENTICATION_TIMEOUT_SECS when unset.

Source

pub fn maybe_auth_timeout_secs( self, value: Option<u64>, ) -> DeribitDataClientConfigBuilder<SetAuthTimeoutSecs<S>>
where S::AuthTimeoutSecs: IsUnset,

Optional (Some / Option setters). Optional WebSocket authentication timeout (seconds), defaulting to AUTHENTICATION_TIMEOUT_SECS when unset.

Source

pub fn update_instruments_interval_mins( self, value: u64, ) -> DeribitDataClientConfigBuilder<SetUpdateInstrumentsIntervalMins<S>>
where S::UpdateInstrumentsIntervalMins: IsUnset,

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

Interval in minutes for refreshing instruments of the configured product types. A zero value disables periodic refresh.

Source

pub fn maybe_update_instruments_interval_mins( self, value: Option<u64>, ) -> DeribitDataClientConfigBuilder<SetUpdateInstrumentsIntervalMins<S>>
where S::UpdateInstrumentsIntervalMins: IsUnset,

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

Interval in minutes for refreshing instruments of the configured product types. A zero value disables periodic refresh.

Source

pub fn auto_load_missing_instruments( self, value: bool, ) -> DeribitDataClientConfigBuilder<SetAutoLoadMissingInstruments<S>>
where S::AutoLoadMissingInstruments: IsUnset,

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

If true, subscribes for uncached instruments lazy-load via HTTP; otherwise fail fast.

Source

pub fn maybe_auto_load_missing_instruments( self, value: Option<bool>, ) -> DeribitDataClientConfigBuilder<SetAutoLoadMissingInstruments<S>>
where S::AutoLoadMissingInstruments: IsUnset,

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

If true, subscribes for uncached instruments lazy-load via HTTP; otherwise fail fast.

Source

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

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

WebSocket transport backend (defaults to Tungstenite).

Source

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

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

WebSocket transport backend (defaults to Tungstenite).

Source

pub fn load_ids( self, value: Vec<InstrumentId>, ) -> DeribitDataClientConfigBuilder<SetLoadIds<S>>
where S::LoadIds: IsUnset,

Optional (Some / Option setters). Extra instruments to load on connect.

None or empty adds none. Set the same value on the execution client. That client uses the value as the reconciliation scope.

Source

pub fn maybe_load_ids( self, value: Option<Vec<InstrumentId>>, ) -> DeribitDataClientConfigBuilder<SetLoadIds<S>>
where S::LoadIds: IsUnset,

Optional (Some / Option setters). Extra instruments to load on connect.

None or empty adds none. Set the same value on the execution client. That client uses the value as the reconciliation scope.

Source

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

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

Maximum wait for an initial, post-reconnect, or recovery book snapshot, in seconds. A zero value disables snapshot deadlines.

Source

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

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

Maximum wait for an initial, post-reconnect, or recovery book snapshot, in seconds. A zero value disables snapshot deadlines.

Source

pub fn book_stale_threshold_secs( self, value: u64, ) -> DeribitDataClientConfigBuilder<SetBookStaleThresholdSecs<S>>
where S::BookStaleThresholdSecs: IsUnset,

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

Maximum receive age of accepted book frames before recovery, in seconds. A zero value disables stale book recovery.

Source

pub fn maybe_book_stale_threshold_secs( self, value: Option<u64>, ) -> DeribitDataClientConfigBuilder<SetBookStaleThresholdSecs<S>>
where S::BookStaleThresholdSecs: IsUnset,

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

Maximum receive age of accepted book frames before recovery, in seconds. A zero value disables stale book recovery.

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