Struct Subscription

pub struct Subscription {
    pub symbols: Symbols,
    pub schema: Schema,
    pub stype_in: SType,
    pub start: Option<OffsetDateTime>,
    pub id: Option<u32>,
    /* private fields */
}

Available on crate feature live only.

A subscription for real-time or intraday historical data.

Fields

symbols: Symbols

The symbols of the instruments to subscribe to.

schema: Schema

The data record schema of data to subscribe to.

stype_in: SType

The symbology type of the symbols in symbols.

start: Option<OffsetDateTime>

If specified, requests available data since that time (inclusive), based on ts_event. When None, only real-time data is sent.

Setting this field is not supported once the session has been started with LiveClient::start.

id: Option<u32>

The optional numerical identifier associated with this subscription.

Implementations

impl Subscription

pub fn builder() -> SubscriptionBuilder<((), (), (), (), (), ())>

Create a builder for building Subscription. On the builder, call .symbols(...), .schema(...), .stype_in(...)(optional), .start(...)(optional), .use_snapshot(...)(optional), .id(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Subscription.

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a duplicate of the value.

const 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 PartialEq for Subscription

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

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

const 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 Eq for Subscription

impl StructuralPartialEq for Subscription