Struct StorageKey 

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

The redb key a document row is stored under.

Fixed-width lowercase hex, so lexicographic order matches surrogate order and a range scan iterates rows in surrogate order with no extra index. Internal: a storage key never reaches a client.

Implementations

impl StorageKey

pub fn for_surrogate(surrogate: Surrogate) -> Self

Wrap surrogate as the key it is stored under. Allocation-free: the hex text is a rendering, produced only by Display or to_identity.

pub fn parse(key: &str) -> Option<Self>

Parse a redb key back into a StorageKey.

Returns None unless key is exactly 8 lowercase hex characters. This handles legacy non-surrogate document IDs gracefully: a value that fails to parse is not a minted storage key. Allocation-free.

pub fn surrogate(&self) -> Surrogate

Recover the surrogate this key encodes. Infallible and free: the surrogate IS the key, not something re-derived from stored text.

pub fn to_identity(&self) -> RowIdentity

The client-visible identity of the row stored under this key.

Allocates the decimal string — unavoidable, since a client never sees the hex encoding.

Trait Implementations

impl Clone for StorageKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StorageKey

impl Debug for StorageKey

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

Formats the value using the given formatter.

impl Display for StorageKey

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

The only place a surrogate becomes a storage key.

impl Eq for StorageKey

impl Hash for StorageKey

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 StorageKey

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StorageKey

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