Struct SharedRingBuffer

pub struct SharedRingBuffer<T: Clone> { /* private fields */ }

A thread-safe wrapper around RingBuffer for shared access

Implementations

impl<T: Clone> SharedRingBuffer<T>

pub fn new(capacity: usize) -> Self

Creates a new shared ring buffer with the specified capacity

This is the primary interface for creating ring buffers in the HFT system. The buffer is wrapped in an Arc for efficient sharing between threads.

Arguments

• capacity - Buffer capacity, must be a power of 2 (2, 4, 8, 16, 32, 64, 128, …)

Returns

A SharedRingBuffer with effective capacity of capacity - 1 items.

Panics

Panics if capacity is not a power of 2 or is zero.

Example

let buffer = SharedRingBuffer::new(1024);  // For high-frequency data

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

Push an item into the ring buffer

Arguments

• item - The item to push

Returns

true if successful, false if buffer was full

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

Pop an item from the ring buffer

Returns

Some(item) if available, None if buffer was empty

pub fn drain(&self, max_items: usize) -> Vec<T>

Drain up to max_items from the ring buffer

More efficient than repeatedly calling pop() for batch operations.

Arguments

• max_items - Maximum number of items to drain

Returns

Vector of drained items (may be fewer than requested)

pub fn len(&self) -> usize

Returns the current number of items in the buffer

pub fn is_empty(&self) -> bool

Returns true if the buffer contains no items

pub fn overflow_count(&self) -> usize

Returns the number of times the ring buffer has overflowed

An overflow occurs when push() is called on a full buffer, resulting in data loss. This counter is critical for monitoring buffer saturation and capacity planning.

Returns

The total number of overflow events since buffer creation or last reset.

Example

let buffer = SharedRingBuffer::new(64);

// Monitor overflow rate
let initial = buffer.overflow_count();
// ... time passes ...
let overflows = buffer.overflow_count() - initial;
if overflows > 0 {
    eprintln!("Warning: {} overflows detected", overflows);
}

Trait Implementations

impl<T: Clone> Clone for SharedRingBuffer<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.