Enum KeyOrder 

#[non_exhaustive]
pub enum KeyOrder {
    Bytewise,
    LengthFirst,
}

The map key ordering used by deterministic encoding.

RFC 8949 defines two deterministic key orderings. They agree whenever all keys encode to the same length, but differ otherwise: for example, 100 (0x1864) sorts after -1 (0x20) bytewise, but before it length-first.

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.

Bytewise

Bytewise lexicographic order of the keys’ deterministic encodings.

This is the order required by the core deterministic encoding requirements (RFC 8949 §4.2.1) and is the recommended choice for new protocols; COSE (RFC 9052) and friends use it.

LengthFirst

Length-first order: keys with shorter encodings sort earlier, and keys of equal length sort bytewise.

This is the “Canonical CBOR” ordering of RFC 7049 §3.9, kept in RFC 8949 §4.2.3 for backwards compatibility. Use it to interoperate with protocols and implementations built on the older rule (for example, ciborium’s canonical module).

Trait Implementations

impl Clone for KeyOrder

fn clone(&self) -> KeyOrder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyOrder

impl Debug for KeyOrder

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

Formats the value using the given formatter.

impl Default for KeyOrder

fn default() -> KeyOrder

Returns the “default value” for a type.

impl Eq for KeyOrder

impl Hash for KeyOrder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeyOrder

fn eq(&self, other: &KeyOrder) -> 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 KeyOrder