Struct BinanceMarginConfig 

pub struct BinanceMarginConfig {
    pub testnet: bool,
    pub is_isolated: bool,
    pub isolated_symbols: Vec<InstrumentNameExchange>,
    pub side_effect: MarginSideEffect,
    /* 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 per-symbol userListenToken token/subscription fan-out: tokens are per-symbol and must be known at stream start, so the set is fixed for the stream’s lifetime. A pair activated after account_stream is called is not auto-subscribed — reconfigure and restart the stream to pick it up.

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

side_effect: MarginSideEffect

Borrow/repay policy applied to every order placed by this client.

Defaults to MarginSideEffect::AutoBorrowRepay — see its # Warning on silent borrowing.

Implementations

impl BinanceMarginConfig

pub fn new( api_key: String, secret_key: String, testnet: bool, is_isolated: bool, isolated_symbols: Vec<InstrumentNameExchange>, side_effect: MarginSideEffect, ) -> 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, side_effect) 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 cross_margin(api_key: String, secret_key: String) -> Self

Convenience constructor for the common case: cross margin, production endpoints, and the default MarginSideEffect::AutoBorrowRepay borrow/repay policy.

Equivalent to new with testnet = false, is_isolated = false, no isolated_symbols, and the default side_effect. 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 MarginSideEffect::AutoBorrowRepay borrow/repay policy, 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 side_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) -> BinanceMarginConfig

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.