Struct Key 

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

Implementations

impl Key

pub fn root() -> Self

The root, which every key is under and which is no bytes at all.

pub fn from_bytes(bytes: &[u8]) -> Self

A key as a store hands it back.

Takes the bytes as they are; Key::path is where a key that this type did not write is refused, because that is where the answer has somewhere to go.

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

pub fn is_root(&self) -> bool

pub fn path(&self) -> Result<StorePath, StorePathError>

The path this key spells.

Refuses what this type does not write: bytes that are not text, a level left unterminated, and an escape that escapes nothing. Reading any of those leniently would let two keys name one path.

pub fn under(&self, prefix: &Key) -> bool

Whether this key names prefix or something under it.

One test, because a level’s terminator cannot occur inside a level: a key under pot starts with pot\0, potato does not, and there is no third answer for a caller to filter afterwards.

pub fn subtree(&self) -> (&[u8], Option<KeyBytes>)

The half-open range this key’s subtree occupies, both ends exact. The root has no top.

The top is this key with its last byte raised, which reaches everything under it because that byte is a terminator - the lowest there is, so raising it lands past every level the key could hold and short of its next sibling.

Trait Implementations

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 Eq for Key

impl From<&StorePath> for Key

fn from(path: &StorePath) -> 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.

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 Key

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

Equality operator ==.

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

Inequality operator !=.

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 StructuralPartialEq for Key