Enum DecodeError 

pub enum DecodeError {
    InvalidInput,
    InvalidLength,
    InvalidByte {
        index: usize,
        byte: u8,
    },
    InvalidPadding {
        index: usize,
    },
    InvalidLineWrap {
        index: usize,
    },
    OutputTooSmall {
        required: usize,
        available: usize,
    },
    StagingTooSmall {
        required: usize,
        available: usize,
    },
}

Decoding error.

Variants

InvalidInput

The encoded input is malformed, but the decoder intentionally does not disclose a more specific error class.

InvalidLength

The encoded input length is impossible for the selected padding policy.

InvalidByte

A byte is not valid for the selected alphabet.

Fields

index: usize

Byte index in the input.

byte: u8

Invalid byte value.

InvalidPadding

Padding is missing, misplaced, or non-canonical.

Fields

index: usize

Byte index where padding became invalid.

InvalidLineWrap

Line wrapping is missing, misplaced, or uses the wrong line ending.

Fields

index: usize

Byte index where line wrapping became invalid.

OutputTooSmall

The output buffer is too small.

Fields

required: usize

Required output bytes.

available: usize

Available output bytes.

StagingTooSmall

The caller-provided constant-time staging buffer is too small.

Fields

required: usize

Required staging bytes.

available: usize

Available staging bytes.

Implementations

impl DecodeError

pub const fn kind(self) -> DecodeErrorKind

Returns a redacted error class without input-derived bytes or indexes.

Strict decoders keep exact diagnostics in DecodeError and core::fmt::Display for developer debugging. When input may contain secrets or secret-adjacent material, log this kind instead of logging the full error value.

Trait Implementations

impl Clone for DecodeError

fn clone(&self) -> DecodeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DecodeError

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Eq for DecodeError

impl Error for DecodeError

Available on crate feature std only.

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 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