Struct RingBuffer

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

Available on crate feature chili only.

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() -> RingBuffer<T, N>

Available on crate feature cpu_os_threads only.

Creates a new empty RingBuffer

pub fn get_size(&self) -> usize

Available on crate feature cpu_os_threads only.

Gets the current size of the RingBuffer

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

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

Available on crate feature cpu_os_threads only.

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>

Available on crate feature cpu_os_threads only.

Iterate over references to elements of the RingBuffer.

Trait Implementations

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

where T: Clone,

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, const N: usize> Debug for RingBuffer<T, N>

where T: Debug,

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

Formats the value using the given formatter.

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

fn default() -> RingBuffer<T, N>

Returns the “default value” for a type.

impl<'de, T, const N: usize> Deserialize<'de> for RingBuffer<T, N>

where T: Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<RingBuffer<T, N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &<RingBuffer<T, N> as Index<usize>>::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) -> <RingBuffer<T, N> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

where T: Serialize,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.