Skip to main content

DepthStream

Struct DepthStream 

Source
pub struct DepthStream { /* private fields */ }
Expand description

Changes of the market depth of the symbols of one account, with the books they build.

The subscription behind the stream is restored after a reconnection. The books are emptied the moment the loss of the connection is reported, which is before anything the server sends for the restored subscription, so the whole depth the server then sends anew builds them afresh.

A stream that is read too slowly loses events: the connection holds a limited number of them, set with ConnectionOptions::event_capacity. A book that missed a change is wrong and cannot be repaired from later changes, so the loss is reported once by DepthStream::next with ConnectorError::Lagged and the books are dropped. From then on DepthStream::book returns nothing and the changes the stream goes on to deliver are not applied, until the server sends the whole depth anew: after DepthStream::resync, or after a reconnection the stream has read from its start.

Implementations§

Source§

impl DepthStream

Source

pub const fn account(&self) -> AccountId

Returns the account the depth belongs to.

Source

pub fn symbols(&self) -> impl Iterator<Item = SymbolId> + '_

Returns the symbols the stream delivers the depth of, in ascending order.

Source

pub fn book(&self, symbol: SymbolId) -> Option<&DepthBook>

Returns the book of the symbol as of the last change the stream delivered.

Returns nothing before the first change of the symbol, and for every symbol from the moment DepthStream::next reports ConnectorError::Lagged until the whole depth has been sent anew.

Source

pub const fn is_stale(&self) -> bool

Tells whether the books are withheld because changes were lost; see DepthStream::resync.

Source

pub async fn resync(&mut self) -> Result<(), ConnectorError>

Subscribes to the depth of the symbols of the stream anew, so that the server sends the whole depth again and the books are valid from the first change delivered afterwards.

The subscription is ended and requested again, and the changes that were waiting to be read are discarded. Meant to be called after DepthStream::next has reported ConnectorError::Lagged.

§Errors

Fails like OpenApiClient::unsubscribe_depth and OpenApiClient::subscribe_depth; the books stay withheld then.

Source

pub async fn next(&mut self) -> Result<DepthUpdate, ConnectorError>

Waits for the next change of the depth of one of the symbols and applies it to the book of its symbol.

§Errors

Returns ConnectorError::Closed when the connection is shut down, ConnectorError::SessionEnded when the server ended the authorisation of the account, ConnectorError::Lagged when changes were dropped because the stream was read too slowly, and ConnectorError::Value when the server sends a value out of range.

Source

pub async fn unsubscribe(self) -> Result<(), ConnectorError>

Ends the subscription to the depth of the symbols of the stream.

§Errors

Fails like OpenApiClient::unsubscribe_depth.

Trait Implementations§

Source§

impl Debug for DepthStream

Source§

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

Formats the value using the given formatter. 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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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