Enum Error 

#[non_exhaustive]
pub enum Error {
    Truncated {
        needed: usize,
        available: usize,
    },
    BufferFull {
        needed: usize,
        available: usize,
    },
    LengthOverflow,
    NotUtf8,
    Malformed(&'static str),
    UnsupportedVersion {
        tag: Tag,
        version: u16,
    },
}

What went wrong while reading or writing an ABI record.

Every variant is a fact about the bytes rather than an opinion about them. Deciding what to do about a malformed record is the caller’s job, because the host and the guest have very different options available to them.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Truncated

The buffer ended before the value did.

Fields

needed: usize

How many bytes the read wanted.

available: usize

How many bytes were left.

BufferFull

There was not enough room left in the output buffer.

Fields

needed: usize

How many bytes the write wanted.

available: usize

How many bytes were left.

LengthOverflow

A length field described more bytes than can be addressed on this target.

NotUtf8

A field that is declared to be text was not valid UTF-8.

Malformed(&'static str)

The bytes parsed but do not describe a record this code can make sense of.

Tuple Fields

0: &'static str

What specifically was wrong. This is a fixed string rather than a formatted one so that the crate stays free of allocation.

UnsupportedVersion

The record is one we know, at a version we do not.

This is not the same as an unknown tag. An unknown tag is skipped, because that is what makes the format extensible. A known tag at an unknown version is a real disagreement and the reader has to say so.

Fields

tag: Tag

Which record.

version: u16

The version that was on the wire.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Error

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

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 Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error