Enum ReadResult 

pub enum ReadResult<T> {
    Ok(T),
    NotReady,
    Overrun,
}

Result of attempting to read from the MCache.

Variants

Ok(T)

Successfully read the data.

NotReady

The sequence number has not been published yet.

Overrun

The consumer was too slow and the slot was overwritten.

Implementations

impl<T> ReadResult<T>

pub fn is_ok(&self) -> bool

Returns true if the result is Ok.

pub fn is_not_ready(&self) -> bool

Returns true if the result is NotReady.

pub fn is_overrun(&self) -> bool

Returns true if the result is Overrun.

pub fn ok(self) -> Option<T>

Converts to Option<T>, discarding the error variant.

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: Debug> Debug for ReadResult<T>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

impl<T> StructuralPartialEq for ReadResult<T>