Skip to main content

BinanceDataClientConfigBuilder

Struct BinanceDataClientConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> BinanceDataClientConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn product_type( self, value: BinanceProductType, ) -> BinanceDataClientConfigBuilder<SetProductType<S>>
where S::ProductType: IsUnset,

Optional (Some / Option setters). Default: BinanceProductType::Spot.

Product type to subscribe to.

Source

pub fn maybe_product_type( self, value: Option<BinanceProductType>, ) -> BinanceDataClientConfigBuilder<SetProductType<S>>
where S::ProductType: IsUnset,

Optional (Some / Option setters). Default: BinanceProductType::Spot.

Product type to subscribe to.

Source

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

Optional (Some / Option setters). Default: BinanceEnvironment::Live.

Environment (live, testnet, or demo).

Source

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

Optional (Some / Option setters). Default: BinanceEnvironment::Live.

Environment (live, testnet, or demo).

Source

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

Optional (Some / Option setters). API key (Ed25519).

Source

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

Optional (Some / Option setters). API key (Ed25519).

Source

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

Optional (Some / Option setters). API secret (Ed25519 base64-encoded or PEM).

Source

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

Optional (Some / Option setters). API secret (Ed25519 base64-encoded or PEM).

Source

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

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

Source

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

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

Source

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

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

Live USD-M Futures data overrides are normalized onto the matching /market/ws and /public/ws routes.

Source

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

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

Live USD-M Futures data overrides are normalized onto the matching /market/ws and /public/ws routes.

Source

pub fn proxy_url( self, value: SecretString, ) -> BinanceDataClientConfigBuilder<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>, ) -> BinanceDataClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

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

Source

pub fn spot_market_data_mode( self, value: BinanceSpotMarketDataMode, ) -> BinanceDataClientConfigBuilder<SetSpotMarketDataMode<S>>
where S::SpotMarketDataMode: IsUnset,

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

Spot market-data transport mode.

  • Sbe uses SBE streams and requires Ed25519 credentials.
  • Json forces public JSON streams with no credentials.
Source

pub fn maybe_spot_market_data_mode( self, value: Option<BinanceSpotMarketDataMode>, ) -> BinanceDataClientConfigBuilder<SetSpotMarketDataMode<S>>
where S::SpotMarketDataMode: IsUnset,

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

Spot market-data transport mode.

  • Sbe uses SBE streams and requires Ed25519 credentials.
  • Json forces public JSON streams with no credentials.
Source

pub fn use_usdm_raw_trades( self, value: bool, ) -> BinanceDataClientConfigBuilder<SetUseUsdmRawTrades<S>>
where S::UseUsdmRawTrades: IsUnset,

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

Whether USD-M Futures trade subscriptions use the raw <symbol>@trade stream.

When false, trades come from <symbol>@aggTrade. When true, each order book trade emits one TradeTick with the venue trade ID instead of the aggregate trade ID. Binance serves the raw stream on the public route but does not list it in the USD-M market stream documentation. Supported for USD-M Futures clients only.

Source

pub fn maybe_use_usdm_raw_trades( self, value: Option<bool>, ) -> BinanceDataClientConfigBuilder<SetUseUsdmRawTrades<S>>
where S::UseUsdmRawTrades: IsUnset,

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

Whether USD-M Futures trade subscriptions use the raw <symbol>@trade stream.

When false, trades come from <symbol>@aggTrade. When true, each order book trade emits one TradeTick with the venue trade ID instead of the aggregate trade ID. Binance serves the raw stream on the public route but does not list it in the USD-M market stream documentation. Supported for USD-M Futures clients only.

Source

pub fn instrument_provider( self, value: BinanceInstrumentProviderConfig, ) -> BinanceDataClientConfigBuilder<SetInstrumentProvider<S>>
where S::InstrumentProvider: IsUnset,

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

Instrument loading and fee configuration.

Source

pub fn maybe_instrument_provider( self, value: Option<BinanceInstrumentProviderConfig>, ) -> BinanceDataClientConfigBuilder<SetInstrumentProvider<S>>
where S::InstrumentProvider: IsUnset,

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

Instrument loading and fee configuration.

Source

pub fn instrument_refresh_interval_secs( self, value: u64, ) -> BinanceDataClientConfigBuilder<SetInstrumentRefreshIntervalSecs<S>>
where S::InstrumentRefreshIntervalSecs: IsUnset,

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

Interval in seconds for a full instrument catalog refresh.

Set to 0 to disable. Defaults to 3600 (60 minutes).

Source

pub fn maybe_instrument_refresh_interval_secs( self, value: Option<u64>, ) -> BinanceDataClientConfigBuilder<SetInstrumentRefreshIntervalSecs<S>>
where S::InstrumentRefreshIntervalSecs: IsUnset,

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

Interval in seconds for a full instrument catalog refresh.

Set to 0 to disable. Defaults to 3600 (60 minutes).

Source

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

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

Interval in seconds for polling exchange info to detect instrument status changes (e.g. Trading -> Halt). Set to 0 to disable. Defaults to 3600 (60 minutes).

Source

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

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

Interval in seconds for polling exchange info to detect instrument status changes (e.g. Trading -> Halt). Set to 0 to disable. Defaults to 3600 (60 minutes).

Source

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

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

Maximum time to wait for an initial, post-reconnect, or recovery order book snapshot in seconds.

Bounds each REST depth snapshot request for diff depth books. Set to 0 to disable.

Source

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

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

Maximum time to wait for an initial, post-reconnect, or recovery order book snapshot in seconds.

Bounds each REST depth snapshot request for diff depth books. Set to 0 to disable.

Source

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

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

Receive window in milliseconds for signed HTTP requests.

Source

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

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

Receive window in milliseconds for signed HTTP requests.

Source

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

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

Maximum retries for HTTP GET requests. Mutating requests are sent once.

Source

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

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

Maximum retries for HTTP GET requests. Mutating requests are sent once.

Source

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

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

Initial HTTP retry delay in milliseconds.

Source

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

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

Initial HTTP retry delay in milliseconds.

Source

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

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

Maximum exponential HTTP retry delay in milliseconds.

Source

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

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

Maximum exponential HTTP retry delay in milliseconds.

Source

pub fn us(self, value: bool) -> BinanceDataClientConfigBuilder<SetUs<S>>
where S::Us: IsUnset,

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

Whether to route this Spot client to Binance US.

Source

pub fn maybe_us( self, value: Option<bool>, ) -> BinanceDataClientConfigBuilder<SetUs<S>>
where S::Us: IsUnset,

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

Whether to route this Spot client to Binance US.

Source

pub fn transport_backend( self, value: TransportBackend, ) -> BinanceDataClientConfigBuilder<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>, ) -> BinanceDataClientConfigBuilder<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§

§

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