Struct CircularBuffer

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

Implementations

impl<T> CircularBuffer<T>

pub fn new_zeroed(count: usize) -> CircularBuffer<T>

where T: Zero,

Create a new CircularBuffer<T> by initializing it with T’s Zero implementation.

This function is feature-gated behind the num-traits feature.

impl<T> CircularBuffer<T>

pub fn new_default(count: usize) -> CircularBuffer<T>

where T: Default,

Create a new CircularBuffer<T> by initializing it with T’s Default implementation.

pub fn update_forwards(&mut self, src: T) -> (T, T)

where T: Copy,

Returns the previous value, and increments cursor

pub fn update_backwards(&mut self, src: T) -> (T, T)

where T: Copy,

The same as CircularBuffer::update_forwards but reverses through the internal buffer

pub const fn set_cursor(&mut self, val: usize)

Set the CircularBuffer’s cursor to the specified value

pub const fn reset_cursor(&mut self)

Set the CircularBuffer’s cursor to zero

pub const fn is_empty(&self) -> bool

pub const fn len(&self) -> usize

Returns the total element-count in this CircularBuffer

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

Returns the full data contained in this CircularBuffer as a shared slice-reference

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns the full data contained in this CircularBuffer as a mutable slice-reference

Trait Implementations

impl<T> From<ArrayPtr<T>> for CircularBuffer<T>

fn from(value: ArrayPtr<T>) -> Self

Converts to this type from the input type.

impl<T> Index<usize> for CircularBuffer<T>

type Output = <ArrayPtr<T> as Index<usize>>::Output

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for CircularBuffer<T>

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

Performs the mutable indexing (container[index]) operation.