Skip to main content

DepthStream

Struct DepthStream 

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

Stream of the depth of the market of one symbol.

Implementations§

Source§

impl DepthStream

Source

pub const fn symbol(&self) -> SymbolId

Returns the symbol the stream reports.

Source

pub const fn book(&self) -> &Book

Returns the book as of the last change.

Source

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

Waits for the next change and returns the book after it.

The wait has no deadline of its own: a market may stand still. The session notices a server that has gone silent and ends the wait with an error.

§Errors

Returns ConnectorError::Transport when the connection is lost, after which the stream goes on from an empty book once the session is logged on again, or when the session ends, ConnectorError::Closed when it has ended before, ConnectorError::Lagged when the reader fell behind, and ConnectorError::Fix when the server refuses the subscription. After changes were skipped the book is no longer that of the server; the subscription has to be opened anew.

Source

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

Ends the subscription.

§Errors

Returns ConnectorError::Transport when the request cannot be written and ConnectorError::Closed when the session has ended already.

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