Struct MarketSubscription 

pub struct MarketSubscription(/* private fields */);

A subscription valid on the markets endpoint.

Implementations

impl MarketSubscription

pub fn market_data<I, S>(market_slugs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Full order-book depth for one or more markets.

pub fn market_data_lite<I, S>(market_slugs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Best-bid/offer for one or more markets.

pub fn trades<I, S>(market_slugs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Trade executions for one or more markets.

pub fn custom(subscription_type: impl Into<String>) -> Self

A markets subscription type this SDK does not model yet. The string is sent verbatim, so pass it in wire form (SUBSCRIPTION_TYPE_...).

A string that names a type the SDK does know is resolved to that variant, so endpoint validation still applies and this cannot be used to smuggle a private subscription onto the markets socket.

impl MarketSubscription

pub fn request_id(&self) -> &str

The requestId sent with this subscription. Pass it to unsubscribe to cancel.

pub fn subscription_type(&self) -> &SubscriptionType

pub fn market_slugs(&self) -> &[String]

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Override the generated requestId.

pub fn with_market_slugs<I, S>(self, slugs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replace the market slugs this subscription covers.

pub fn add_market_slug(self, slug: impl Into<String>) -> Self

Add one more market slug.

pub fn insert_extra( self, key: impl Into<String>, value: impl Into<Value>, ) -> Self

Add an arbitrary field to the subscribe object.

Reach for this only when the server documents the field: the endpoint rejects a frame it cannot parse, and an unknown field may be enough to make it unparseable.

pub fn frame(&self) -> Value

The exact JSON frame this subscription puts on the socket. Useful when debugging a rejected subscription.

Trait Implementations

impl Clone for MarketSubscription

fn clone(&self) -> MarketSubscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarketSubscription

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

Formats the value using the given formatter.