Skip to main content

BinanceExecClientConfigBuilder

nautilus_binance::config

Struct BinanceExecClientConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> BinanceExecClientConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn trader_id( self, value: TraderId, ) -> BinanceExecClientConfigBuilder<SetTraderId<S>>
where S::TraderId: IsUnset,

Optional (Some / Option setters). Default: TraderId::from("TRADER-001").

Trader ID for the client.

Source

pub fn maybe_trader_id( self, value: Option<TraderId>, ) -> BinanceExecClientConfigBuilder<SetTraderId<S>>
where S::TraderId: IsUnset,

Optional (Some / Option setters). Default: TraderId::from("TRADER-001").

Trader ID for the client.

Source

pub fn account_id( self, value: AccountId, ) -> BinanceExecClientConfigBuilder<SetAccountId<S>>
where S::AccountId: IsUnset,

Optional (Some / Option setters). Default: AccountId::from("BINANCE-001").

Account ID for the client.

Source

pub fn maybe_account_id( self, value: Option<AccountId>, ) -> BinanceExecClientConfigBuilder<SetAccountId<S>>
where S::AccountId: IsUnset,

Optional (Some / Option setters). Default: AccountId::from("BINANCE-001").

Account ID for the client.

Source

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

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

Product types to trade.

Source

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

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

Product types to trade.

Source

pub fn environment( self, value: BinanceEnvironment, ) -> BinanceExecClientConfigBuilder<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>, ) -> BinanceExecClientConfigBuilder<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, ) -> BinanceExecClientConfigBuilder<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>, ) -> BinanceExecClientConfigBuilder<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, ) -> BinanceExecClientConfigBuilder<SetBaseUrlWs<S>>
where S::BaseUrlWs: IsUnset,

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

Live USD-M Futures stream overrides are normalized onto the /private/ws route.

Source

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

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

Live USD-M Futures stream overrides are normalized onto the /private/ws route.

Source

pub fn base_url_ws_trading( self, value: String, ) -> BinanceExecClientConfigBuilder<SetBaseUrlWsTrading<S>>
where S::BaseUrlWsTrading: IsUnset,

Optional (Some / Option setters). Optional base URL override for WebSocket trading API (Spot and USD-M Futures).

Source

pub fn maybe_base_url_ws_trading( self, value: Option<String>, ) -> BinanceExecClientConfigBuilder<SetBaseUrlWsTrading<S>>
where S::BaseUrlWsTrading: IsUnset,

Optional (Some / Option setters). Optional base URL override for WebSocket trading API (Spot and USD-M Futures).

Source

pub fn use_ws_trading( self, value: bool, ) -> BinanceExecClientConfigBuilder<SetUseWsTrading<S>>
where S::UseWsTrading: IsUnset,

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

Whether to use the WebSocket trading API for order operations (Spot and USD-M Futures).

Source

pub fn maybe_use_ws_trading( self, value: Option<bool>, ) -> BinanceExecClientConfigBuilder<SetUseWsTrading<S>>
where S::UseWsTrading: IsUnset,

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

Whether to use the WebSocket trading API for order operations (Spot and USD-M Futures).

Source

pub fn use_position_ids( self, value: bool, ) -> BinanceExecClientConfigBuilder<SetUsePositionIds<S>>
where S::UsePositionIds: IsUnset,

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

Whether to use Binance Futures hedging position IDs.

When true, fill reports include a venue_position_id derived from the instrument and position side (e.g. ETHUSDT-PERP.BINANCE-LONG). When false, venue_position_id is None, allowing virtual positions with OmsType::Hedging.

Source

pub fn maybe_use_position_ids( self, value: Option<bool>, ) -> BinanceExecClientConfigBuilder<SetUsePositionIds<S>>
where S::UsePositionIds: IsUnset,

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

Whether to use Binance Futures hedging position IDs.

When true, fill reports include a venue_position_id derived from the instrument and position side (e.g. ETHUSDT-PERP.BINANCE-LONG). When false, venue_position_id is None, allowing virtual positions with OmsType::Hedging.

Source

pub fn default_taker_fee( self, value: Decimal, ) -> BinanceExecClientConfigBuilder<SetDefaultTakerFee<S>>
where S::DefaultTakerFee: IsUnset,

Optional (Some / Option setters). Default: Decimal::new(4, 4).

