Struct EncodedIndexKey 

pub struct EncodedIndexKey(/* private fields */);

The byte representation of a single field encoded under the order-preserving format documented in docs/format.md.

Strongly-typed wrapper around Vec<u8> so the caller cannot confuse an encoded key with a raw user value. The inner bytes can be borrowed via as_bytes and consumed via into_bytes.

Implementations

impl EncodedIndexKey

pub fn as_bytes(&self) -> &[u8]

View as a byte slice.

pub fn into_bytes(self) -> Vec<u8>

Consume the wrapper and return the inner Vec<u8>.

pub fn from_bytes(bytes: Vec<u8>) -> Self

Construct from raw bytes. Used by the maintenance path when it composes an encoded user key with the trailing Id suffix.

pub fn len(&self) -> usize

Length of the encoded bytes.

pub fn is_empty(&self) -> bool

true if the encoded bytes are empty.

Trait Implementations

impl AsRef<[u8]> for EncodedIndexKey

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for EncodedIndexKey

fn clone(&self) -> EncodedIndexKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncodedIndexKey

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

Formats the value using the given formatter.

impl From<EncodedIndexKey> for Vec<u8>

fn from(k: EncodedIndexKey) -> Self

Converts to this type from the input type.

impl Hash for EncodedIndexKey

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 EncodedIndexKey

fn cmp(&self, other: &EncodedIndexKey) -> 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.

impl PartialEq for EncodedIndexKey

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

fn partial_cmp(&self, other: &EncodedIndexKey) -> 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 Eq for EncodedIndexKey

impl StructuralPartialEq for EncodedIndexKey