Struct DocumentKey 

pub struct DocumentKey {
    pub pk: PrimaryKey,
    pub sk: SortKey,
}

Fields

pk: PrimaryKey

sk: SortKey

Implementations

impl DocumentKey

pub fn new(pk: impl Into<Vec<u8>>, sk: impl Into<Vec<u8>>) -> Self

pub fn from_parts(pk: PrimaryKey, sk: SortKey) -> Self

pub fn encode(&self) -> Vec<u8>

Encodes (pk, sk) as two escaped components.

A zero byte in a component is encoded as 00 FF; the component terminator is 00 00. This makes both arbitrary binary data and empty components order-preserving under bytewise lexicographic comparison.

pub fn encoded_len(&self) -> usize

Returns the length of the canonical encoding without allocating it.

pub fn decode(encoded: &[u8]) -> Result<Self, KeyCodecError>

Decodes the exact canonical encoding produced by Self::encode.

Trait Implementations

impl Clone for DocumentKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentKey

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

Formats the value using the given formatter.

impl Eq for DocumentKey

impl Hash for DocumentKey

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 Ord for DocumentKey

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for DocumentKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DocumentKey

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for DocumentKey