Struct Key 

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

A key in the projection store.

Keys are arbitrary byte sequences up to MAX_KEY_LENGTH bytes. They are compared lexicographically for B+tree ordering.

Implementations

impl Key

pub fn new(data: impl Into<Bytes>) -> Self

Creates a new key from bytes.

Panics

Debug builds panic if the key exceeds MAX_KEY_LENGTH.

pub fn from_static(data: &'static [u8]) -> Self

Creates a key from a static byte slice.

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

Returns the key as a byte slice.

pub fn len(&self) -> usize

Returns the length of the key in bytes.

pub fn is_empty(&self) -> bool

Returns true if the key is empty.

pub fn into_bytes(self) -> Bytes

Returns the underlying Bytes.

pub fn min() -> Self

The minimum possible key (empty).

pub fn max() -> Self

The maximum possible key (all 0xFF bytes at max length).

Trait Implementations

impl AsRef<[u8]> for Key

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

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

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Key

Returns the “default value” for a type.

impl Display for Key

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

Formats the value using the given formatter.

impl From<&[u8]> for Key

fn from(data: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Key

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Bytes> for Key

fn from(data: Bytes) -> Self

Converts to this type from the input type.

impl From<String> for Key

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Key

fn from(data: Vec<u8>) -> Self

Converts to this type from the input type.

impl Hash for Key

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 Key

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

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

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

impl StructuralPartialEq for Key