Enum ReadError 

#[non_exhaustive]
pub enum ReadError {
    BadMagic,
    Truncated {
        what: &'static str,
    },
    Malformed {
        what: &'static str,
    },
    Unsupported {
        what: &'static str,
        value: u64,
    },
    LimitExceeded {
        limit: &'static str,
    },
    Invalid(ModelError),
}

Why bytes could not be read as an object.

Readers are strict: anything the model cannot represent exactly, or that a careful writer would never produce, is refused rather than guessed at. The enum is #[non_exhaustive]: match it with a wildcard arm.

Examples

use object_lang::ReadError;

assert_eq!(object_lang::elf::read(b"MZ\x90\x00"), Err(ReadError::Truncated { what: "file header" }));
assert_eq!(object_lang::elf::read(&[0u8; 64]), Err(ReadError::BadMagic));

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.

BadMagic

The bytes do not start with the format’s magic number.

Truncated

A structure runs past the end of the input.

Fields

what: &'static str

The structure.

Malformed

A field holds a value the format does not allow, or structures contradict each other.

Fields

what: &'static str

What is wrong.

Unsupported

The file is valid but uses something this reader does not support.

Fields

what: &'static str

What is unsupported.

value: u64

The raw value of the unsupported field (a type, flag set, or class).

LimitExceeded

A Limits budget was exceeded.

Fields

limit: &'static str

Which limit.

Invalid(ModelError)

The file decodes to an object that breaks a rule of the model.

Trait Implementations

impl Clone for ReadError

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 ReadError

impl Debug for ReadError

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

Formats the value using the given formatter.

impl Display for ReadError

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

Formats the value using the given formatter.

impl Eq for ReadError

impl Error for ReadError

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<ModelError> for ReadError

fn from(err: ModelError) -> Self

Converts to this type from the input type.

impl Hash for ReadError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ReadError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReadError