Struct StoreKeyPrefix 

pub struct StoreKeyPrefix { /* private fields */ }

A client-side namespace layered over raw Store keys.

The prefix prepends a fixed byte string to each physical Store key and stores the caller’s logical key in the remaining bytes. QMDB, SQL, and other higher-level instances continue to build their own logical keys as before; a prefixed StoreClient maps those keys on the wire and maps returned keys back before callers see them.

Implementations

impl StoreKeyPrefix

pub fn new(prefix: impl Into<Bytes>) -> Result<Self, StoreKeyPrefixError>

pub const fn identity() -> Self

The zero-width identity prefix: maps every logical key to itself, so encode/decode/range/match are all no-ops and keys pass through un-namespaced.

pub fn prefix(&self) -> &Bytes

The raw prefix bytes.

pub fn matches(&self, key: &[u8]) -> bool

True when key starts with this prefix. The identity prefix matches every key.

pub fn max_logical_key_len(&self) -> usize

Maximum logical key bytes available under this prefix.

pub fn encode_key(&self, key: &Key) -> Result<Key, StoreKeyPrefixError>

Encode a logical key into the physical Store keyspace. The identity prefix returns a refcount-only clone of key.

pub fn decode_key(&self, key: &Key) -> Result<Key, StoreKeyPrefixError>

Decode a physical Store key back into the logical keyspace as a zero-copy slice of key’s backing storage.

pub fn encode_range( &self, start: &Key, end: &Key, ) -> Result<(Key, Key), StoreKeyPrefixError>

Encode an inclusive logical range into the physical Store keyspace.

Empty end means unbounded in the logical keyspace and is narrowed to this prefix’s physical upper bound. Long logical upper bounds are clamped to the maximum logical key length representable under this prefix; this keeps scans over full-width prefix bounds (whose upper bound is intentionally MAX_KEY_LEN bytes) working.

Trait Implementations

impl Clone for StoreKeyPrefix

fn clone(&self) -> StoreKeyPrefix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoreKeyPrefix

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

Formats the value using the given formatter.

impl Eq for StoreKeyPrefix

impl Hash for StoreKeyPrefix

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 PartialEq for StoreKeyPrefix

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StoreKeyPrefix