Skip to main content

OrderableValue

Enum OrderableValue 

Source
pub enum OrderableValue {
    Int64(i64),
    Float64(OrderedFloat64),
    String(ArcStr),
    Bool(bool),
    Timestamp(Timestamp),
}
Expand description

An orderable wrapper around Value for use in B-tree indexes and range queries.

Value itself cannot implement Ord because f64 doesn’t implement Ord (due to NaN). This wrapper provides total ordering for comparable value types, enabling use in BTreeMap, BTreeSet, and range queries.

§Supported Types

  • Int64 - standard integer ordering
  • Float64 - total ordering (NaN treated as greater than all other values)
  • String - lexicographic ordering
  • Bool - false < true
  • Timestamp - chronological ordering

Other types (Null, Bytes, List, Map) return None from try_from.

§Examples

use grafeo_common::types::{OrderableValue, Value};
use std::collections::BTreeSet;

let mut set = BTreeSet::new();
set.insert(OrderableValue::try_from(&Value::Int64(30)).unwrap());
set.insert(OrderableValue::try_from(&Value::Int64(10)).unwrap());
set.insert(OrderableValue::try_from(&Value::Int64(20)).unwrap());

// Iterates in sorted order: 10, 20, 30
let values: Vec<_> = set.iter().map(|v| v.as_i64().unwrap()).collect();
assert_eq!(values, vec![10, 20, 30]);

Variants§

§

Int64(i64)

64-bit signed integer

§

Float64(OrderedFloat64)

64-bit floating point with total ordering (NaN > everything)

§

String(ArcStr)

UTF-8 string

§

Bool(bool)

Boolean value (false < true)

§

Timestamp(Timestamp)

Timestamp (microseconds since epoch)

Implementations§

Source§

impl OrderableValue

Source

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

Attempts to create an OrderableValue from a Value.

Returns None for types that don’t have a natural ordering (Null, Bytes, List, Map).

Source

pub fn into_value(self) -> Value

Converts this OrderableValue back to a Value.

Source

pub const fn as_i64(&self) -> Option<i64>

Returns the value as an i64, if it’s an Int64.

Source

pub const fn as_f64(&self) -> Option<f64>

Returns the value as an f64, if it’s a Float64.

Source

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

Returns the value as a string slice, if it’s a String.

Trait Implementations§

Source§

impl Clone for OrderableValue

Source§

fn clone(&self) -> OrderableValue

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OrderableValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for OrderableValue

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for OrderableValue

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for OrderableValue

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for OrderableValue

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Eq for OrderableValue

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.