Struct SpscQueue 

pub struct SpscQueue<T: Copy, const CAP: usize> { /* private fields */ }

A lock-free single-producer single-consumer queue.

Uses atomic operations for real-time safe push/pop without blocking. The capacity must be a power of two for efficient mask-based indexing.

Implementations

impl<T: Copy + Default, const CAP: usize> SpscQueue<T, CAP>

pub fn new() -> Self

Create a new SPSC queue with default policies.

The overflow policy defaults to OverflowPolicy::OverwriteOldest.

Panics

Panics if CAP is not a power of two.

pub fn with_policies( overflow_policy: OverflowPolicy, default_value: Option<T>, ) -> Self

Create a queue with custom overflow policy and default value.

pub fn push(&self, value: T) -> QueueResult<()>

Push a value into the queue.

If the queue is full, behaviour depends on OverflowPolicy.

Errors

Returns QueueFull when the policy is OverflowPolicy::DropNewest or OverflowPolicy::Block and the queue is full.

Panics

Panics when the policy is OverflowPolicy::Panic and the queue is full.

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

Pop a value from the queue, or return the default value if empty.

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

Peek at the front value without removing it.

pub fn len(&self) -> usize

Return the current number of elements in the queue.

pub const fn capacity(&self) -> usize

Return the fixed capacity of the queue.

pub fn is_empty(&self) -> bool

Return true if the queue is empty.

pub fn is_full(&self) -> bool

Return true if the queue is full.

pub fn clear(&self)

Clear the queue, resetting both head and tail pointers.

pub fn stats(&self) -> QueueStatsSnapshot

Return a statistics snapshot (currently always empty).

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

Set the default value returned when popping from an empty queue.

pub fn overflow_policy(&self) -> OverflowPolicy

Return the current overflow policy.

pub fn set_overflow_policy(&mut self, policy: OverflowPolicy)

Set the overflow policy.

Trait Implementations

impl<T: Copy + Default + Debug, const CAP: usize> Debug for SpscQueue<T, CAP>

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

Formats the value using the given formatter.

impl<T: Copy + Default, const CAP: usize> Default for SpscQueue<T, CAP>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Copy + Default + Send + Sync, const CAP: usize> RtQueueBase<T> for SpscQueue<T, CAP>

fn push(&self, value: T) -> QueueResult<()>

Push a value into the queue.

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

Pop a value from the queue, or None if empty.

fn len(&self) -> usize

Current number of elements in the queue.

fn capacity(&self) -> usize

Maximum capacity of the queue.

fn clear(&self)

Clear all elements from the queue.

fn is_empty(&self) -> bool

Return true if the queue is empty.

fn is_full(&self) -> bool

Return true if the queue is full.

impl<T: Copy + Send, const CAP: usize> Send for SpscQueue<T, CAP>

impl<T: Copy + Sync, const CAP: usize> Sync for SpscQueue<T, CAP>