Enum DeriveWsChannel 

pub enum DeriveWsChannel {
    TickerSlim {
        instrument_name: Ustr,
        interval: DeriveTickerInterval,
    },
    Orderbook {
        instrument_name: Ustr,
        group: DeriveOrderbookGroup,
        depth: DeriveOrderbookDepth,
    },
    Trades {
        instrument_type: DeriveInstrumentType,
        currency: Ustr,
    },
    Orders {
        subaccount_id: u64,
    },
    PrivateTrades {
        subaccount_id: u64,
    },
    Balances {
        subaccount_id: u64,
    },
    Raw(String),
}

Derive WebSocket subscription channel topic.

Variants

TickerSlim

Public compact ticker channel.

Fields

instrument_name: Ustr

Venue instrument name.

interval: DeriveTickerInterval

Update interval in milliseconds.

Orderbook

Public order book channel.

Fields

instrument_name: Ustr

Venue instrument name.

group: DeriveOrderbookGroup

Venue grouping increment.

depth: DeriveOrderbookDepth

Requested depth.

Trades

Public trades channel.

Fields

instrument_type: DeriveInstrumentType

Venue instrument type.

currency: Ustr

Venue currency.

Orders

Private order updates channel.

Fields

subaccount_id: u64

Subaccount id.

PrivateTrades

Private trade updates channel.

Fields

subaccount_id: u64

Subaccount id.

Balances

Private balance updates channel.

Fields

subaccount_id: u64

Subaccount id.

Raw(String)

Passthrough topic for venue channels not yet modeled by the adapter.

Implementations

impl DeriveWsChannel

pub fn ticker_slim( instrument_name: impl AsRef<str>, interval: impl AsRef<str>, ) -> Self

Returns a compact ticker channel.

pub fn orderbook( instrument_name: impl AsRef<str>, group: impl AsRef<str>, depth: impl AsRef<str>, ) -> Self

Returns an order book channel.

pub fn trades( instrument_type: impl AsRef<str>, currency: impl AsRef<str>, ) -> Self

Returns a public trades channel.

pub const fn orders(subaccount_id: u64) -> Self

Returns a private orders channel.

pub const fn private_trades(subaccount_id: u64) -> Self

Returns a private trades channel.

pub const fn balances(subaccount_id: u64) -> Self

Returns a private balances channel.

pub fn from_topic(topic: impl Into<String>) -> Self

Parses a topic string into the known channel family when possible.

Trait Implementations

impl Clone for DeriveWsChannel

fn clone(&self) -> DeriveWsChannel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeriveWsChannel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeriveWsChannel

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DeriveWsChannel

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

Formats the value using the given formatter.

impl Eq for DeriveWsChannel

impl From<&str> for DeriveWsChannel

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for DeriveWsChannel

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for DeriveWsChannel

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 DeriveWsChannel

fn eq(&self, other: &DeriveWsChannel) -> 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 DeriveWsChannel

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 DeriveWsChannel