Struct AccountNotice 

#[non_exhaustive]
pub struct AccountNotice<InstrumentKey> {
    pub kind: NoticeKind,
    pub instrument: Option<InstrumentKey>,
    pub time_exchange: DateTime<Utc>,
    pub margin_level: Option<Decimal>,
    pub status: SmolStr,
}

A notice from the venue about the account’s margin or liquidation state.

Sent as AccountEventKind::Notice. A notice reports a change of state, not a delta: it changes no balance or position, and the engine only logs it.

A notice can be missed: one sent while the stream is disconnected is not recovered when it reconnects. A consumer that acts on a NoticeKind::MarginCall and waits for a NoticeKind::MarginRestored should re-check the venue’s state after a reconnect, rather than wait for a notice that may already have gone by.

Producers

Known producers, as of writing:

• Binance margin (BinanceMargin): marginLevelChange. See the client’s rustdoc for how its status maps to a NoticeKind, and which instrument an isolated pair’s notice names.
• The simulated venue (SimulatedVenue), when its spot margin account is configured with a SpotMarginLiquidation: a liquidation, and an optional margin call and its restoration, for the account as a whole.

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.

kind: NoticeKind

What the notice says, independent of venue.

instrument: Option<InstrumentKey>

The instrument the notice is about, when the venue scopes it to one, as it does an isolated margin pair. None for a notice about the account as a whole, and for one the producer could not attribute; each producer says which it sends.

time_exchange: DateTime<Utc>

When the venue sent the notice.

margin_level: Option<Decimal>

The venue’s margin level when it sent the notice, when it reports one.

It is the venue’s own figure under the venue’s own definition, so it is not comparable across venues. Each producer says what it is. None when the venue sent none, or sent one that could not be read.

status: SmolStr

The venue’s own name for the status, verbatim, such as Binance’s PRE_LIQUIDATION.

Implementations

impl<InstrumentKey> AccountNotice<InstrumentKey>

pub const fn new( kind: NoticeKind, instrument: Option<InstrumentKey>, time_exchange: DateTime<Utc>, margin_level: Option<Decimal>, status: SmolStr, ) -> AccountNotice<InstrumentKey>

Trait Implementations

impl<InstrumentKey: Clone> Clone for AccountNotice<InstrumentKey>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<InstrumentKey: Debug> Debug for AccountNotice<InstrumentKey>

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

Formats the value using the given formatter.

impl<'de, InstrumentKey> Deserialize<'de> for AccountNotice<InstrumentKey>

where 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<InstrumentKey: Eq> Eq for AccountNotice<InstrumentKey>

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<InstrumentKey: Hash> Hash for AccountNotice<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<InstrumentKey: PartialEq> PartialEq for AccountNotice<InstrumentKey>

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

Equality operator ==.

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

Inequality operator !=.

impl<InstrumentKey> Serialize for AccountNotice<InstrumentKey>

where 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<InstrumentKey: PartialEq> StructuralPartialEq for AccountNotice<InstrumentKey>