Enum DecodeError

#[non_exhaustive]
pub enum DecodeError {
    InvalidByte(InvalidByte),
    WrongOutputLength(WrongOutputLength),
    WrongInputLength(WrongInputLength),
    ExcessBits(ExcessBits),
}

Error returned by decode

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.

InvalidByte(InvalidByte)

When one of the bytes in the slice passed to decode isn’t in the char set of the passed encoding.

Eg: a ! in an otherwise base 64 encoded string.

WrongOutputLength(WrongOutputLength)

When the array returned by decode isn’t the length that the arguments would produce.

WrongInputLength(WrongInputLength)

When the slice passed to decode is not a valid length for that encoding.

The input lengths that are wrong for each encoding:

• Base 64: when input.len() % 4 equals 1.
• Base 32: when input.len() % 8 equals 1, 3 , or 6.
• Base 16: when input.len() % 2 equals 1.

ExcessBits(ExcessBits)

When the last byte in the slice passed to decode has excess set bits that aren’t copied to the return value.

Implementations

impl DecodeError

pub const fn unwrap<T: Copy>(res: Result<T, Self>) -> T

Unwraps a Result with this type as the error.

pub const fn panic(&self) -> !

Panics with this error as the message.

Trait Implementations

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl PartialEq for DecodeError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DecodeError