Enum CanonicalKey 

pub enum CanonicalKey {
    Null,
    Boolean(bool),
    Signed(CanonicalKeyFamily, i64),
    Unsigned(CanonicalKeyFamily, u64),
    Float(u64),
    Text(CanonicalKeyFamily, Arc<str>),
    Bytes(CanonicalKeyFamily, Vec<u8>),
    PairTextU64(CanonicalKeyFamily, String, u64),
    PairTextText(CanonicalKeyFamily, String, String),
    PairU32U8(CanonicalKeyFamily, u32, u8),
    PairU32U32(CanonicalKeyFamily, u32, u32),
    PairI32I32(CanonicalKeyFamily, i32, i32),
}

Canonical multi-type key used by ordered in-memory indexes.

The ordering is stable and type-aware. Different families never compare equal and range pushdown is only enabled when a column stays within one family. Exact point lookups remain safe even when a column has mixed families because BTree point seeks are still exact on the encoded key.

Variants

Null

Boolean(bool)

Signed(CanonicalKeyFamily, i64)

Unsigned(CanonicalKeyFamily, u64)

Float(u64)

Text(CanonicalKeyFamily, Arc<str>)

Text-kind values. Arc<str> instead of String so Value::Text(Arc<str>) roundtrips free (Arc bump) rather than allocating a new String per encode. Text-like variants built from String (NodeRef, EdgeRef, Email, Url, TableRef, Password) pay one Arc::from allocation at encode time — same cost as the previous String clone. Net: GROUP BY over a TEXT column stops paying N allocations per scan.

Bytes(CanonicalKeyFamily, Vec<u8>)

PairTextU64(CanonicalKeyFamily, String, u64)

PairTextText(CanonicalKeyFamily, String, String)

PairU32U8(CanonicalKeyFamily, u32, u8)

PairU32U32(CanonicalKeyFamily, u32, u32)

PairI32I32(CanonicalKeyFamily, i32, i32)

Implementations

impl CanonicalKey

pub fn family(&self) -> CanonicalKeyFamily

pub fn into_value(self) -> Value

Trait Implementations

impl Clone for CanonicalKey

fn clone(&self) -> CanonicalKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalKey

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

Formats the value using the given formatter.

impl Hash for CanonicalKey

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 CanonicalKey

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

impl PartialEq for CanonicalKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CanonicalKey

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

impl StructuralPartialEq for CanonicalKey