Struct Consumer 

pub struct Consumer<T> { /* private fields */ }

The consumer half of an SPSC ring buffer.

Use pop to remove elements. Takes &mut self to statically ensure single-consumer access.

Implementations

impl<T> Consumer<T>

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

Attempts to pop a value from the ring buffer.

Returns Some(value) if data is available, None if the buffer is empty. Values are returned in FIFO order.

Example

use nexus_queue;

let (mut producer, mut consumer) = nexus_queue::ring_buffer::<u32>(8);

assert_eq!(consumer.pop(), None); // Empty

producer.push(42).unwrap();
assert_eq!(consumer.pop(), Some(42));

pub const fn capacity(&self) -> usize

Returns the capacity of the ring buffer.

pub fn is_disconnected(&self) -> bool

Returns true if the producer has been dropped.

Trait Implementations

impl<T> Debug for Consumer<T>

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

Formats the value using the given formatter.

impl<T: Send> Send for Consumer<T>