Skip to main content

DecodeError

Enum DecodeError 

Source
pub enum DecodeError {
Show 27 variants Malformed, NotTagged, WrongTag { expected: u64, actual: u64, }, IndefiniteLength, NonMinimalEncoding, NonDeterministicEncoding, DuplicateLabel, UnknownLabel { label: i64, }, TextLabel, WrongType { label: i64, }, MissingHeader { label: i64, }, UnknownAlgorithm { alg: i64, }, CritMissing, CritIncomplete { label: i64, }, CritUnexpected { label: i64, }, ClaimsInUnprotected, UnknownClaim { claim: i64, }, FractionalTime, MissingClaim { claim: i64, }, RecipientCount { count: usize, }, NestedRecipients, RecipientCiphertextPresent, MissingPayload, EmbeddedNotEncrypt, EphemeralKeyShape, InvalidLength { label: i64, expected: usize, actual: usize, }, Identifier(ProfileError),
}
Expand description

Strict-decode rejection reasons.

The strict decoder rejects anything outside the profile: wrong or missing tags, indefinite lengths, non-deterministic encodings (RFC 8949 §4.2), duplicate or unknown labels, claims in unprotected headers, unknown codepoints, and malformed structure shapes.

Variants§

§

Malformed

The input is not well-formed CBOR (truncated, trailing garbage, or a structurally invalid item).

§

NotTagged

The top-level item is not tagged.

§

WrongTag

The top-level tag is not the expected COSE tag.

Fields

§expected: u64

The tag the profile requires here (18 or 96).

§actual: u64

The tag actually present.

§

IndefiniteLength

An indefinite-length item was encountered (forbidden by RFC 8949 §4.2).

§

NonMinimalEncoding

An integer/length header was not minimally encoded (RFC 8949 §4.2).

§

NonDeterministicEncoding

Re-encoding the decoded message did not reproduce the input bytes: the encoding is not the profile’s deterministic encoding.

§

DuplicateLabel

A map carried the same label twice.

§

UnknownLabel

A label appeared somewhere the profile does not allow it.

Fields

§label: i64

The offending label.

§

TextLabel

A text label was used; the profile is integer-labelled throughout.

§

WrongType

A known label carried the wrong CBOR type.

Fields

§label: i64

The label whose value had the wrong type.

§

MissingHeader

A required header parameter is absent.

Fields

§label: i64

The absent label.

§

UnknownAlgorithm

An algorithm codepoint outside the profile allow-set.

Fields

§alg: i64

The offending codepoint.

§

CritMissing

The crit header is absent on a layer that requires it.

§

CritIncomplete

A profile label is present but not listed in crit.

Fields

§label: i64

The unlisted label.

§

CritUnexpected

crit lists a label the profile does not place on this layer.

Fields

§label: i64

The offending label.

§

ClaimsInUnprotected

A claim was found in an unprotected header.

§

UnknownClaim

An unknown key appeared inside the CWT claims map.

Fields

§claim: i64

The offending CWT claim key.

§

FractionalTime

A CWT timestamp was fractional; the profile requires whole seconds.

§

MissingClaim

A required CWT claim is absent (iat = 6, cti = 7).

Fields

§claim: i64

The absent CWT claim key.

§

RecipientCount

The recipients array length is not exactly one.

Fields

§count: usize

The number of recipients actually present.

§

NestedRecipients

The recipient structure carries nested recipients.

§

RecipientCiphertextPresent

The recipient ciphertext is not nil; ECDH-ES direct key agreement carries no recipient ciphertext.

§

MissingPayload

The signed payload is absent (nil); detached payloads are not part of this profile.

§

EmbeddedNotEncrypt

A sealed message’s payload is not a tagged COSE_Encrypt.

§

EphemeralKeyShape

The ephemeral key is not an OKP/X25519 public key of the exact profile shape.

§

InvalidLength

A fixed-length field (ephemeral key, nonce, request hash) had the wrong length.

Fields

§label: i64

The label or field the length belongs to.

§expected: usize

The required length in bytes.

§actual: usize

The length actually supplied.

§

Identifier(ProfileError)

An identifier failed its newtype validation while decoding.

Trait Implementations§

Source§

impl Clone for DecodeError

Source§

fn clone(&self) -> DecodeError

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DecodeError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for DecodeError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DecodeError

Source§

impl Error for DecodeError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<DecodeError> for VerifyError

Source§

fn from(e: DecodeError) -> Self

Converts to this type from the input type.
Source§

impl From<DecodeError> for OpenError

Source§

fn from(e: DecodeError) -> Self

Converts to this type from the input type.
Source§

impl From<ProfileError> for DecodeError

Source§

fn from(e: ProfileError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for DecodeError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for DecodeError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.