Struct CircularBuffer 

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

Const-generic zero-allocation circular buffer and delay line for real-time DSP sample streams.

Implementations

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

pub const fn new(init_val: T) -> Self

Creates a new circular buffer initialized with init_val.

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

Pushes a new sample into the buffer, overwriting the oldest sample when full.

pub fn get(&self, lag: usize) -> Option<T>

Gets sample with historical lag $k$, where $k = 0$ is the newest sample (x[n]), $k = 1$ is x[n-1], etc. Returns None if lag >= self.len().

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

Returns the most recently pushed sample (x[n]).

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

Returns the oldest sample stored in the buffer.

pub const fn len(&self) -> usize

Returns the number of valid samples currently stored in the buffer.

pub const fn capacity(&self) -> usize

Returns the capacity of the circular buffer (N).

pub const fn is_empty(&self) -> bool

Returns true if the buffer contains no samples.

pub const fn is_full(&self) -> bool

Returns true if the buffer is filled to capacity N.

pub fn clear(&mut self, reset_val: T)

Clears the circular buffer, resetting sample count and filling with reset_val.

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy, const N: usize> Copy for CircularBuffer<T, N>

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

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

Formats the value using the given formatter.