Enum IndexKey 

pub enum IndexKey {
    Null,
    Bool(bool),
    UnsignedInt(u64),
    SignedInt(i64),
    Float(u64),
    Text(String),
}

The canonical, deterministic key one indexable JSON scalar maps to.

Determinism here is a correctness requirement, not a nicety: the same value must produce the same key across a process lifetime, a restart, and a rebuild, or a rebuilt index would answer differently from the live one. Every variant is derived from the value’s own contents — never from an address, an iteration order, or a hash seed.

Variants

Null

Bool(bool)

UnsignedInt(u64)

A serde_json positive integer, which is never equal to a float or a negative integer even when the arithmetic value would match.

SignedInt(i64)

A serde_json negative integer.

Float(u64)

A finite float, keyed by its bit pattern with -0.0 normalized to 0.0 because -0.0 == 0.0 holds for the predicate too.

Text(String)

Implementations

impl IndexKey

pub fn of(value: &Value) -> Option<Self>

The canonical key for a value, or None when the value is not indexable.

None is not a failure: it is how this module refuses to invent a representation for something it cannot compare exactly.

pub fn describe(&self) -> String

A stable textual rendering, for diagnostics and test comparison only. Nothing in execution depends on this form.

Trait Implementations

impl Clone for IndexKey

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 IndexKey

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

Formats the value using the given formatter.

impl Eq for IndexKey

impl Hash for IndexKey

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 IndexKey

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 IndexKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for IndexKey

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 IndexKey