Enum MarginEffect 

#[non_exhaustive]
pub enum MarginEffect {
    NoSideEffect,
    Borrow,
    Repay,
}

What an order does to a margin account’s loans: borrow what it lacks, repay from what it receives, or touch neither.

A margin client has one as its default and a request may carry its own (RequestOpen::margin_effect, where None takes the client’s default). The three values are the ones a margin venue takes per order (Binance’s NO_SIDE_EFFECT, MARGIN_BUY and AUTO_REPAY). Whether an order opens or closes a position decides which it should be, and that is position state the library deliberately does not track, so the caller says.

A client or simulated venue that cannot honour an effect refuses the order unsent with OrderError::UnsupportedMarginEffect, rather than place it without the effect.

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

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NoSideEffect

Neither borrow nor repay: an order that would need a loan is refused, and what it receives stays free, as Binance’s NO_SIDE_EFFECT does. The default, so that no order takes on debt unless the caller asks.

Borrow

Borrow what the order lacks, as Binance’s MARGIN_BUY does, in the asset it pays with (base for a sell, which opens or extends a short).

Binance lends the shortfall, or the asset’s minimum borrow if that is more: loan = max(shortfall, minimum borrow), where the minimum is the asset’s userMinBorrow in GET /sapi/v1/margin/allAssets. A sell’s shortfall is its quantity less the free base; a limit buy’s is its quantity times its limit price less the free quote. Nothing caps the loan at the order’s size, so a small order on an empty balance can borrow more than it pays, and what it does not pay stays free balance, owed.

The loan is taken when the order is placed, not when it fills, and nothing repays it from the order’s proceeds: close it with a Repay order. Whether a loan is repaid when the order is cancelled before it fills is the client’s auto_repay_at_cancel option.

Warning

A mis-sized order takes on debt: one larger than the free balance borrows the shortfall, or the asset’s minimum borrow, without any further opt-in, and interest accrues on it.

Repay

Repay the loan of the asset the order receives from what it receives, interest first, as Binance’s AUTO_REPAY does. It borrows nothing: an order the free balance cannot pay for is refused.

Trait Implementations

impl Clone for MarginEffect

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 MarginEffect

impl Debug for MarginEffect

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

Formats the value using the given formatter.

impl Default for MarginEffect

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MarginEffect

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MarginEffect

impl Hash for MarginEffect

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 MarginEffect

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 MarginEffect

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MarginEffect

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 MarginEffect

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 MarginEffect