Struct SpscConsumer 

pub struct SpscConsumer<T, Codec, const BYTES: usize> { /* private fields */ }

The only consumer endpoint for a mailbox.

The endpoint is Send but not Sync. Its operations use a bounded number of lock-free atomic loads and stores.

Implementations

impl<T, Codec, const BYTES: usize> SpscConsumer<T, Codec, BYTES>

where T: Copy + Send + Sync + 'static, Codec: SpscCodec<T, BYTES>,

pub fn try_peek(&mut self) -> Result<T, SpscPopError>

Returns the current value without permitting slot reuse.

Repeated calls return the same value. Call commit_peeked only after the downstream consumer accepts the value.

pub fn commit_peeked(&mut self) -> Result<SpscCommitOutcome, SpscCommitError>

Consumes the value returned by try_peek.

The release store permits the producer to reuse this slot. An invalid payload can also be committed so later values remain accessible.

pub fn try_pop(&mut self) -> Result<T, SpscPopError>

pub fn capacity(&self) -> usize

pub fn approximate_len(&self) -> usize

pub fn counters(&self) -> SpscCounters

pub fn is_producer_connected(&self) -> bool

Trait Implementations

impl<T, Codec, const BYTES: usize> Drop for SpscConsumer<T, Codec, BYTES>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.