Enum AccountEventKind 

#[non_exhaustive]
pub enum AccountEventKind<ExchangeKey, AssetKey, InstrumentKey> {
    Snapshot(AccountSnapshot<ExchangeKey, AssetKey, InstrumentKey>),
    BalanceSnapshot(Snapshot<AssetBalance<AssetKey>>),
    BalanceStreamUpdate(Snapshot<AssetBalanceUpdate<AssetKey>>),
    InstrumentBalanceUpdate(InstrumentBalanceUpdate<AssetKey, InstrumentKey>),
    InstrumentBalanceSnapshot(InstrumentBalanceSnapshot<AssetKey, InstrumentKey>),
    OrderSnapshot(Snapshot<Order<ExchangeKey, InstrumentKey, OrderState<AssetKey, InstrumentKey>>>),
    OrderCancelled(OrderResponseCancel<ExchangeKey, AssetKey, InstrumentKey>),
    Trade(Trade<AssetKey, InstrumentKey>),
    StreamTerminated(StreamTerminationReason),
    FillRecoveryGaveUp(FillRecoveryGap<InstrumentKey>),
    TradeAmended(TradeAmendment<AssetKey, InstrumentKey>),
    ReinitFailed(AccountReinitFailure<AssetKey, InstrumentKey>),
    CashFlow(CashFlow<AssetKey, InstrumentKey>),
    Notice(AccountNotice<InstrumentKey>),
    MarginDebt(MarginDebtUpdate<AssetKey, InstrumentKey>),
}

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.

Snapshot(AccountSnapshot<ExchangeKey, AssetKey, InstrumentKey>)

Full AccountSnapshot - replaces all existing state.

BalanceSnapshot(Snapshot<AssetBalance<AssetKey>>)

Single AssetBalance snapshot - replaces existing balance state.

Sourced from a REST account snapshot: carries the full balance including any per-asset margin debt (borrowed/interest). This is the authoritative source for debt totals.

BalanceStreamUpdate(Snapshot<AssetBalanceUpdate<AssetKey>>)

Single AssetBalanceUpdate - applies a WS partial (free/locked only).

Sourced from an exchange WS user-data stream (e.g. Binance outboundAccountPosition). It carries no margin debt, so applying it updates free/locked while preserving any existing MarginDetails — debt cannot be silently clobbered by a stream update. Debt totals remain as fresh as the last BalanceSnapshot or MarginDebt.

InstrumentBalanceUpdate(InstrumentBalanceUpdate<AssetKey, InstrumentKey>)

Live per-instrument isolated-margin balance update (free/locked of one asset of a pair).

The stream counterpart of InstrumentAccountSnapshot::isolated for venues with per-pair isolated sub-accounts (e.g. Binance isolated margin). Carries a point-in-time free/locked snapshot of one of the pair’s assets — NOT a delta — keyed by instrument as well as asset, because isolated balances are per-(pair, asset) and cannot be folded into the asset-keyed balance state without collision (see InstrumentBalanceUpdate).

The engine deliberately does not store this (the per-asset balance state is informational only and the engine never reads it for sizing/gating); a consumer reads it off the account event feed. A pair’s debt arrives apart, as a MarginDebt naming the pair, from a venue that streams it.

InstrumentBalanceSnapshot(InstrumentBalanceSnapshot<AssetKey, InstrumentKey>)

One asset’s full balance in a pair’s isolated sub-account, debt included, read over REST.

The per-instrument counterpart of BalanceSnapshot, and the event form of one side of InstrumentAccountSnapshot::isolated: an account stream that reconnects by itself reads its isolated pairs’ balances and emits one of these for each pair’s base and quote, so a change it missed while disconnected is restated. Like InstrumentBalanceUpdate, the engine does not store it.

OrderSnapshot(Snapshot<Order<ExchangeKey, InstrumentKey, OrderState<AssetKey, InstrumentKey>>>)

Single Order snapshot - used to upsert existing order state if it’s more recent.

This variant covers general order updates, and open order responses.

OrderCancelled(OrderResponseCancel<ExchangeKey, AssetKey, InstrumentKey>)

Response to an OrderRequestCancel<ExchangeKey, InstrumentKey>.

Trade(Trade<AssetKey, InstrumentKey>)

Order<ExchangeKey, InstrumentKey, Open> partial or full-fill.

The fee asset (AssetKey) may be the quote asset, base asset, or a third-party asset (e.g., BNB on Binance). Use fees.fees_quote for quote-equivalent value when available.

StreamTerminated(StreamTerminationReason)

The account event stream has ended; no further events will arrive on it.

This is the in-band, programmatic signal that a stream died — delivered on the same account feed as every other event rather than being inferred from channel EOF or read from logs. The StreamTerminationReason distinguishes a venue that exhausted its reconnect budget from an unrecoverable error, so the consumer can apply its own recovery policy (re-establish the stream, re-sync via REST, halt trading). The library reports that and why the stream ended; it does not prescribe the response.

