Struct DepthHistory 

pub struct DepthHistory { /* private fields */ }

Columns of the order book of one chart, oldest first. Turn it on with Chart::set_depth_history and read it with Chart::depth_history.

use egui_charts::data::{DepthHistory, DepthHistoryConfig};

let config = DepthHistoryConfig { ticks_per_row: 4, ..Default::default() };
let history = DepthHistory::new(config).unwrap();
assert_eq!(history.columns().count(), 0);

Implementations

impl DepthHistory

pub fn new(config: DepthHistoryConfig) -> Result<Self, FeedError>

An empty history, or an error if config breaks one of its limits.

pub fn config(&self) -> &DepthHistoryConfig

The configuration the history samples with.

pub fn columns(&self) -> impl DoubleEndedIterator<Item = &DepthColumn>

Every column, oldest first. Consecutive columns are adjacent unless the chart lost columns.

pub fn merge_page(&mut self, page: Vec<DepthColumn>) -> Result<usize, FeedError>

Merges a historical page, preserving every held column on overlap and keeping time gaps. Older columns merge to the oldest tier’s resolution, and columns that fill a gap to the resolution of the tier they join; either completes a short held column right after it. Full columns merge only when their tier overflows. Columns must use this history’s grid and sorted, unique rows, with finite non-negative sizes and at most config.rows per side. Invalid pages leave the history unchanged. A side’s largest orders, if it has any, are one per row, finite and not negative. Memory remains bounded by the configured tiers. Returns the number of input columns retained, including those merged to a coarser resolution. Columns beyond the oldest tier’s capacity are dropped and do not count.

Trait Implementations

impl Clone for DepthHistory

fn clone(&self) -> DepthHistory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DepthHistory

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

Formats the value using the given formatter.