Default taker fee rate for commission estimation.

Used as a fallback when the venue omits commission fields in exchange-generated fills (liquidation, ADL, settlement). Standard Binance Futures taker fee is 0.0004 (0.04%).

Source

pub fn maybe_default_taker_fee( self, value: Option<Decimal>, ) -> BinanceExecClientConfigBuilder<SetDefaultTakerFee<S>>
where S::DefaultTakerFee: IsUnset,

Optional (Some / Option setters). Default: Decimal::new(4, 4).

Default taker fee rate for commission estimation.

Used as a fallback when the venue omits commission fields in exchange-generated fills (liquidation, ADL, settlement). Standard Binance Futures taker fee is 0.0004 (0.04%).

Source

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

Optional (Some / Option setters). API key (Ed25519 required, uses env var if not provided).

Source

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

Optional (Some / Option setters). API key (Ed25519 required, uses env var if not provided).

Source

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

Optional (Some / Option setters). API secret (Ed25519 base64-encoded, required, uses env var if not provided).

Source

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

Optional (Some / Option setters). API secret (Ed25519 base64-encoded, required, uses env var if not provided).

Source

pub fn futures_leverages( self, value: HashMap<String, u32>, ) -> BinanceExecClientConfigBuilder<SetFuturesLeverages<S>>
where S::FuturesLeverages: IsUnset,

Optional (Some / Option setters). Initial leverage per Binance symbol (e.g. BTCUSDT -> 20), applied during connect.

Source

pub fn maybe_futures_leverages( self, value: Option<HashMap<String, u32>>, ) -> BinanceExecClientConfigBuilder<SetFuturesLeverages<S>>
where S::FuturesLeverages: IsUnset,

Optional (Some / Option setters). Initial leverage per Binance symbol (e.g. BTCUSDT -> 20), applied during connect.

Source

pub fn futures_margin_types( self, value: HashMap<String, BinanceMarginType>, ) -> BinanceExecClientConfigBuilder<SetFuturesMarginTypes<S>>
where S::FuturesMarginTypes: IsUnset,

Optional (Some / Option setters). Margin type per Binance symbol (e.g. BTCUSDT -> Cross), applied during connect.

Source

pub fn maybe_futures_margin_types( self, value: Option<HashMap<String, BinanceMarginType>>, ) -> BinanceExecClientConfigBuilder<SetFuturesMarginTypes<S>>
where S::FuturesMarginTypes: IsUnset,

Optional (Some / Option setters). Margin type per Binance symbol (e.g. BTCUSDT -> Cross), applied during connect.

Source

pub fn treat_expired_as_canceled( self, value: bool, ) -> BinanceExecClientConfigBuilder<SetTreatExpiredAsCanceled<S>>
where S::TreatExpiredAsCanceled: IsUnset,

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

If true, the EXPIRED execution type emits OrderCanceled instead of OrderExpired.

Binance uses EXPIRED for certain cancel scenarios depending on order type and time-in-force combination.

Source

pub fn maybe_treat_expired_as_canceled( self, value: Option<bool>, ) -> BinanceExecClientConfigBuilder<SetTreatExpiredAsCanceled<S>>
where S::TreatExpiredAsCanceled: IsUnset,

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

If true, the EXPIRED execution type emits OrderCanceled instead of OrderExpired.

Binance uses EXPIRED for certain cancel scenarios depending on order type and time-in-force combination.

Source

pub fn use_trade_lite( self, value: bool, ) -> BinanceExecClientConfigBuilder<SetUseTradeLite<S>>
where S::UseTradeLite: IsUnset,

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

If true, drive fills from the lower-latency TRADE_LITE user data event and dedup the matching fill portion of ORDER_TRADE_UPDATE. If false, TRADE_LITE events are ignored and fills come from ORDER_TRADE_UPDATE.

Source

pub fn maybe_use_trade_lite( self, value: Option<bool>, ) -> BinanceExecClientConfigBuilder<SetUseTradeLite<S>>
where S::UseTradeLite: IsUnset,

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

If true, drive fills from the lower-latency TRADE_LITE user data event and dedup the matching fill portion of ORDER_TRADE_UPDATE. If false, TRADE_LITE events are ignored and fills come from ORDER_TRADE_UPDATE.

Source

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