Struct Consumer 

pub struct Consumer<T, const CAPACITY: usize, A>
where
    A: Allocator,
{ /* private fields */ }

The popping handle of an SPSC FIFO queue.

Created together with its paired Producer by new. Consumer is Send but not Sync: at most one thread may pop at a time.

Implementations

impl<T, const CAPACITY: usize, A> Consumer<T, CAPACITY, A>

where A: Allocator,

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

Pops the next item from the queue.

Wait-free. Returns Some(item) on success, None if the queue is currently empty.

Examples

use low_latency_data_structures::spsc::{self, new};
use low_latency_data_structures::mem::global::GlobalAllocator;

let (mut producer, mut consumer) = new::<u64, 4, GlobalAllocator>(
    spsc::Options::global_mlocked(),
);
assert_eq!(consumer.pop(), None);
let _ = producer.push(42);
assert_eq!(consumer.pop(), Some(42));

Trait Implementations

impl<T, const CAPACITY: usize, A> Debug for Consumer<T, CAPACITY, A>

where A: Allocator,

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

Formats the value using the given formatter.

impl<T, const CAPACITY: usize, A> Send for Consumer<T, CAPACITY, A>

where T: Send, A: Allocator, A::Allocation<T>: Send,