Struct MarginDebtUpdate 

#[non_exhaustive]
pub struct MarginDebtUpdate<AssetKey, InstrumentKey> {
    pub asset: AssetKey,
    pub instrument: Option<InstrumentKey>,
    pub debt: MarginDetails,
    pub kind: MarginDebtKind,
    pub venue_kind: SmolStr,
    pub time_exchange: DateTime<Utc>,
}

What a margin account owes in one asset after a change, as the venue reported it.

Sent as AccountEventKind::MarginDebt.

Totals, not deltas

debt is everything owed in asset once the change is applied: the whole principal and the whole unpaid interest, not the amount the change borrowed, repaid or charged. Applying an update therefore replaces the debt the consumer held, and applying the same update twice changes nothing. A debt repaid in full is reported as zero, not left out.

Ordering

A venue may send these on a channel of their own, unordered against the account’s fills and balance updates. Order them by time_exchange, not by arrival, and against debt alone: a newer free/locked balance update says nothing about debt. An update can be missed while a stream is disconnected; a REST account snapshot restates the debt, as does a stream that restates its balances after reconnecting by itself (Binance’s do).

Producers

Known producers, as of writing:

• Binance margin (BinanceMargin): liabilityChange, one update per asset it lists. See the client’s rustdoc for how its type maps to a MarginDebtKind, and why an isolated pair’s debt is not known to be streamed.
• The simulated venue (SimulatedVenue) on a spot-margin account, after each borrow, repay and interest charge.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

asset: AssetKey

The asset owed.

instrument: Option<InstrumentKey>

The isolated margin pair the debt belongs to, or None for a debt of the account as a whole, as on a cross margin account.

The engine applies only an update with no instrument to its asset balances: an isolated pair’s balances are per pair, and the engine stores none of them (see InstrumentBalanceUpdate).

debt: MarginDetails

The principal and interest owed in asset after the change, both totals.

kind: MarginDebtKind

What changed the debt, independent of venue.

venue_kind: SmolStr

The venue’s own name for the change, verbatim, such as Binance’s BORROW.

time_exchange: DateTime<Utc>

When the venue made the change.

Implementations

impl<AssetKey, InstrumentKey> MarginDebtUpdate<AssetKey, InstrumentKey>

pub const fn new( asset: AssetKey, instrument: Option<InstrumentKey>, debt: MarginDetails, kind: MarginDebtKind, venue_kind: SmolStr, time_exchange: DateTime<Utc>, ) -> MarginDebtUpdate<AssetKey, InstrumentKey>

Trait Implementations

impl<AssetKey: Clone, InstrumentKey: Clone> Clone for MarginDebtUpdate<AssetKey, InstrumentKey>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<AssetKey: Debug, InstrumentKey: Debug> Debug for MarginDebtUpdate<AssetKey, InstrumentKey>

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

Formats the value using the given formatter.

impl<'de, AssetKey, InstrumentKey> Deserialize<'de> for MarginDebtUpdate<AssetKey, InstrumentKey>

where AssetKey: Deserialize<'de>, InstrumentKey: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<AssetKey: Eq, InstrumentKey: Eq> Eq for MarginDebtUpdate<AssetKey, InstrumentKey>

impl<ExchangeKey, AssetKey, InstrumentKey> From<MarginDebtUpdate<AssetKey, InstrumentKey>> for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

fn from(value: MarginDebtUpdate<AssetKey, InstrumentKey>) -> Self

Converts to this type from the input type.

impl<AssetKey: Hash, InstrumentKey: Hash> Hash for MarginDebtUpdate<AssetKey, InstrumentKey>

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<AssetKey: PartialEq, InstrumentKey: PartialEq> PartialEq for MarginDebtUpdate<AssetKey, InstrumentKey>

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

Equality operator ==.

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

Inequality operator !=.

impl<AssetKey, InstrumentKey> Serialize for MarginDebtUpdate<AssetKey, InstrumentKey>

where AssetKey: Serialize, InstrumentKey: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<AssetKey: PartialEq, InstrumentKey: PartialEq> StructuralPartialEq for MarginDebtUpdate<AssetKey, InstrumentKey>