Skip to main content

TrendbarStream

Struct TrendbarStream 

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

The forming bar of one symbol and period, sent anew whenever a price changes it.

The subscription behind the stream is restored after a reconnection. The last bid the stream has seen is forgotten the moment the loss of the connection is reported, so a bar from after the loss never closes at a bid from before it.

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 TrendbarStream::next with ConnectorError::Lagged and the last bid is forgotten, so no bar closes at a bid older than the loss. The stream stays usable.

Implementations§

Source§

impl TrendbarStream

Source

pub const fn account(&self) -> AccountId

Returns the account the bars belong to.

Source

pub const fn symbol(&self) -> SymbolId

Returns the symbol the bars belong to.

Source

pub const fn period(&self) -> Period

Returns the length of time one bar covers.

Source

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

Waits for the next state of the forming bar.

The server leaves the last price out of a live bar; it is taken from the bid that arrives with the bar or, failing that, from the last bid the stream has seen. A bar that arrives before any bid is passed over.

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

Source

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

Ends the subscription to the live bars; the spot subscription of the symbol stays.

§Errors

Fails like OpenApiClient::unsubscribe_live_trendbars.

Trait Implementations§

Source§

impl Debug for TrendbarStream

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