Enum der::ErrorKind

#[non_exhaustive]pub enum ErrorKind {
    Failed,
    Length {
        tag: Tag,
    },
    Noncanonical,
    MalformedOid,
    Overflow,
    Overlength,
    TrailingData {
        decoded: Length,
        remaining: Length,
    },
    Truncated,
    Underlength {
        expected: Length,
        actual: Length,
    },
    UnexpectedTag {
        expected: Option<Tag>,
        actual: Tag,
    },
    UnknownOid {
        oid: ObjectIdentifier,
    },
    UnknownTag {
        byte: u8,
    },
    Utf8(Utf8Error),
    Value {
        tag: Tag,
    },
}

Error type.

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.

Failed

This error indicates a previous DER parsing operation resulted in an error and tainted the state of a Decoder or Encoder.

Once this occurs, the overall operation has failed and cannot be subsequently resumed.

Length

Incorrect length for a given field.

Fields of Length

tag: Tag

Tag type of the value being decoded.

Noncanonical

Message is not canonically encoded.

MalformedOid

Malformed OID

Overflow

Integer overflow occurred (library bug!).

Overlength

Message is longer than this library’s internal limits support.

TrailingData

Undecoded trailing data at end of message.

Fields of TrailingData

decoded: Length

Length of the decoded data.

remaining: Length

Total length of the remaining data left in the buffer.

Truncated

Unexpected end-of-message/nested field when decoding.

Underlength

Encoded message is shorter than the expected length.

(i.e. an Encodable impl on a particular type has a buggy encoded_len)

Fields of Underlength

expected: Length

Expected length

actual: Length

Actual length

UnexpectedTag

Unexpected tag.

Fields of UnexpectedTag

expected: Option<Tag>

Tag the decoder was expecting (if there is a single such tag).

None if multiple tags are expected/allowed, but the actual tag does not match any of them.

actual: Tag

Actual tag encountered in the message.

UnknownOid

This is supported on crate feature oid only.

Unknown OID.

This error is intended to be used by libraries which parse DER-based formats which encounter unknown or unsupported OID libraries.

It enables passing back the OID value to the caller, which allows them to determine which OID(s) are causing the error (and then potentially contribute upstream support for algorithms they care about).

Fields of UnknownOid

oid: ObjectIdentifier

OID value that was unrecognized by a parser for a DER-based format.

UnknownTag

Unknown/unsupported tag.

Fields of UnknownTag

byte: u8

Raw byte value of the tag.

Utf8(Utf8Error)

UTF-8 errors.

Value

Unexpected value.

Fields of Value

tag: Tag

Tag of the unexpected value.

Implementations

impl ErrorKind

pub fn at(self, position: Length) -> Error

Annotate an ErrorKind with context about where it occurred, returning an error.

Trait Implementations

impl Clone for ErrorKind

fn clone(&self) -> ErrorKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ErrorKind

impl Debug for ErrorKind

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

Formats the value using the given formatter.

impl Display for ErrorKind

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

Formats the value using the given formatter.

impl Eq for ErrorKind

impl Error for ErrorKind

pub fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

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

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<ErrorKind> for Error

fn from(kind: ErrorKind) -> Error

Performs the conversion.

impl PartialEq<ErrorKind> for ErrorKind

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for ErrorKind

impl StructuralPartialEq for ErrorKind