Struct EventBuf 

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

Bounded SPSC event buffer with backpressure.

When the buffer is full, Producer::push returns Err(val) instead of overwriting, giving the producer a chance to retry, drop, or log. The consumer drains items with Consumer::pop or Consumer::drain, and can inspect the oldest item with Consumer::peek without consuming it.

Panics

• EventBuf::new() panics if N == 0.
• producer() / consumer() panic if called while another handle of the same kind is already active. Use EventBuf::try_producer / EventBuf::try_consumer for a fallible alternative.

Implementations

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

pub fn new() -> Self

Create a new, empty event buffer.

Panics

Panics if N == 0.

pub const fn capacity(&self) -> usize

Maximum number of items the buffer can hold.

pub fn len(&self) -> usize

Approximate number of items currently buffered.

Returns a consistent (tail, head) snapshot. The value may still be stale by the time the caller acts on it, but it will never spuriously exceed capacity.

This never blocks: it makes a bounded number of attempts and then falls back to a clamped estimate, so a busy consumer cannot stall the caller.

pub fn is_empty(&self) -> bool

Returns true if the buffer contains no items (approximate).

pub fn is_full(&self) -> bool

Returns true if the buffer is at capacity (approximate).

pub fn try_producer(&self) -> Option<Producer<'_, T, N>>

Try to create the producer handle.

Returns None if a producer is already active. Prefer this over producer when fallible bring-up is needed.

pub fn producer(&self) -> Producer<'_, T, N>

Create the producer handle. Only one producer may be active.

Panics

Panics if a producer handle is already active.

pub fn try_consumer(&self) -> Option<Consumer<'_, T, N>>

Try to create the consumer handle.

Returns None if a consumer is already active. Prefer this over consumer when fallible bring-up is needed.

pub fn consumer(&self) -> Consumer<'_, T, N>

Create the consumer handle. Only one consumer may be active.

Panics

Panics if a consumer handle is already active.

Trait Implementations

impl<T: Copy, const N: usize> Debug for EventBuf<T, N>

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

Formats the value using the given formatter.

impl<T: Copy, const N: usize> Default for EventBuf<T, N>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Copy + Send, const N: usize> Sync for EventBuf<T, N>