Struct CircularBuffer

#[repr(align(64))]
pub struct CircularBuffer<T, const N: usize> { /* private fields */ }

Cache-friendly fixed-size circular buffer optimized for HFT applications Uses a contiguous memory layout and avoids heap allocations

Implementations

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

pub const fn new() -> Self

Create a new empty circular buffer with fixed capacity

pub const fn capacity(&self) -> usize

Returns the capacity of the buffer

pub const fn len(&self) -> usize

Returns the current number of elements in the buffer

pub const fn is_empty(&self) -> bool

Returns true if the buffer is empty

pub const fn is_full(&self) -> bool

Returns true if the buffer is full

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

Add an element to the buffer Returns true if successful, false if buffer is full

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

Remove and return the oldest element from the buffer Returns None if the buffer is empty

pub const fn peek(&self) -> Option<&T>

Peek at the oldest element without removing it Returns None if the buffer is empty

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

Get a reference to an element at a specific index relative to the read position Returns None if the index is out of bounds

pub fn get_mut(&mut self, index: usize) -> Option<&mut T>

Get a mutable reference to an element at a specific index relative to the read position Returns None if the index is out of bounds

pub fn clear(&mut self)

Clear the buffer, dropping all elements

pub fn for_each<F>(&self, f: F)

where F: FnMut(&T),

Execute a function on each element in the buffer

pub fn for_each_mut<F>(&mut self, f: F)

where F: FnMut(&mut T),

Execute a function on each element in the buffer, allowing mutation

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

where T: Clone,

Convert the buffer to a Vec, consuming the buffer

pub fn push_overwrite(&mut self, item: T) -> bool

Overwrite the oldest element if the buffer is full Always returns true (as it will always add the item)

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn drop(&mut self)

Executes the destructor for this type.

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

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

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

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