Enum DecodeErrorKind 

#[non_exhaustive]
pub enum DecodeErrorKind {
    UnexpectedEnd,
    BadMagic,
    UnsupportedVersion(u32),
    ReservedFlags(u32),
    SectionOutOfOrder {
        expected: u32,
        found: u32,
    },
    SectionLength(u32),
    TrailingBytes,
    LimitExceeded(Limit),
    InvalidUtf8,
    InvalidTag {
        what: &'static str,
        tag: u8,
    },
    InvalidChar(u32),
    ConstForwardRef {
        index: u32,
        child: u32,
    },
    HookOrder,
    DebugCount {
        expected: u32,
        found: u32,
    },
    Inst(InstError),
}

What is wrong with the input; see DecodeError.

Examples

use bytecode_lang::{decode, DecodeErrorKind};

assert_eq!(decode(b"LS").unwrap_err().kind(), &DecodeErrorKind::UnexpectedEnd);
assert_eq!(decode(b"MZ\0\0\x01\0\0\0\0\0\0\0").unwrap_err().kind(), &DecodeErrorKind::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.

UnexpectedEnd

The input ends before a value it promises.

BadMagic

The first four bytes are not LSB\0.

UnsupportedVersion(u32)

The format version is not one this decoder implements.

ReservedFlags(u32)

The header’s reserved flags are not zero.

SectionOutOfOrder

A section id is not the next one in the fixed order.

Fields

expected: u32

The id that should come next.

found: u32

The id found.

SectionLength(u32)

A section’s contents do not fill exactly its declared length.

TrailingBytes

Bytes follow the last section.

LimitExceeded(Limit)

A budget was exceeded.

InvalidUtf8

A string is not valid UTF-8.

InvalidTag

A tag byte names nothing (what says which kind of tag).

Fields

what: &'static str

The kind of tag: "value type", "type", "constant", …

tag: u8

The byte found.

InvalidChar(u32)

A char constant is not a Unicode scalar value.

ConstForwardRef

An aggregate constant refers to itself or a later constant.

Fields

index: u32

The aggregate.

child: u32

The offending element.

HookOrder

Hook bindings are not in strictly increasing hook order.

DebugCount

The debug section’s function count differs from the function section’s.

Fields

expected: u32

Functions in the module.

found: u32

Debug entries found.

Inst(InstError)

An instruction is malformed.

Trait Implementations

impl Clone for DecodeErrorKind

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 DecodeErrorKind

impl Debug for DecodeErrorKind

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

Formats the value using the given formatter.

impl Display for DecodeErrorKind

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

Formats the value using the given formatter.

impl Eq for DecodeErrorKind

impl PartialEq for DecodeErrorKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DecodeErrorKind