Enum MarginSideEffect 

pub enum MarginSideEffect {
    AutoBorrowRepay,
    NoBorrow,
}

Whether a margin account borrows what an order lacks and repays its loans from what an order receives, fixed once per client or simulated venue.

Only the two intent-agnostic modes are modelled. Whether an order opens or closes a position decides whether it should borrow or repay, and that is position state the library deliberately does not track, so the venue is left to infer it from the account’s loans. The per-order modes (Binance’s MARGIN_BUY / AUTO_REPAY) are intentionally not modelled here; they belong to a future generic per-order RequestOpen::margin_effect field that all margin adapters would map, added only when a venue with genuine per-order borrow intent appears. Mixed borrow appetite on a single venue today means running two clients (one per mode).

The Serialize/Deserialize wire form is the config-file value ("auto_borrow_repay" / "no_borrow"), which is not any venue’s API value.

Variants

AutoBorrowRepay

Borrow what an order lacks when it is placed, and repay loans from what an order receives, as Binance’s AUTO_BORROW_REPAY does.

Warning

This is the default because it makes shorting work out of the box, but it means a mis-sized order silently takes on debt: an order larger than the free balance borrows the shortfall without any further opt-in (same footgun class as RequestOpen::reduce_only). Use MarginSideEffect::NoBorrow for a client that must never silently borrow.

NoBorrow

Never borrow or repay; an order that would need to borrow is rejected, as Binance’s NO_SIDE_EFFECT is. The conservative opt-out from the AutoBorrowRepay silent-borrow behaviour.

Implementations

impl MarginSideEffect

pub fn as_binance_str(self) -> &'static str

The Binance sideEffectType wire string for this policy.

Trait Implementations

impl Clone for MarginSideEffect

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MarginSideEffect

impl Debug for MarginSideEffect

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

Formats the value using the given formatter.

impl Default for MarginSideEffect

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MarginSideEffect

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MarginSideEffect

impl Hash for MarginSideEffect

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MarginSideEffect

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for MarginSideEffect

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for MarginSideEffect

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MarginSideEffect

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MarginSideEffect