Enum ReadResult 

pub enum ReadResult<T> {
    Value(T),
    Empty,
    Lapped {
        skipped: usize,
    },
}

Available on non-crate feature tests_loom only.

Outcome of a Consumer::try_read call.

try_read is non-blocking and never allocates, so the return value distinguishes three cases the caller must handle: a successful read, an empty queue, or a detected lap. The enum is #[must_use] because silently dropping Value would lose the only copy of the data, and silently dropping Lapped would hide message loss.

Variants

Value(T)

A value was successfully read from the next slot.

Empty

The queue is currently empty.

Lapped

The producer lapped this consumer at least once. The read cursor has been advanced to the most recently published slot; skipped is the number of values that were never observed.

Fields

skipped: usize

Number of values skipped over by the lap-recovery jump.

Trait Implementations

impl<T: Clone> Clone for ReadResult<T>

fn clone(&self) -> ReadResult<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy> Copy for ReadResult<T>

impl<T: Debug> Debug for ReadResult<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for ReadResult<T>

impl<T: PartialEq> PartialEq for ReadResult<T>

fn eq(&self, other: &ReadResult<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for ReadResult<T>