Trait RingBufferTrait 

pub trait RingBufferTrait {
    type Value;
    type Container: IntoIterator;
    type Iter<'a>: Iterator<Item = &'a Step<Self::Value>>
       where Self: 'a;
    type IterMut<'a>: Iterator<Item = &'a mut Step<Self::Value>>
       where Self: 'a;

    // Required methods
    fn new() -> Self;
    fn is_empty(&self) -> bool;
    fn len(&self) -> usize;
    fn get_back(&self) -> Option<&Step<Self::Value>>;
    fn get_front(&self) -> Option<&Step<Self::Value>>;
    fn pop_front(&mut self) -> Option<Step<Self::Value>>;
    fn pop_back(&mut self) -> Option<Step<Self::Value>>;
    fn add_step(&mut self, step: Step<Self::Value>);
    fn update_step(&mut self, step: Step<Self::Value>) -> bool;
    fn prune(&mut self, max_age: Duration);
    fn iter<'a>(&'a self) -> Self::Iter<'a>;
}

Common interface for timestamped ring buffers.

Implementors are expected to maintain steps in ascending timestamp order.

Required Associated Types

type Value

The value type stored in each Step.

type Container: IntoIterator

The backing container type that stores steps.

type Iter<'a>: Iterator<Item = &'a Step<Self::Value>> where Self: 'a

Immutable iterator over stored steps.

type IterMut<'a>: Iterator<Item = &'a mut Step<Self::Value>> where Self: 'a

Mutable iterator over stored steps.

Required Methods

fn new() -> Self

Creates an empty buffer.

fn is_empty(&self) -> bool

Returns true when the buffer contains no steps.

fn len(&self) -> usize

Returns the number of stored steps.

fn get_back(&self) -> Option<&Step<Self::Value>>

Returns the newest step, if any.

fn get_front(&self) -> Option<&Step<Self::Value>>

Returns the oldest step, if any.

fn pop_front(&mut self) -> Option<Step<Self::Value>>

Removes and returns the oldest step.

fn pop_back(&mut self) -> Option<Step<Self::Value>>

Removes and returns the newest step.

fn add_step(&mut self, step: Step<Self::Value>)

Appends a step to the buffer.

fn update_step(&mut self, step: Step<Self::Value>) -> bool

Replaces a step with matching timestamp.

Returns true if a step was updated, false if no matching timestamp was found.

fn prune(&mut self, max_age: Duration)

Prune steps older than max_age from the buffer.

fn iter<'a>(&'a self) -> Self::Iter<'a>

Returns an iterator over all steps from oldest to newest.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<T> RingBufferTrait for RingBuffer<T>

where T: Copy,

type Value = T

type Container = VecDeque<Step<T>>

type Iter<'a> = Iter<'a, Step<T>> where Self: 'a

type IterMut<'a> = IterMut<'a, Step<T>> where Self: 'a