Struct circularing::Circular

pub struct Circular<T, const N: usize>
where
    T: Clone + Copy,
{ /* private fields */ }

Implementations

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

where T: Clone + Copy,

pub const fn new() -> Self

Construct a new Circular from the grounds up.

Panics: In debug builds, it will panic if N is zero. In release builds attempting to build a zero-length buffer is strictly undefined behaviour.

pub const unsafe fn from_raw_parts( storage_slice: [MaybeUninit<T>; N], storage_usage: usize ) -> Self

Construct a new Circular from the ground up using raw parts.

Panics: In debug builds, it will panic if N is zero. In release builds attempting to build a zero-length buffer is strictly undefined behaviour.

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

Adds an item T at the end of the buffer and shifts any existing ones forward.

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

Removes an item T from the end of the buffer and shifts any existing ones backwards. The resulting value must be used.

pub fn at(&mut self, target_index: usize) -> Option<T>

pub const fn is_empty(&self) -> bool

Determines if the buffer is empty.

pub const fn is_nonempty(&self) -> bool

Determines if the buffer is non-empty.

pub const fn is_full(&self) -> bool

Determines if the buffer has no more free spots left.

pub const fn usage(&self) -> usize

Informs of the current buffer usage.

Trait Implementations

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

where T: Clone + Copy + Debug,

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

Formats the value using the given formatter.

impl<T, const N: usize> Drop for Circular<T, N>

where T: Clone + Copy,

fn drop(&mut self)

Executes the destructor for this type.