Struct SeriesBuffer 

pub struct SeriesBuffer<T> { /* private fields */ }

A capped window of past values, newest first.

Implementations

impl<T> SeriesBuffer<T>

pub fn push(&mut self, value: T, capacity: usize)

Record this bar’s value, retaining at most capacity of them.

pub fn get(&self, offset: usize) -> Option<&T>

The value offset bars back, or None if the buffer has not seen that many bars yet. offset 0 is the current bar.

pub fn len(&self) -> usize

How many bars are retained.

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> impl Iterator<Item = &T>

The retained values, newest first.

impl SeriesBuffer<f64>

pub fn window(&self, n: usize) -> Vec<f64>

The newest n values, newest first. Shorter than n while warming up.

pub fn observe(&mut self, value: f64, length: usize) -> Option<Vec<f64>>

Record this bar’s value and return the length values to compute over, newest first — or None while fewer than length bars have been seen.

Pine yields na until a series has enough history to answer, so warming up is the buffer’s business rather than each builtin’s.

Trait Implementations

impl<T: Clone> Clone for SeriesBuffer<T>

fn clone(&self) -> SeriesBuffer<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SeriesBuffer<T>

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

Formats the value using the given formatter.

impl<T> Default for SeriesBuffer<T>

fn default() -> Self

Returns the “default value” for a type.