Struct Producer 

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

The pushing handle of an SPSC FIFO queue.

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

Implementations

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

where A: Allocator,

pub fn push(&mut self, item: T) -> Option<T>

Pushes item onto the queue.

Wait-free. Never blocks, never allocates. Returns None on success. If the queue is full the item is returned unchanged as Some(item), so the caller can retry or back off without losing data.

Examples

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

let (mut producer, mut consumer) = new::<u64, 2, GlobalAllocator>(
    spsc::Options::global_mlocked(),
);
assert_eq!(producer.push(1), None);
assert_eq!(producer.push(2), None);
// Queue is full; item is handed back so we can retry later.
assert_eq!(producer.push(3), Some(3));

Trait Implementations

impl<T, const CAPACITY: usize, A> Debug for Producer<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 Producer<T, CAPACITY, A>

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