Enum Value 

#[non_exhaustive]
pub enum Value {
    Null,
    Bool(bool),
    Int(i64),
    Float(f64),
    String(String),
    Bytes(Vec<u8>),
    List(Vec<Value>),
    Map(HashMap<String, Value>),
    Node(Node),
    Edge(Edge),
    Path(Path),
    Vector(Vec<f32>),
    Temporal(TemporalValue),
}

Dynamic value type for properties, parameters, and results.

Preserves the distinction between integers and floats, and includes graph-specific variants for nodes, edges, paths, and vectors.

Note: Eq and Hash are implemented manually to support using Value as HashMap keys. Floats are compared/hashed by their bit representation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Null

JSON/Cypher null.

Bool(bool)

Boolean value.

Int(i64)

64-bit signed integer.

Float(f64)

64-bit floating-point number.

String(String)

UTF-8 string.

Bytes(Vec<u8>)

Raw byte buffer.

List(Vec<Value>)

Ordered list of values.

Map(HashMap<String, Value>)

String-keyed map of values.

Node(Node)

Graph node with VID, label, and properties.

Edge(Edge)

Graph edge with EID, type, endpoints, and properties.

Path(Path)

Graph path (alternating nodes and edges).

Vector(Vec<f32>)

Dense float vector for similarity search.

Temporal(TemporalValue)

Typed temporal value (date, time, datetime, duration).

Implementations

impl Value

pub fn is_null(&self) -> bool

Returns true if this value is Null.

pub fn as_bool(&self) -> Option<bool>

Returns the boolean if this is Bool, otherwise None.

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

Returns the integer if this is Int, otherwise None.

pub fn as_u64(&self) -> Option<u64>

Returns the integer as u64 if this is a non-negative Int, otherwise None.

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

Returns a float, coercing Int to f64 if needed.

Returns None for non-numeric variants.

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

Returns the string slice if this is String, otherwise None.

pub fn is_i64(&self) -> bool

Returns true if this is Int.

pub fn is_f64(&self) -> bool

Returns true if this is Float (not Int).

pub fn is_string(&self) -> bool

Returns true if this is String.

pub fn is_number(&self) -> bool

Returns true if this is Int or Float.

pub fn as_array(&self) -> Option<&Vec<Value>>

Returns the list if this is List, otherwise None.

pub fn as_object(&self) -> Option<&HashMap<String, Value>>

Returns the map if this is Map, otherwise None.

pub fn is_bool(&self) -> bool

Returns true if this is Bool.

pub fn is_list(&self) -> bool

Returns true if this is List.

pub fn is_map(&self) -> bool

Returns true if this is Map.

pub fn get(&self, key: &str) -> Option<&Value>

Gets a value by key if this is a Map.

Returns None if not a map or key doesn’t exist.

pub fn is_temporal(&self) -> bool

Returns true if this is a Temporal value.

pub fn as_temporal(&self) -> Option<&TemporalValue>

Returns the temporal value reference if this is Temporal, otherwise None.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

fn deserialize<__D>( __deserializer: __D, ) -> Result<Value, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl From<&str> for Value

fn from(v: &str) -> Value

Converts to this type from the input type.

impl From<String> for Value

fn from(v: String) -> Value

Converts to this type from the input type.

impl From<Value> for Value

fn from(v: Value) -> Value

Converts to this type from the input type.

impl From<Vec<f32>> for Value

fn from(v: Vec<f32>) -> Value

Converts to this type from the input type.

impl From<bool> for Value

fn from(v: bool) -> Value

Converts to this type from the input type.

impl From<f32> for Value

fn from(v: f32) -> Value

Converts to this type from the input type.

impl From<f64> for Value

fn from(v: f64) -> Value

Converts to this type from the input type.

impl From<i32> for Value

fn from(v: i32) -> Value

Converts to this type from the input type.

impl From<i64> for Value

fn from(v: i64) -> Value

Converts to this type from the input type.

impl From<u64> for Value

fn from(v: u64) -> Value

Converts to this type from the input type.

impl From<usize> for Value

fn from(v: usize) -> Value

Converts to this type from the input type.

impl Hash for Value

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 PartialEq for Value

fn eq(&self, other: &Value) -> 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 Serialize for Value

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Value> for Edge

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Edge, <Edge as TryFrom<&Value>>::Error>

Performs the conversion.

impl TryFrom<&Value> for Node

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Node, <Node as TryFrom<&Value>>::Error>

Performs the conversion.

impl TryFrom<&Value> for Path

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Path, <Path as TryFrom<&Value>>::Error>

Performs the conversion.

impl TryFrom<&Value> for String

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<String, <String as TryFrom<&Value>>::Error>

Performs the conversion.

impl<T> TryFrom<&Value> for Vec<T>

where T: for<'a> TryFrom<&'a Value, Error = UniError>,

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Vec<T>, <Vec<T> as TryFrom<&Value>>::Error>

Performs the conversion.

impl TryFrom<&Value> for Vec<f32>

type Error = UniError

The type returned in the event of a conversion error.

fn try_from( value: &Value, ) -> Result<Vec<f32>, <Vec<f32> as TryFrom<&Value>>::Error>

Performs the conversion.

impl TryFrom<&Value> for bool

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<bool, <bool as TryFrom<&Value>>::Error>

Performs the conversion.

impl TryFrom<Value> for Edge

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Edge, <Edge as TryFrom<Value>>::Error>

Performs the conversion.

impl TryFrom<Value> for Node

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Node, <Node as TryFrom<Value>>::Error>

Performs the conversion.

impl TryFrom<Value> for Path

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Path, <Path as TryFrom<Value>>::Error>

Performs the conversion.

impl TryFrom<Value> for String

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<String, <String as TryFrom<Value>>::Error>

Performs the conversion.

impl<T> TryFrom<Value> for Vec<T>

where T: TryFrom<Value, Error = UniError>,

type Error = UniError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Value> for Vec<f32>

type Error = UniError

The type returned in the event of a conversion error.

fn try_from( value: Value, ) -> Result<Vec<f32>, <Vec<f32> as TryFrom<Value>>::Error>

Performs the conversion.

impl TryFrom<Value> for bool

type Error = UniError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<bool, <bool as TryFrom<Value>>::Error>

Performs the conversion.

impl Eq for Value

impl StructuralPartialEq for Value