Struct BinanceMarginConfig 

pub struct BinanceMarginConfig {
    pub testnet: bool,
    pub is_isolated: bool,
    pub isolated_symbols: Vec<InstrumentNameExchange>,
    pub margin_effect: MarginEffect,
    pub auto_repay_at_cancel: bool,
    pub pre_send_rules: PreSendRules,
    pub server_time_sync: bool,
    /* private fields */
}

Configuration for the BinanceMargin execution client.

Mirrors BinanceSpotConfig’s credential handling (private keys, secret-redacting Debug, Deserialize-only) and adds margin-specific knobs.

Fields

testnet: bool

Use testnet endpoints instead of production.

Inert for margin: Binance margin/SAPI has no testnet, so this field is always treated as production. Retained to mirror the spot config shape; BinanceMargin::new warns if it is set to true.

is_isolated: bool

Isolated margin (per-pair sub-accounts) when true; cross margin (account-wide) when false.

Defaults to false (cross). When true, isolated_symbols must be non-empty — it declares the pairs to snapshot/stream; BinanceMargin::new panics otherwise.

isolated_symbols: Vec<InstrumentNameExchange>

The isolated-margin pairs this client snapshots and streams when is_isolated is true.

This is the authoritative symbol universe for the isolated account stream, which keeps the frames of these pairs and drops those of any other. Each pair’s base and quote asset are read when the stream opens, so the set is fixed for the stream’s lifetime: a pair added after account_stream is called is not picked up — reconfigure and restart the stream for it.

Ignored for cross margin (is_isolated = false). Empty by default; a true + empty-set combination is a misconfiguration that panics in BinanceMargin::new.

margin_effect: MarginEffect

The MarginEffect of an order whose request carries none.

Defaults to MarginEffect::NoSideEffect, Binance’s own default, so that no order takes on debt unless the caller asks. A side_effect key from an earlier version is ignored.

auto_repay_at_cancel: bool

Whether the debt of an order that is cancelled before it fills is repaid, as Binance’s autoRepayAtCancel. Sent with every MarginEffect::Borrow order, and with no other.

Defaults to true, Binance’s default. Binance suggests false for a strategy that places and cancels at high frequency: the repay is a request of its own. With it off, a cancelled order’s loan stays owed until a MarginEffect::Repay order repays it.

pre_send_rules: PreSendRules

Whether an order is checked against its pair’s tick, lot and notional rules before it is sent. Defaults to PreSendRules::Enforce.

Binance margin publishes no rules of its own: the check reads the pair’s spot rules, which a margin order obeys.

server_time_sync: bool

Whether signed requests are stamped with Binance’s clock, read from its server time, rather than this host’s. Defaults to true. See BinanceMargin::host_clock_lead.

Implementations

impl BinanceMarginConfig

pub fn new( api_key: String, secret_key: String, testnet: bool, is_isolated: bool, isolated_symbols: Vec<InstrumentNameExchange>, margin_effect: MarginEffect, auto_repay_at_cancel: bool, ) -> Self

Construct a BinanceMarginConfig with explicit control over every field.

Prefer BinanceMarginConfig::cross_margin / BinanceMarginConfig::isolated for the common cases, or deserialize from a config file to keep credentials out of source. The positional args expose every field for full control; defaultable knobs (is_isolated, isolated_symbols, margin_effect, auto_repay_at_cancel) also default via #[serde(default)] on the file path.

Note: this does not itself validate is_isolated against isolated_symbols; that gate lives in BinanceMargin::new (it must also cover the Deserialize-only path).

pub fn with_pre_send_rules(self, pre_send_rules: PreSendRules) -> Self

Set whether an order is checked against its pair’s rules before it is sent.

pub fn with_server_time_sync(self, server_time_sync: bool) -> Self

Set whether signed requests are stamped with Binance’s clock, read from its server time (server_time_sync).

pub fn cross_margin(api_key: String, secret_key: String) -> Self

Convenience constructor for the common case: cross margin, production endpoints, and the default MarginEffect::NoSideEffect.

Equivalent to new with testnet = false, is_isolated = false, no isolated_symbols, the default margin_effect and auto_repay_at_cancel = true. Use new when any of those need to differ.

pub fn isolated( api_key: String, secret_key: String, symbols: Vec<InstrumentNameExchange>, ) -> Self

Convenience constructor for isolated margin: production endpoints, the default MarginEffect::NoSideEffect, and the given per-pair symbol universe (see isolated_symbols).

symbols should be non-empty: an isolated client with no symbols has nothing to snapshot or stream and BinanceMargin::new panics on it. Use new to override margin_effect.

pub fn api_key(&self) -> &str

Read-only access to the API key (e.g. for logging or header construction).

Trait Implementations

impl Clone for BinanceMarginConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BinanceMarginConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BinanceMarginConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.