Struct HistoryBuffer

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

A “history buffer”, similar to a write-only ring buffer of fixed length.

This buffer keeps a fixed number of elements. On write, the oldest element is overwritten. Thus, the buffer is useful to keep a history of values with some desired depth.

Implementations

impl<T> HistoryBuffer<T>

pub fn new(max_size: usize) -> Self

Create a new buffer with a specified max depth.

pub fn is_empty(&self) -> bool

Checks if the buffer is empty.

pub fn is_full(&self) -> bool

Checks if the buffer is full, i.e. it has reached capacity.

pub fn max_len(&self) -> usize

The maximum number of elements the buffer can hold.

pub fn len(&self) -> usize

The number of elements currently in the buffer.

pub fn clear(&mut self)

Clear all values in the buffer.

pub fn most_recent(&self) -> Option<&T>

Get the most recent value written to the buffer.

pub fn write(&mut self, val: T) -> Option<T>

Write a new value into the buffer, if it overwrites an old value it is returned.

pub fn duration_since_last_measurement(&self) -> Option<Duration>

How long was it since the last measurement.

pub fn all_unsorted(&self) -> &[T]

Get the entire buffer as unsorted.

pub fn all(&self) -> impl DoubleEndedIterator<Item = &T>

Get the entire in chronological order, starting with the oldest element.

Trait Implementations

impl<T> Debug for HistoryBuffer<T>

where T: Debug,

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

Formats the value using the given formatter.