Struct circ_buffer::RingBuffer

pub struct RingBuffer<T, const N: usize>(/* private fields */);

A ring Buffer with constant size. Makes use of a fixed-size array internally.

let mut circ_buffer = RingBuffer::<i64, 4>::default();

// These entries will be made into free space in the buffer.
circ_buffer.push(1_i64);
circ_buffer.push(2_i64);
circ_buffer.push(3_i64);
circ_buffer.push(4_i64);

// Now it will start truncating initial entries.
circ_buffer.push(5_i64);
circ_buffer.push(6_i64);
circ_buffer.push(7_i64);

let mut elements = circ_buffer.iter();
assert_eq!(elements.next(), Some(&4));
assert_eq!(elements.next(), Some(&5));
assert_eq!(elements.next(), Some(&6));
assert_eq!(elements.next(), Some(&7));

Implementations

impl<T, const N: usize> RingBuffer<T, N>

pub fn new() -> Self

Creates a new empty RingBuffer

pub fn get_size(&self) -> usize

Gets the current size of the RingBuffer

impl<T, const N: usize> RingBuffer<T, N>

pub fn push(&mut self, new_item: T)

Append one element to the buffer.

This will not grow the buffer but instead replace existing entries when the maximum size is reached.

let mut circ_buffer = RingBuffer::<f64, 5>::default();
circ_buffer.push(1.0);
circ_buffer.push(2.0);
circ_buffer.push(3.0);
circ_buffer.push(4.0);
circ_buffer.push(5.0);
// Now we begin to drop the first entry when pushing more values.
circ_buffer.push(6.0);
let elements = circ_buffer.iter().collect::<Vec<_>>();
assert_eq!(elements, vec![&2.0, &3.0, &4.0, &5.0, &6.0])

pub fn iter<'a>(&'a self) -> RingBufferIterRef<'a, T, N>

Iterate over references to elements of the RingBuffer.

Trait Implementations

impl<T: Clone, const N: usize> Clone for RingBuffer<T, N>

fn clone(&self) -> RingBuffer<T, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const N: usize> Debug for RingBuffer<T, N>

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

Formats the value using the given formatter.

impl<T, const N: usize> Default for RingBuffer<T, N>

fn default() -> Self

Returns the “default value” for a type.

impl<T, const N: usize> Index<usize> for RingBuffer<T, N>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, const N: usize> IntoIterator for RingBuffer<T, N>

type Item = T

The type of the elements being iterated over.

type IntoIter = RingBufferIter<T, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.