Enum SubscriptionChannel 

#[non_exhaustive]
pub enum SubscriptionChannel {
    OrderSnapshot,
    OrderUpdate,
    MarketData,
    MarketDataLite,
    PositionSnapshot,
    PositionUpdate,
    BalanceSnapshot,
    BalanceUpdate,
    Trade,
    Heartbeat,
}

All known WebSocket subscription channels.

Pass a variant to the typed constructors on StreamSubscription, or use SubscriptionChannel::as_str to get the wire-format channel name.

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.

OrderSnapshot

Initial snapshot of all open orders (private).

OrderUpdate

Real-time order lifecycle changes (private).

MarketData

Full order-book depth (public).

MarketDataLite

Best-bid/offer only (public).

PositionSnapshot

Initial snapshot of portfolio positions (private).

PositionUpdate

Real-time position changes (private).

BalanceSnapshot

Initial snapshot of account balances (private).

BalanceUpdate

Real-time balance changes (private).

Trade

Trade execution feed (public).

Heartbeat

Server heartbeat — useful as an aliveness check.

Implementations

impl SubscriptionChannel

pub fn as_str(self) -> &'static str

Returns the snake_case wire-format channel name.

Trait Implementations

impl Clone for SubscriptionChannel

fn clone(&self) -> SubscriptionChannel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SubscriptionChannel

impl Debug for SubscriptionChannel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SubscriptionChannel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SubscriptionChannel

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

Formats the value using the given formatter.

impl Eq for SubscriptionChannel

impl Hash for SubscriptionChannel

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 PartialEq for SubscriptionChannel

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SubscriptionChannel

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 SubscriptionChannel