Skip to main content

MarginStream

Struct MarginStream 

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

Margin events of one account, in the order the server sent them.

The stream starts with the first event that arrives after it was created and goes on across reconnections; events the server sent while the connection was down are not sent again.

A stream that is read too slowly loses events: the connection holds a limited number of them, set with ConnectionOptions::event_capacity. The loss is reported once by MarginStream::next with ConnectorError::Lagged and the stream then goes on with the oldest event still held.

Implementations§

Source§

impl MarginStream

Source

pub const fn account(&self) -> AccountId

Returns the account the events belong to.

Source

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

Waits for the next margin event of the account.

§Errors

Returns ConnectorError::Closed when the connection is shut down, ConnectorError::SessionEnded when the server ended the authorisation of the account, ConnectorError::Lagged when events were dropped because the stream was read too slowly, and ConnectorError::Value when the server sends a value out of range; the stream can be read on after the last two.

Trait Implementations§

Source§

impl Debug for MarginStream

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