Struct TokenTermKey 

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

A tagged term key: zero plus UTF-8, or one plus big-endian UTF-16 containing unpaired units.

Scalar text has exactly one representation, including supplementary characters and the empty string. Byte ordering is the persistent vocabulary order; it is not linguistic collation. Field/table names remain separate key components.

Implementations

impl TokenTermKey

pub fn from_text_budgeted<E: From<MemoryError>>( text: &str, budget: &MemoryBudget, poll: impl FnMut() -> Result<(), E>, ) -> Result<Budgeted<Self>, E>

Encode borrowed scalar text with a reserved complete key buffer and bounded callback checks.

pub fn from_term_budgeted<E: From<MemoryError>>( term: &TokenTerm, budget: &MemoryBudget, poll: impl FnMut() -> Result<(), E>, ) -> Result<Budgeted<Self>, E>

Preserve canonical scalar/raw identity while reserving the key alongside its source term.

pub fn clone_budgeted<E: From<MemoryError>>( &self, budget: &MemoryBudget, poll: impl FnMut() -> Result<(), E>, ) -> Result<Budgeted<Self>, E>

Copy a validated key into a separately reserved buffer without reinterpreting its bytes.

pub fn cmp_with_control<E>( &self, other: &Self, poll: &mut dyn FnMut() -> Result<(), E>, ) -> Result<Ordering, E>

Compare persistent vocabulary order while checking long common prefixes in bounded chunks.

impl TokenTermKey

pub fn from_text(text: &str) -> Self

pub fn from_term(term: &TokenTerm) -> Self

pub fn from_bytes(bytes: Vec<u8>) -> StorageBackendResult<Self>

pub fn as_str(&self) -> Option<&str>

Borrow scalar text when this key contains a valid Unicode string.

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

pub fn into_bytes(self) -> Vec<u8>

pub fn to_term(&self) -> TokenTerm

Trait Implementations

impl Clone for TokenTermKey

fn clone(&self) -> TokenTermKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenTermKey

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

Formats the value using the given formatter.

impl Eq for TokenTermKey

impl From<&str> for TokenTermKey

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for TokenTermKey

fn from(text: String) -> Self

Converts to this type from the input type.

impl Hash for TokenTermKey

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 TokenTermKey

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TokenTermKey

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