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
impl DepthStream
Sourcepub fn symbols(&self) -> impl Iterator<Item = SymbolId> + '_
pub fn symbols(&self) -> impl Iterator<Item = SymbolId> + '_
Returns the symbols the stream delivers the depth of, in ascending order.
Sourcepub fn book(&self, symbol: SymbolId) -> Option<&DepthBook>
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.
Sourcepub const fn is_stale(&self) -> bool
pub const fn is_stale(&self) -> bool
Tells whether the books are withheld because changes were lost; see
DepthStream::resync.
Sourcepub async fn resync(&mut self) -> Result<(), ConnectorError>
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.
Sourcepub async fn next(&mut self) -> Result<DepthUpdate, ConnectorError>
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.
Sourcepub async fn unsubscribe(self) -> Result<(), ConnectorError>
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.