Enum packtool::Error

pub enum Error {
    InvalidSize {
        ty: &'static str,
        received: usize,
        expected: usize,
    },
    Assumption {
        ty: &'static str,
        assumption: &'static str,
        message: String,
    },
    InvalidDiscriminant {
        ty: &'static str,
        options: &'static str,
        found: Box<dyn Debug + Send + Sync>,
    },
    InvalidField {
        ty: &'static str,
        field: &'static str,
    },
    InvalidTuple {
        ty: &'static str,
        index: usize,
    },
    Message(Cow<'static, str>),
    Custom(Box<dyn Error + Send + Sync>),
    Context {
        ty: &'static str,
        error: Box<Self>,
        cause: Box<Self>,
    },
}

error associated to unpacking or creating [View] of [Packed] types.

Variants

InvalidSize

error that is returned if an invalid size is detected

this will happen when calling [View::try_from_slice] for example.

Fields of InvalidSize

ty: &'static str

the stringified type associated to this error

received: usize

the size of the slice that does not match the expected size

expected: usize

the expected size

Assumption

error that is created when an assumption is false

this is used by ensure macro

Fields of Assumption

ty: &'static str

the stringified type associated to this error

assumption: &'static str

the stringified assumption

message: String

a custom message associated to the assumption

InvalidDiscriminant

error when trying to check an Enumeration against a slice

Fields of InvalidDiscriminant

ty: &'static str

the stringified type associated to this error

options: &'static str

the available values (if any)

found: Box<dyn Debug + Send + Sync>

the actually found value

InvalidField

Fields of InvalidField

ty: &'static str

the stringified type associated to this error

field: &'static str

InvalidTuple

Fields of InvalidTuple

ty: &'static str

the stringified type associated to this error

index: usize

Message(Cow<'static, str>)

Custom(Box<dyn Error + Send + Sync>)

Context

Fields of Context

ty: &'static str

the stringified type associated to this error

error: Box<Self>cause: Box<Self>

the root cause of the error

recursively call the underlying error to find more granulated details of a given error

Implementations

impl Error

pub fn invalid_size<T: ?Sized>(received: usize, expected: usize) -> Self

convenient function to create an Error::InvalidSize with the type_name of T being captured

pub fn invalid_discriminant<T, V>(found: V, options: &'static str) -> Self where
    T: ?Sized,
    V: Debug + Send + Sync + 'static, 

pub fn invalid_field<T>(field: &'static str) -> Self where
    T: ?Sized, 

pub fn invalid_tuple<T>(index: usize) -> Self where
    T: ?Sized, 

Trait Implementations

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, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<&'static str> for Error

fn from(error: &'static str) -> Self

Performs the conversion.

impl From<Box<dyn Error + 'static + Sync + Send, Global>> for Error

fn from(source: Box<dyn Error + Send + Sync>) -> Self

Performs the conversion.