Enum RingError 

pub enum RingError {
    MagicMismatch,
    VersionMismatch,
    CapacityMismatch {
        descriptor: u16,
        mapped: usize,
    },
    PointerOutOfBounds {
        ptr: u16,
        capacity: u16,
    },
    RegionLength {
        len: usize,
    },
    FrameTooLarge {
        len: usize,
        max: usize,
    },
    BufferTooSmall {
        len: usize,
        needed: usize,
    },
    Faulted,
    NonCoherentRegion,
}

Why a ring could not be opened, or a frame could not be moved.

Variants

MagicMismatch

The region does not start with the CDBG magic.

VersionMismatch

The descriptor is a CDBG version this crate cannot read.

CapacityMismatch

The descriptor’s capacity does not fit the region.

Fields

descriptor: u16

Capacity recorded in the descriptor (0 when the region is too small to hold a descriptor at all).

mapped: usize

The region’s length.

PointerOutOfBounds

A ring cursor lies outside [DATA_START, capacity).

Fields

ptr: u16

The offending cursor.

capacity: u16

The descriptor’s capacity.

RegionLength

A region to initialize is too short for a descriptor and one frame, or longer than a u16 capacity can describe.

Fields

len: usize

The region’s length.

FrameTooLarge

The frame can never fit: it is longer than one packet carries, or than the ring’s data area. It was dropped and Flags::Overflow latched.

Fields

len: usize

The frame’s length.

max: usize

The longest frame this ring accepts.

BufferTooSmall

The next frame is longer than the receive buffer; it was left unread.

Fields

len: usize

The buffer’s length.

needed: usize

The frame’s length.

Faulted

The writer latched Flags::Error; the ring accepts no more frames.

NonCoherentRegion

The region is not cache-coherent. The CDBG layout shares cache lines between writer- and reader-owned fields, so it needs a coherent mapping.

Trait Implementations

impl Clone for RingError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RingError

impl Debug for RingError

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

Formats the value using the given formatter.

impl Display for RingError

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

Formats the value using the given formatter.

impl Eq for RingError

impl Error for RingError

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 From<RingError> for HostError

fn from(error: RingError) -> Self

Converts to this type from the input type.

impl PartialEq for RingError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RingError