Trait ToOrderableBytes 

pub trait ToOrderableBytes {
    type Bytes: AsRef<[u8]>;

    const ENCODED_LEN: usize;

    // Required method
    fn to_orderable_bytes(&self) -> Self::Bytes;
}

Maps a value to its canonical, order-preserving fixed-length byte encoding.

Implementors guarantee, for any a and b of the implementing type:

• Equality: byte equality of the outputs agrees with the type’s value equality (a.to_orderable_bytes() == b.to_orderable_bytes() iff a == b).
• Order: byte-wise lexicographic comparison of the outputs agrees with the type’s natural total order (a.to_orderable_bytes() <= b.to_orderable_bytes() iff a <= b).

The encoded length is fixed per type and exposed via ENCODED_LEN. Per-type modules also re-export the same value as a free pub const for use in const contexts where naming the impl would be unwieldy.

Required Associated Constants

const ENCODED_LEN: usize

Length, in bytes, of the canonical encoding produced by to_orderable_bytes.

Required Associated Types

type Bytes: AsRef<[u8]>

The fixed-length byte array type returned by to_orderable_bytes. By convention every impl sets this to [u8; Self::ENCODED_LEN]; the indirection through an associated type is only needed because stable Rust does not yet allow naming [u8; Self::ENCODED_LEN] directly in a method signature (that requires feature(generic_const_exprs)).

Required Methods

fn to_orderable_bytes(&self) -> Self::Bytes

Build the canonical, order-preserving fixed-length byte encoding of self.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl ToOrderableBytes for bool

const ENCODED_LEN: usize = 1

type Bytes = [u8; 1]

fn to_orderable_bytes(&self) -> [u8; 1]

impl ToOrderableBytes for char

const ENCODED_LEN: usize = 4

type Bytes = [u8; 4]

fn to_orderable_bytes(&self) -> [u8; 4]

impl ToOrderableBytes for f32

const ENCODED_LEN: usize = 4

type Bytes = [u8; 4]

fn to_orderable_bytes(&self) -> [u8; 4]

impl ToOrderableBytes for f64

const ENCODED_LEN: usize = 8

type Bytes = [u8; 8]

fn to_orderable_bytes(&self) -> [u8; 8]

impl ToOrderableBytes for i8

const ENCODED_LEN: usize = 1

type Bytes = [u8; 1]

fn to_orderable_bytes(&self) -> [u8; 1]

impl ToOrderableBytes for i16

const ENCODED_LEN: usize = 2

type Bytes = [u8; 2]

fn to_orderable_bytes(&self) -> [u8; 2]

impl ToOrderableBytes for i32

const ENCODED_LEN: usize = 4

type Bytes = [u8; 4]

fn to_orderable_bytes(&self) -> [u8; 4]

impl ToOrderableBytes for i64

const ENCODED_LEN: usize = 8

type Bytes = [u8; 8]

fn to_orderable_bytes(&self) -> [u8; 8]

impl ToOrderableBytes for i128

const ENCODED_LEN: usize = 16

type Bytes = [u8; 16]

fn to_orderable_bytes(&self) -> [u8; 16]

impl ToOrderableBytes for u8

const ENCODED_LEN: usize = 1

type Bytes = [u8; 1]

fn to_orderable_bytes(&self) -> [u8; 1]

impl ToOrderableBytes for u16

const ENCODED_LEN: usize = 2

type Bytes = [u8; 2]

fn to_orderable_bytes(&self) -> [u8; 2]

impl ToOrderableBytes for u32

const ENCODED_LEN: usize = 4

type Bytes = [u8; 4]

fn to_orderable_bytes(&self) -> [u8; 4]

impl ToOrderableBytes for u64

const ENCODED_LEN: usize = 8

type Bytes = [u8; 8]

fn to_orderable_bytes(&self) -> [u8; 8]

impl ToOrderableBytes for u128

const ENCODED_LEN: usize = 16

type Bytes = [u8; 16]

fn to_orderable_bytes(&self) -> [u8; 16]

Implementors