Struct Consumer 

pub struct Consumer<T, const CAPACITY: usize, AllocT: Allocation<T>> { /* 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, AllocT: Allocation<T>> Consumer<T, CAPACITY, AllocT>

pub fn pop(&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 (producer, 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, AllocT: Allocation<T>> Debug for Consumer<T, CAPACITY, AllocT>

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

Formats the value using the given formatter.

impl<T: Send, const CAPACITY: usize, AllocT: Allocation<T> + Send> Send for Consumer<T, CAPACITY, AllocT>