Enum TradeOrigin 

#[non_exhaustive]
pub enum TradeOrigin {
    Order,
    Liquidation,
    Adl,
    Assignment,
    Exercise,
    Expiry,
    External,
}

Why a Trade happened, as far as its producer can tell.

Order is the default, not a guarantee

Order means the producer reported no other origin. Most venues mark some origins and not others, so a fill can be Order and still be forced, or still be for an order this client did not place. What each producer reports, as of writing:

Source	Reports
Interactive Brokers	Liquidation, External (opt-in), Order
Binance Spot / Margin	Order only
Hyperliquid	Order only
Alpaca	Order on fills; Expiry, Exercise, Assignment and External from AlpacaClient::fetch_option_events
SimulatedVenue	Liquidation (opt-in), Order
The rustrade engine’s expiry settlement	Expiry

• Interactive Brokers flags a fill of an IB-initiated liquidation. Another API client’s fill is reported, as External, only when IbkrConfig::other_clients_fills opts in.
• Binance marks no forced liquidation in its Spot or Margin order stream: its liquidation markers are documented for futures only. Every fill on the account arrives, whoever placed its order. BinanceMargin::fetch_forced_liquidations reads the margin orders Binance placed to liquidate the account, for a caller to match against its fills.
• Hyperliquid fills carry a liquidation marker, but the SDK this crate uses drops it.
• Alpaca marks no liquidation. Option assignment, exercise and expiry are account activities, which this crate does not read.
• The simulated venue reports the forced trades of a spot margin liquidation, which SpotMarginLiquidation opts into, with no client order id.

A forced variant takes precedence over External: a liquidation is reported as a liquidation whoever placed the order it closed.

Serialised form and ordering

Serialised as the variant’s name ("Liquidation"), as Side is, while Display writes it in lower case (liquidation). The names are a stored format: they are not renamed, and new variants are added after the existing ones. A trade with an origin a build does not know does not deserialise in that build.

Ord follows declaration order. It exists so Trade can derive Ord, and carries no meaning beyond that.

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.

Order

A fill of an order, with no other origin reported. See the type’s docs for why this is not a guarantee that this client placed the order.

Liquidation

The venue or broker closed the position because the account fell short of margin.

Adl

The venue reduced the position against a counterparty it was liquidating (auto-deleveraging).

Assignment

An option this account was short was assigned.

Exercise

An option this account held was exercised, by the holder or automatically.

Expiry

The instrument expired and the position was settled.

External

A fill of an order that another client, such as another API connection or the venue’s own trading screen, placed on the same account.

Implementations

impl TradeOrigin

pub fn is_forced(self) -> bool

Whether the position changed without the account placing an order for it: a Liquidation, an Adl or an Assignment.

An Exercise is the holder’s right, and an Expiry is the instrument’s end, so neither counts.

Trait Implementations

impl Clone for TradeOrigin

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 TradeOrigin

impl Debug for TradeOrigin

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

Formats the value using the given formatter.

impl Default for TradeOrigin

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TradeOrigin

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TradeOrigin

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

Formats the value using the given formatter.

impl Eq for TradeOrigin

impl Hash for TradeOrigin

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 TradeOrigin

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 TradeOrigin

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TradeOrigin

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 TradeOrigin

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 TradeOrigin