Skip to main content

BinanceDataClientConfigBuilder

nautilus_binance::config

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_types( self, value: Vec<BinanceProductType>, ) -> BinanceDataClientConfigBuilder<SetProductTypes<S>>
where S::ProductTypes: IsUnset,

Optional (Some / Option setters). Default: vec![BinanceProductType::Spot].

Product types to subscribe to.

Source

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

Optional (Some / Option setters). Default: vec![BinanceProductType::Spot].

Product types to subscribe to.

Source

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

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

Environment (mainnet or testnet).

Source

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

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

Environment (mainnet or testnet).

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 api_key( self, value: String, ) -> BinanceDataClientConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

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

Source

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

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

Source

pub fn api_secret( self, value: String, ) -> 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<String>, ) -> BinanceDataClientConfigBuilder<SetApiSecret<S>>
where S::ApiSecret: IsUnset,

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

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

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,