LocalRingBuffer

Struct LocalRingBuffer 

Source
pub struct LocalRingBuffer<T> { /* private fields */ }
Expand description

Single-threaded ring buffer optimized for maximum performance

LocalRingBuffer uses VecDeque directly without synchronization primitives, providing optimal performance for single-threaded contexts.

For multi-threaded scenarios requiring concurrent access, use the thread-safe RingBuffer type (defined below in this module) which wraps the buffer in Arc<RwLock> for safe concurrent access.

Implementations§

Source§

impl<T: Copy + Default> LocalRingBuffer<T>

Source

pub fn new(capacity: usize) -> Self

Create new local ring buffer with given capacity

Source

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

Push value to buffer, overwriting oldest if full

Source

pub fn sliding_window(&self, size: usize) -> Vec<T>

Get sliding window of last N elements

§Performance

Efficiently accesses the last N elements with direct indexing. Time complexity: O(k) where k is the window size.

Source

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

Get a single element by index (0 = oldest, len-1 = newest)

Source

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

Get the most recent element

Source

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

Get the oldest element

Source

pub fn len(&self) -> usize

Get current size of buffer

Source

pub fn is_empty(&self) -> bool

Check if buffer is empty

Source

pub fn clear(&mut self)

Clear the buffer

Source

pub fn capacity(&self) -> usize

Get capacity of the buffer

Source

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

Convert to vector (for testing/debugging)

Source

pub fn iter(&self) -> impl Iterator<Item = &T>

Get an iterator over the buffer elements (oldest to newest)

Source

pub fn sliding_window_into(&self, size: usize, dest: &mut [T]) -> usize

Zero-allocation sliding window - writes into pre-allocated buffer

§Performance

This method avoids heap allocation by writing directly into the provided buffer. For streaming applications processing millions of ticks, this eliminates allocation overhead completely.

§Arguments
  • size - Number of elements to read (from the most recent)
  • dest - Pre-allocated destination buffer (must have sufficient capacity)
§Returns

Number of elements written to destination

Source

pub fn sliding_window_slices(&self, size: usize) -> (&[T], &[T])

Get the N most recent elements as contiguous slices

Since VecDeque may store data in two non-contiguous slices, this returns both slices that comprise the last N elements. For many use cases, this avoids allocation entirely.

§Returns

Tuple of (first_slice, second_slice) - second may be empty

Source

pub fn get_recent_samples(&self, count: usize, dest: &mut [T]) -> usize

Get the most recent N samples for circular convolution

Optimized for MODWT streaming where we need the last filter_len samples for computing a single new coefficient.

§Returns

Number of samples copied (may be less than filter_len if buffer not full)

Trait Implementations§

Source§

impl<T: Clone> Clone for LocalRingBuffer<T>

Source§

fn clone(&self) -> LocalRingBuffer<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for LocalRingBuffer<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for LocalRingBuffer<T>

§

impl<T> RefUnwindSafe for LocalRingBuffer<T>
where T: RefUnwindSafe,

§

impl<T> Send for LocalRingBuffer<T>
where T: Send,

§

impl<T> Sync for LocalRingBuffer<T>
where T: Sync,

§

impl<T> Unpin for LocalRingBuffer<T>
where T: Unpin,

§

impl<T> UnwindSafe for LocalRingBuffer<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V