Skip to main content

MarketDataMessage

Enum MarketDataMessage 

Source
pub enum MarketDataMessage {
    QuotesSuccess(SubscribeSuccessPayload),
    Quotes(QuotesData),
    OrderBookSuccess(SubscribeSuccessPayload),
    OrderBook(OrderBookData),
    LastTradesSuccess(SubscribeSuccessPayload),
    LastTrades(LastTradesData),
    LastCandleSuccess(SubscribeSuccessPayload),
    LastCandle(LastCandleData),
    ErrorResponse(MarketDataError),
    Undefined,
}
Expand description

A frame of the market data channel, told apart by its responseType.

The success variants confirm a subscription. The data variants carry the data. A value of responseType this library does not know reads as MarketDataMessage::Undefined.

Error frames of the documented shape do not arrive as ErrorResponse. The docs show an error as a frame with the responseType of the data (for example OrderBook) and an errors list. Such a frame does not fit the data type, so the parser returns it as IncomingMessage::Unknown with the raw text. The ErrorResponse variant is for a frame that really has responseType = "ErrorResponse".

§Examples

use brokapi_bcs_protocol::ws::models::MarketDataMessage;

let frame = r#"{"responseType":"LastTrades","ticker":"SBER","classCode":"TQBR","side":"BUY","price":300.15,"quantity":100}"#;
match serde_json::from_str::<MarketDataMessage>(frame)? {
    MarketDataMessage::LastTrades(t) => assert_eq!(t.quantity, dec!(100.0)),
    other => panic!("unexpected: {other:?}"),
}

Variants§

§

QuotesSuccess(SubscribeSuccessPayload)

The subscription to quotes was accepted.

§

Quotes(QuotesData)

A quote update.

§

OrderBookSuccess(SubscribeSuccessPayload)

The subscription to the order book was accepted.

§

OrderBook(OrderBookData)

An order book update.

§

LastTradesSuccess(SubscribeSuccessPayload)

The subscription to the trades tape was accepted.

§

LastTrades(LastTradesData)

One trade of the tape.

§

LastCandleSuccess(SubscribeSuccessPayload)

The subscription to the last candle was accepted (responseType is CandleStickSuccess).

§

LastCandle(LastCandleData)

An update of the last candle (responseType is CandleStick).

§

ErrorResponse(MarketDataError)

An error frame with responseType = "ErrorResponse". See the note on the type.

§

Undefined

A responseType this library does not know.

Trait Implementations§

Source§

impl Clone for MarketDataMessage

Source§

fn clone(&self) -> MarketDataMessage

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MarketDataMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MarketDataMessage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more