Struct Subscription

pub struct Subscription {
    pub depth: Option<i64>,
    pub interval: Option<i64>,
    pub name: Option<SubscriptionName>,
    pub rate_counter: Option<bool>,
    pub snapshot: Option<bool>,
    pub token: Option<Token>,
    pub consolidate_taker: Option<bool>,
}

General struct for subscribing to any channel.

Not all fields apply to each subscription, see the individual new_* methods for constructing well-formed subscriptions for each channel.

Fields

depth: Option<i64>

interval: Option<i64>

name: Option<SubscriptionName>

rate_counter: Option<bool>

snapshot: Option<bool>

token: Option<Token>

consolidate_taker: Option<bool>

Implementations

impl Subscription

pub fn new_book_subscription(depth: Option<i64>) -> Subscription

Create a new subscription to the orderbook at a given depth.

pub fn new_ohlc_subscription(interval: Option<i64>) -> Subscription

Create a new subscription to the OHLC channel at the given interval.

pub fn new_own_trades_subscription( token: Token, snapshot: Option<bool>, ) -> Subscription

Create a new subscription to the OwnTrades channel for a specific token.

Optionally receive a snapshot of recent orders.

pub fn new_trades_subscription() -> Subscription

Create a new subscription to the public trades channel.

pub fn new_ticker_subscription() -> Subscription

Create a new subscription to the Ticker channel.

pub fn new_spread_subscription() -> Subscription

Create a new subscription to the Spread channel for best bids/asks.

pub fn new_open_orders_subscription( token: Token, rate_counter: Option<bool>, ) -> Subscription

Create a new subscription to all open orders for the user.

Optionally get rate limiter updates from the server.

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Subscription

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Subscription> for Unsubscription

Using a given Subscription message, generate the corresponding Unsubscription message.

fn from(value: Subscription) -> Self

Converts to this type from the input type.

impl Serialize for Subscription

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.