Enum planus::errors::ErrorKind

#[non_exhaustive]
pub enum ErrorKind {
    InvalidOffset,
    InvalidLength,
    UnknownEnumTag {
        source: UnknownEnumTagKind,
    },
    UnknownUnionTag {
        tag: u8,
    },
    InvalidVtableLength {
        length: u16,
    },
    InvalidUtf8 {
        source: Utf8Error,
    },
    MissingRequired,
    MissingNullTerminator,
}

The possible errors in planus when reading data from a serialized buffer.

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.

InvalidOffset

The offset was out of bounds.

InvalidLength

The buffer was too short while validating a length field.

UnknownEnumTag

Fields

source: UnknownEnumTagKind

The enum value that wasn’t recognized.

An enum contained an unknown value. For forward compatibility this error should be handled appropriately.

UnknownUnionTag

Fields

tag: u8

The union tag that wasn’t recognized.

An union contained an unknown variant. For forward compatibility this error should be handled appropriately.

InvalidVtableLength

Fields

length: u16

The length of the vtable.

A vtable had an invalid length (too large, too small or unaligned).

InvalidUtf8

Fields

source: Utf8Error

The utf-8 error triggered by the string.

A string contained invalid utf-8.

MissingRequired

A required field was missing.

MissingNullTerminator

A string null terminator was missing.

Implementations

impl ErrorKind

pub fn with_error_location(
    self,
    type_: &'static str,
    method: &'static str,
    byte_offset: usize
) -> Error

Helper function that adds an error location to this error.

Trait Implementations

impl Clone for ErrorKind

fn clone(&self) -> ErrorKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorKind

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

Formats the value using the given formatter.

impl Display for ErrorKind

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

Formats the value using the given formatter.

impl Error for ErrorKind

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

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, demand: &mut Demand<'a>)

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

Provides type based access to context intended for error reports.

impl From<UnknownEnumTagKind> for ErrorKind

fn from(source: UnknownEnumTagKind) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for ErrorKind

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.

impl Copy for ErrorKind