Struct HistoryPage 

#[non_exhaustive]
pub struct HistoryPage {
    pub bars: Vec<Bar>,
    pub end_of_history: bool,
    pub continue_before: Option<DateTime<Utc>>,
}

One page of history. A page without bars ends scroll-back like end_of_history does, unless it names where older bars continue with continue_before, so a feed that pages by time window can answer an empty window such as a weekend.

Trades streamed through Sink::push_tick extend the page’s newest bar even when they arrive first. That bar must count only trades the stream did not send, or the feed must hold those trades until the page is answered. Completed page bars replace bars built from ticks.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bars: Vec<Bar>

Any order, each stamped with its open or any instant inside it: a bar stamped with its close time lands in the next bar. A bar of a day or longer covers a calendar period of HistoryRequest::clock, such as a day, a week from Monday or a calendar month, in UTC by default: stamp it inside that period, for example at its local midnight. A session open on the evening before can fall in the period of the bar before, and one of the two bars is then dropped. The chart sorts, deduplicates and validates them.

end_of_history: bool

Nothing exists before the oldest returned bar (or before request.before when bars is empty).

continue_before: Option<DateTime<Utc>>

On a page without bars: the window had none but older bars exist, and the chart asks again for the bars before this instant. It must be earlier than request.before, or the chart stops paging and reports FeedError::InvalidData instead of repeating the request. Ignored on a page with bars, which continues before its oldest bar.

Implementations

impl HistoryPage

pub fn new(bars: Vec<Bar>, end_of_history: bool) -> Self

A page of bars, the last one when end_of_history.

pub fn with_continue_before(self, before: DateTime<Utc>) -> Self

Sets continue_before.

Trait Implementations

impl Clone for HistoryPage

fn clone(&self) -> HistoryPage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HistoryPage

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

Formats the value using the given formatter.

impl Default for HistoryPage

fn default() -> HistoryPage

Returns the “default value” for a type.

impl PartialEq for HistoryPage

fn eq(&self, other: &HistoryPage) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for HistoryPage