Struct Consumer 

pub struct Consumer { /* private fields */ }

Consumer endpoint of the MPSC ring buffer.

Use try_claim to claim the next record for reading. This type is NOT Clone - only one consumer is allowed.

Implementations

impl Consumer

pub fn try_claim(&mut self) -> Option<ReadClaim<'_>>

Attempts to claim the next record for reading.

Returns a ReadClaim if a record is available. The claim dereferences to &[u8] for the payload. When dropped, the record region is zeroed and the head is advanced.

Returns None if no committed record is available.

pub fn capacity(&self) -> usize

Returns the capacity of the buffer.

pub fn is_disconnected(&self) -> bool

Returns true if all producers have been dropped.

Trait Implementations

impl Debug for Consumer

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

Formats the value using the given formatter.

impl Send for Consumer