Enum DecodeErrorKind

#[non_exhaustive]
pub enum DecodeErrorKind {
    AlphabetConstraintNotSatisfied {
        reason: PermittedAlphabetError,
    },
    SizeConstraintNotSatisfied {
        size: Option<usize>,
        expected: String,
    },
    ValueConstraintNotSatisfied {
        value: Integer,
        expected: Bounded<i128>,
    },
    CodecSpecific {
        inner: CodecDecodeError,
    },
    EnumerationIndexNotFound {
        index: usize,
        extended_list: bool,
    },
    ChoiceIndexNotFound {
        index: usize,
        variants: Variants,
    },
    ChoiceIndexExceedsPlatformWidth {
        needed: u32,
        present: u64,
    },
    Custom {
        msg: String,
    },
    DiscriminantValueNotFound {
        discriminant: isize,
    },
    DuplicateField {
        name: &'static str,
    },
    ExceedsMaxLength {
        length: BigUint,
    },
    LengthExceedsPlatformWidth {
        msg: String,
    },
    FieldError {
        name: &'static str,
        nested: Box<DecodeError>,
    },
    Incomplete {
        needed: Needed,
    },
    IncorrectItemNumberInSequence {
        expected: usize,
        actual: usize,
    },
    IntegerOverflow {
        max_width: u32,
    },
    IntegerTypeConversionFailed {
        msg: String,
    },
    InvalidBitString {
        bits: u8,
    },
    InvalidBool {
        value: u8,
    },
    ZeroLengthOfLength,
    MismatchedLength {
        expected: usize,
        actual: usize,
    },
    MissingField {
        name: &'static str,
    },
    MissingTagClassOrValueInSequenceOrSet {
        class: Class,
        value: u32,
    },
    RangeExceedsPlatformWidth {
        needed: u32,
        present: u32,
    },
    RequiredExtensionNotPresent {
        tag: Tag,
    },
    ExtensionPresentButNotRequired {
        tag: Tag,
    },
    Parser {
        msg: String,
    },
    StringConversionFailed {
        tag: Tag,
        msg: String,
    },
    FixedStringConversionFailed {
        tag: Tag,
        expected: usize,
        actual: usize,
    },
    NoValidChoice {
        name: &'static str,
    },
    TypeNotExtensible,
    UnexpectedExtraData {
        length: usize,
    },
    UnknownField {
        index: usize,
        tag: Tag,
    },
    UnexpectedEmptyInput,
}

DecodeError kinds which are common for all codecs.

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.

AlphabetConstraintNotSatisfied

Fields

reason: PermittedAlphabetError

SizeConstraintNotSatisfied

Fields

size: Option<usize>

Actual sie of the data

expected: String

Expected size by the constraint

ValueConstraintNotSatisfied

Fields

value: Integer

Actual value of the data

expected: Bounded<i128>

Expected value by the constraint

CodecSpecific

Fields

inner: CodecDecodeError

EnumerationIndexNotFound

Fields

index: usize

The found index of the enumerated variant.

extended_list: bool

Whether the index was checked from the extended variants.

ChoiceIndexNotFound

Fields

index: usize

The found index of the choice variant.

variants: Variants

The variants checked for presence.

ChoiceIndexExceedsPlatformWidth

Fields

needed: u32

Amount of bytes needed.

present: u64

Amount of bytes needed.

Custom

Fields

msg: String

The error’s message.

DiscriminantValueNotFound

Fields

discriminant: isize

The found value of the discriminant

DuplicateField

Fields

name: &'static str

The field’s name.

ExceedsMaxLength

Fields

length: BigUint

The maximum length.

LengthExceedsPlatformWidth

More than usize::MAX number of data requested.

Fields

msg: String

FieldError

Fields

name: &'static str

The field’s name.

nested: Box<DecodeError>

Incomplete

Input is provided as BIT slice for nom in UPER/APER. On BER/CER/DER it is as BYTE slice. Hence, needed field can describe either bits or bytes depending on the codec.

Fields

needed: Needed

Amount of bits/bytes needed.

IncorrectItemNumberInSequence

Fields

expected: usize

The expected item number.

actual: usize

The actual item number.

IntegerOverflow

Fields

max_width: u32

The maximum integer width.

IntegerTypeConversionFailed

Fields

msg: String

InvalidBitString

Fields

bits: u8

The amount of invalid bits.

InvalidBool

BOOL value is not 0 or 0xFF. Applies: BER/COER/PER? TODO categorize better

Fields

value: u8

ZeroLengthOfLength

MismatchedLength

The length does not match what was expected.

Fields

expected: usize

The expected length.

actual: usize

The actual length.

MissingField

Fields

name: &'static str

The field’s name.

MissingTagClassOrValueInSequenceOrSet

Fields

class: Class

The field’s name.

value: u32

RangeExceedsPlatformWidth

Fields

needed: u32

Amount of bytes needed.

present: u32

Amount of bytes needed.

RequiredExtensionNotPresent

Fields

tag: Tag

ExtensionPresentButNotRequired

Fields

tag: Tag

Parser

Fields

msg: String

The error’s message.

StringConversionFailed

Fields

tag: Tag

Universal tag of the string type.

msg: String

The error’s message.

FixedStringConversionFailed

Fields

tag: Tag

Tag of the string type.

expected: usize

Expected length

actual: usize

Actual length

NoValidChoice

Fields

name: &'static str

The field’s name.

TypeNotExtensible

UnexpectedExtraData

Unexpected extra data found.

Fields

length: usize

The amount of garbage data.

UnknownField

Fields

index: usize

tag: Tag

UnexpectedEmptyInput

Trait Implementations

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

Formats the value using the given formatter.

impl Error for DecodeErrorKind

where Self: Debug + Display,

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 source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

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 ErrorCompat for DecodeErrorKind

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

Returns a Backtrace that may be printed.

fn iter_chain(&self) -> ChainCompat<'_>

where Self: AsErrorSource,

Returns an iterator for traversing the chain of errors, starting with the current error and continuing with recursive calls to Error::source.