Struct RingBuffer 

pub struct RingBuffer<T> {
    data: Box<[Option<T>]>,
    head: usize,
}

A high performance ring buffer optimized for writing that can be used to store a fixed number of elements. This ring buffer is a contiguous memory array allocated in the heap and keeps track of the last index that was written. Pushing a new element will overwrite the oldest element in the buffer. Additionally, iteration will always be O(n) where n is the capacity of the buffer, regardless of the number of elements that are stored in the buffer.

The index 0 of the ring buffer will always be the oldest element in the buffer.

It might be justified to use unsafe code for peak performance.

Fields

data: Box<[Option<T>]>

head: usize

Implementations

impl<T> RingBuffer<T>

pub fn new(buffer: Box<[Option<T>]>) -> Self

pub fn with_capacity(size: usize) -> Self

pub fn from_slice(slice: &[T]) -> Self

where T: Clone,

pub fn from_vec(vec: impl Into<Vec<T>>) -> Self

fn get_real_idx(&self, index: usize) -> usize

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

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

fn next_index(&self) -> usize

pub fn iter(&self) -> RingBufferIter<'_, T>

pub fn iter_range(&self, range: Range<usize>) -> RingBufferIter<'_, T>

pub fn as_vec(&self) -> Vec<&T>

pub fn len(&self) -> usize

impl<T: Clone> RingBuffer<T>

pub fn set_all(&mut self, value: T)

Trait Implementations

impl<T: Clone> Clone for RingBuffer<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> From<RingBuffer<T>> for Vec<T>

fn from(buffer: RingBuffer<T>) -> Self

Converts to this type from the input type.

impl<T, U> From<U> for RingBuffer<T>

where U: Iterator<Item = T>,

fn from(iter: U) -> Self

Converts to this type from the input type.

impl<T> Index<usize> for RingBuffer<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IntoIterator for RingBuffer<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = Flatten<IntoIter<Option<<RingBuffer<T> as IntoIterator>::Item>>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.