Skip to main content

CanonError

Enum CanonError 

Source
#[non_exhaustive]
pub enum CanonError {
Show 13 variants Truncated { offset: usize, needed: usize, }, TrailingData { count: usize, }, NonShortestInteger { offset: usize, value: u64, used: usize, }, IndefiniteLength { offset: usize, }, Float { offset: usize, }, NonTextKey { offset: usize, }, DuplicateKey { offset: usize, key: String, }, UnsortedKeys { offset: usize, previous: String, current: String, }, InvalidUtf8 { offset: usize, }, NotNfc { offset: usize, text: String, }, Unsupported { offset: usize, detail: &'static str, }, TooDeep { offset: usize, limit: usize, }, TooLarge { size: usize, limit: usize, },
}
Expand description

A way in which bytes failed the canonical serialization profile.

Section 4.1 requires an implementation to reject non-canonical bytes rather than repair them, so every variant here is a hard failure. The variants are distinct because the command-line tools name the violated rule on stderr, and the conformance scenarios assert on that name.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Truncated

Input ended in the middle of an item.

Fields

§offset: usize

Byte offset where the shortfall was detected.

§needed: usize

How many further bytes the item required.

§

TrailingData

Bytes remained after a complete top-level item.

Fields

§count: usize

Number of unconsumed bytes.

§

NonShortestInteger

An item’s argument – an integer, a length, or a simple value such as null – used a longer encoding than necessary.

Fields

§offset: usize

Byte offset of the item’s head.

§value: u64

The decoded argument.

§used: usize

Additional bytes the encoder used for the argument.

§

IndefiniteLength

An indefinite-length string, array, or map was present.

Fields

§offset: usize

Byte offset of the item’s head.

§

Float

A floating point value was present.

Fields

§offset: usize

Byte offset of the item’s head.

§

NonTextKey

A map key was not a text string.

Fields

§offset: usize

Byte offset of the offending key.

§

DuplicateKey

Two map keys were equal.

Fields

§offset: usize

Byte offset of the repeated key.

§key: String

The repeated key.

§

UnsortedKeys

Map keys were not in ascending UTF-8 byte order.

Fields

§offset: usize

Byte offset of the out-of-order key.

§previous: String

The preceding key.

§current: String

The key that should have come first.

§

InvalidUtf8

A text string was not valid UTF-8.

Fields

§offset: usize

Byte offset of the string’s contents.

§

NotNfc

A text string was not in Unicode Normalization Form C.

Fields

§offset: usize

Byte offset of the string’s contents.

§text: String

The offending text.

§

Unsupported

A major type or simple value outside the profile was present.

Fields

§offset: usize

Byte offset of the item’s head.

§detail: &'static str

What was encountered.

§

TooDeep

Nesting exceeded the implementation limit.

Fields

§offset: usize

Byte offset where the limit was reached.

§limit: usize

The configured limit.

§

TooLarge

The item was larger than Section 4.5 permits.

Fields

§size: usize

Size of the input.

§limit: usize

The configured ceiling.

Implementations§

Source§

impl CanonError

Source

pub fn rule(&self) -> &'static str

The short rule name this violation maps to.

Stable across releases: the conformance scenarios match on it.

§Example
use publet_core::cbor::decode;

let error = decode(&[0xa2, 0x61, b'b', 0x01, 0x61, b'a', 0x02]).unwrap_err(); // {"b": 1, "a": 2}
assert_eq!(error.rule(), "sorted map keys");

Trait Implementations§

Source§

impl Clone for CanonError

Source§

fn clone(&self) -> Self

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 CanonError

Source§

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

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

impl Display for CanonError

Source§

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

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

impl Eq for CanonError

Source§

impl Error for CanonError

1.30.0 · 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<CanonError> for ObjectError

Source§

fn from(source: CanonError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for CanonError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CanonError

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

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

fn try_from(value: U) -> Result<T, !>

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.