Skip to main content

BybitDataClientConfigBuilder

nautilus_bybit::config

Struct BybitDataClientConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> BybitDataClientConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

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

Optional (Some / Option setters). Optional API key for authenticated REST/WebSocket requests.

Source

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

Optional (Some / Option setters). Optional API key for authenticated REST/WebSocket requests.

Source

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

Optional (Some / Option setters). Optional API secret for authenticated REST/WebSocket requests.

Source

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

Optional (Some / Option setters). Optional API secret for authenticated REST/WebSocket requests.

Source

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

Optional (Some / Option setters). Default: vec![BybitProductType::Linear].

Product types to subscribe to (e.g., Linear, Spot, Inverse, Option).

Source

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

Optional (Some / Option setters). Default: vec![BybitProductType::Linear].

Product types to subscribe to (e.g., Linear, Spot, Inverse, Option).

Source

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

Optional (Some / Option setters). Default: BybitEnvironment::Mainnet.

Environment selection (Mainnet, Testnet, Demo).

Source

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

Optional (Some / Option setters). Default: BybitEnvironment::Mainnet.

Environment selection (Mainnet, Testnet, Demo).

Source

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

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

Source

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

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

Source

pub fn base_url_ws_public( self, value: String, ) -> BybitDataClientConfigBuilder<SetBaseUrlWsPublic<S>>
where S::BaseUrlWsPublic: IsUnset,

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

Source

pub fn maybe_base_url_ws_public( self, value: Option<String>, ) -> BybitDataClientConfigBuilder<SetBaseUrlWsPublic<S>>
where S::BaseUrlWsPublic: IsUnset,

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

Source

pub fn base_url_ws_private( self, value: String, ) -> BybitDataClientConfigBuilder<SetBaseUrlWsPrivate<S>>
where S::BaseUrlWsPrivate: IsUnset,

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

Source

pub fn maybe_base_url_ws_private( self, value: Option<String>, ) -> BybitDataClientConfigBuilder<SetBaseUrlWsPrivate<S>>
where S::BaseUrlWsPrivate: IsUnset,

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

Source

pub fn proxy_url( self, value: String, ) -> BybitDataClientConfigBuilder<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<String>, ) -> BybitDataClientConfigBuilder<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, ) -> BybitDataClientConfigBuilder<SetHttpTimeoutSecs<S>>
where S::HttpTimeoutSecs: IsUnset,

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

REST timeout in seconds.

Source

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

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

REST timeout in seconds.

Source

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

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

Maximum retry attempts for REST requests.

Source

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

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

Maximum retry attempts for REST requests.

Source

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

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

Initial retry backoff in milliseconds.

Source

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

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

Initial retry backoff in milliseconds.

Source

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

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

Maximum retry backoff in milliseconds.

Source

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

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

Maximum retry backoff in milliseconds.

Source

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

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

Heartbeat interval in seconds for WebSocket clients.

Source

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

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

Heartbeat interval in seconds for WebSocket clients.

Source

pub fn recv_window_ms( self, value: u64, ) -> BybitDataClientConfigBuilder<SetRecvWindowMs<S>>
where S::RecvWindowMs: IsUnset,

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

Receive window in milliseconds for signed requests.

Source

pub fn maybe_recv_window_ms( self, value: Option<u64>, ) -> BybitDataClientConfigBuilder<SetRecvWindowMs<S>>
where S::RecvWindowMs: IsUnset,

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

Receive window in milliseconds for signed requests.

Source

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

Optional (Some / Option setters). Interval in minutes for instrument refresh from REST. When None, instrument refresh is disabled.

Source

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

Optional (Some / Option setters). Interval in minutes for instrument refresh from REST. When None, instrument refresh is disabled.

Source

pub fn instrument_status_poll_secs( self, value: u64, ) -> BybitDataClientConfigBuilder<SetInstrumentStatusPollSecs<S>>
where S::InstrumentStatusPollSecs: IsUnset,

Optional (Some / Option setters). Interval in seconds for polling instrument status changes. When None, status polling is disabled.

Source

pub fn maybe_instrument_status_poll_secs( self, value: Option<u64>, ) -> BybitDataClientConfigBuilder<SetInstrumentStatusPollSecs<S>>
where S::InstrumentStatusPollSecs: IsUnset,

Optional (Some / Option setters). Interval in seconds for polling instrument status changes. When None, status polling is disabled.

Source

pub fn transport_backend( self, value: TransportBackend, ) -> BybitDataClientConfigBuilder<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>, ) -> BybitDataClientConfigBuilder<SetTransportBackend<S>>
where S::TransportBackend: IsUnset,

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

WebSocket transport backend (defaults to Tungstenite).

Auto Trait Implementations§

Blanket Implementations§

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
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: 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: 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
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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
§

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

§

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