Struct RingBuf 

pub struct RingBuf<T: Copy, const N: usize> { /* private fields */ }

A fixed-capacity FIFO ring buffer.

A buffer with storage size N can hold at most N - 1 values.

Implementations

impl<T: Copy, const N: usize> RingBuf<T, N>

pub const SIZE: usize = N

The number of storage slots in the buffer.

pub const fn new() -> Self

Creates an empty ring buffer.

pub const fn is_empty(&self) -> bool

Returns whether the buffer is empty.

pub const fn len(&self) -> usize

Returns the number of stored values.

pub const fn is_full(&self) -> bool

Returns whether the buffer is full.

pub const fn max_capacity(&self) -> usize

Returns the maximum number of values the buffer can hold.

pub fn try_push(&mut self, value: T) -> Result<(), T>

Appends a value, returning it when the buffer is full.

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

Appends a value.

Panics

Panics when the buffer is full.

pub unsafe fn push_unchecked(&mut self, value: T)

Appends a value without checking whether the buffer is full.

Safety

The caller must ensure the buffer is not full.

pub fn pop(&mut self) -> Option<T>

Removes and returns the oldest value.

Trait Implementations

impl<T: Clone + Copy, const N: usize> Clone for RingBuf<T, N>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy + Copy, const N: usize> Copy for RingBuf<T, N>

impl<T: Copy, const N: usize> Default for RingBuf<T, N>

fn default() -> Self

Returns the “default value” for a type.