Only terminations deliverable while the consumer is still listening are signalled: a consumer-initiated drop closes the receiver, so there is no one left to deliver to (see StreamTerminationReason for the deliverable-only rationale).

FillRecoveryGaveUp(FillRecoveryGap<InstrumentKey>)

Fill recovery gave up on a span of fills: fills in it may not have been delivered.

Sent by venues that recover missed fills after a reconnect (Binance Spot and Margin, Alpaca) when a recovery read fails for good, once per failed read. The stream carries on. The engine logs it and changes no state; reconciling is the consumer’s policy. See FillRecoveryGap for what the span covers and how to read it again.

TradeAmended(TradeAmendment<AssetKey, InstrumentKey>)

A trade delivered earlier was busted or corrected by the venue.

The earlier Trade is not withdrawn, so state built on it is wrong until the consumer applies this. The engine logs it and changes no state; reversing the trade is the consumer’s policy. See TradeAmendment.

ReinitFailed(AccountReinitFailure<AssetKey, InstrumentKey>)

An attempt to re-initialise the account stream after it ended failed. Attempts continue with backoff.

Sent by a consumer that re-initialises the account stream itself, such as the rustrade crate’s ExecutionManager, once per failed attempt and in order with the other account events. It reports that the account link is still down, so it is not evidence the link is up. The engine logs it and changes no state. How long to keep waiting, and whether to halt or alert, is the consumer’s policy. See AccountReinitFailure.

CashFlow(CashFlow<AssetKey, InstrumentKey>)

Cash moved into or out of the account other than by a trade: funding, interest, a borrow fee or a rebate, as the venue posted it.

A flow is a delta, signed positive when the account received it. The engine adds a flow attributed to an instrument to the carry of that instrument’s open position (see Position::carry in rustrade), and applies none to balances: the venue’s balances already include what it has posted. See CashFlow for which venues send it.

Notice(AccountNotice<InstrumentKey>)

The venue reported a change in the account’s margin or liquidation state: a margin call, a liquidation warning, a liquidation under way, or that one of those no longer holds.

A notice changes no balance or position. The engine logs it, at warn when NoticeKind::is_escalation and at info otherwise, and changes no state; what to do about it is the consumer’s policy. A notice sent while the stream was disconnected is not recovered. See AccountNotice for which venues send it.

MarginDebt(MarginDebtUpdate<AssetKey, InstrumentKey>)

What a margin account owes in one asset changed: a borrow, a repay or an interest charge.

Carries the principal and interest owed after the change, both totals, so applying one replaces the debt held and applying it twice changes nothing. The engine applies an update that names no instrument to the asset’s Balance::margin, ordered by its time against earlier debt alone, and leaves free/locked as they are. An update that names an isolated pair changes no engine state; a consumer reads it off the account event feed. See MarginDebtUpdate for which venues send it.

Trait Implementations

impl<ExchangeKey: Clone, AssetKey: Clone, InstrumentKey: Clone> Clone for AccountEventKind<ExchangeKey, 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<ExchangeKey: Debug, AssetKey: Debug, InstrumentKey: Debug> Debug for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

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

Formats the value using the given formatter.

impl<'de, ExchangeKey, AssetKey, InstrumentKey> Deserialize<'de> for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

where ExchangeKey: Deserialize<'de>, 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<ExchangeKey, AssetKey, InstrumentKey> From<AccountNotice<InstrumentKey>> for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

fn from(value: AccountNotice<InstrumentKey>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(value: FillRecoveryGap<InstrumentKey>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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<ExchangeKey, AssetKey, InstrumentKey> From<OrderEvent<Result<Cancelled, OrderError<AssetKey, InstrumentKey>>, ExchangeKey, InstrumentKey>> for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

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

Converts to this type from the input type.

impl<ExchangeKey, AssetKey, InstrumentKey> From<Snapshot<AssetBalance<AssetKey>>> for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

fn from(value: Snapshot<AssetBalance<AssetKey>>) -> Self

Converts to this type from the input type.

impl<ExchangeKey, AssetKey, InstrumentKey> From<Snapshot<AssetBalanceUpdate<AssetKey>>> for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

fn from(value: Snapshot<AssetBalanceUpdate<AssetKey>>) -> Self

Converts to this type from the input type.

impl<ExchangeKey, AssetKey, InstrumentKey> From<Snapshot<Order<ExchangeKey, InstrumentKey, OrderState<AssetKey, InstrumentKey>>>> for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

fn from( value: Snapshot<Order<ExchangeKey, InstrumentKey, OrderState<AssetKey, InstrumentKey>>>, ) -> Self

Converts to this type from the input type.

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

fn from(value: StreamTerminationReason) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<ExchangeKey: PartialEq, AssetKey: PartialEq, InstrumentKey: PartialEq> PartialEq for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

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

Equality operator ==.

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

Inequality operator !=.

impl<ExchangeKey, AssetKey, InstrumentKey> Serialize for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

where ExchangeKey: Serialize, 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<ExchangeKey: PartialEq, AssetKey: PartialEq, InstrumentKey: PartialEq> StructuralPartialEq for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>