Struct DbKey 

pub struct DbKey { /* private fields */ }

Implementations

impl DbKey

pub fn new<TKey>(prefix: &[u8], key: TKey) -> Self

where TKey: Clone + AsRef<[u8]>,

pub fn new_with_bucket<TKey, TBucket>( prefix: &[u8], bucket: TBucket, key: TKey, ) -> Self

where TKey: Clone + AsRef<[u8]>, TBucket: Copy + AsRef<[u8]>,

pub fn new_with_suffix<TKey, TSuffix>( prefix: &[u8], key: TKey, suffix: TSuffix, ) -> Self

where TKey: Clone + AsRef<[u8]>, TSuffix: AsRef<[u8]>,

Convenience constructor: [prefix || key || suffix]. The suffix bytes sit after the logical key and are not counted toward prefix_len — see DbKey::add_suffix for the rationale.

pub fn prefix_only(prefix: &[u8]) -> Self

pub fn add_bucket<TBucket>(&mut self, bucket: TBucket)

where TBucket: Copy + AsRef<[u8]>,

add a bucket to the DBkey, this adds to the prefix length

pub fn add_key<TKey>(&mut self, key: TKey)

where TKey: Clone + AsRef<[u8]>,

pub fn add_suffix<TSuffix>(&mut self, suffix: TSuffix)

where TSuffix: AsRef<[u8]>,

Append bytes after the logical key without changing prefix_len.

Unlike DbKey::add_bucket and DbKey::add_key — both of which sit conceptually in front of the row key and therefore grow prefix_len — a suffix is part of the row key itself (for example a version byte appended to a versioned store’s keys). prefix_len must continue to reflect only the store/bucket path so that iterator helpers that strip the prefix see the correct boundary.

pub fn prefix_len(&self) -> usize

Trait Implementations

impl AsRef<[u8]> for DbKey

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

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

impl Clone for DbKey

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 DbKey

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

Formats the value using the given formatter.

impl Display for DbKey

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

Formats the value using the given formatter.