Enum RingBufferError 

pub enum RingBufferError {
    BufferFull,
    PayloadLengthMismatch,
    InvalidPayloadOffset,
}

Errors that can occur while writing into a PluginRingBuffer.

Examples

use martensite_plugin::RingBufferError;

let err = RingBufferError::BufferFull;
assert_eq!(err.to_string(), "ring buffer is full");

Variants

BufferFull

The ring buffer does not have enough contiguous free space for the command and its payload.

PayloadLengthMismatch

The command’s data_len field does not match the supplied payload.

InvalidPayloadOffset

The command’s payload_offset or data_len is outside the buffer.

Trait Implementations

impl Clone for RingBufferError

fn clone(&self) -> RingBufferError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RingBufferError

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

Formats the value using the given formatter.

impl Display for RingBufferError

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

Formats the value using the given formatter.

impl Eq for RingBufferError

impl Error for RingBufferError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for RingBufferError

fn eq(&self, other: &RingBufferError) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RingBufferError