Enum Value 

pub enum Value {
    Null,
    Bool(bool),
    Int64(i64),
    Float64(f64),
    String(ArcStr),
    Bytes(Arc<[u8]>),
    Timestamp(Timestamp),
    Date(Date),
    Time(Time),
    Duration(Duration),
    ZonedDatetime(ZonedDatetime),
    List(Arc<[Value]>),
    Map(Arc<BTreeMap<PropertyKey, Value>>),
    Vector(Arc<[f32]>),
    Path {
        nodes: Arc<[Value]>,
        edges: Arc<[Value]>,
    },
}

A dynamically-typed property value.

Nodes and edges can have properties of various types - this enum holds them all. Follows the GQL type system, so you can store nulls, booleans, numbers, strings, timestamps, lists, and maps.

Examples

use grafeo_common::types::Value;

let name = Value::from("Alice");
let age = Value::from(30i64);
let active = Value::from(true);

// Check types
assert!(name.as_str().is_some());
assert_eq!(age.as_int64(), Some(30));

Variants

Null

Null/missing value

Bool(bool)

Boolean value

Int64(i64)

64-bit signed integer

Float64(f64)

64-bit floating point

String(ArcStr)

UTF-8 string (uses ArcStr for cheap cloning)

Bytes(Arc<[u8]>)

Binary data

Timestamp(Timestamp)

Timestamp with timezone

Date(Date)

Calendar date (days since 1970-01-01)

Time(Time)

Time of day with optional UTC offset

Duration(Duration)

ISO 8601 duration (months, days, nanos)

ZonedDatetime(ZonedDatetime)

Datetime with a fixed UTC offset

List(Arc<[Value]>)

Ordered list of values

Map(Arc<BTreeMap<PropertyKey, Value>>)

Key-value map (uses BTreeMap for deterministic ordering)

Vector(Arc<[f32]>)

Fixed-size vector of 32-bit floats for embeddings.

Uses f32 for 4x compression vs f64. Arc for cheap cloning. Dimension is implicit from length. Common dimensions: 384, 768, 1536.

Path

Graph path: alternating sequence of nodes and edges.

Nodes and edges are stored as lists of values (typically node/edge maps with _id, _labels/_type, and properties). The invariant is that edges.len() == nodes.len() - 1 for a valid path.

Fields

nodes: Arc<[Value]>

Nodes along the path, from source to target.

edges: Arc<[Value]>

Edges along the path, connecting consecutive nodes.

Implementations

impl Value

pub const fn is_null(&self) -> bool

Returns true if this value is null.

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

Returns the boolean value if this is a Bool, otherwise None.

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

Returns the integer value if this is an Int64, otherwise None.

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

Returns the float value if this is a Float64, otherwise None.

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

Returns the string value if this is a String, otherwise None.

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

Returns the bytes value if this is Bytes, otherwise None.

pub const fn as_timestamp(&self) -> Option<Timestamp>

Returns the timestamp value if this is a Timestamp, otherwise None.

pub const fn as_date(&self) -> Option<Date>

Returns the date value if this is a Date, otherwise None.

pub const fn as_time(&self) -> Option<Time>

Returns the time value if this is a Time, otherwise None.

pub const fn as_duration(&self) -> Option<Duration>

Returns the duration value if this is a Duration, otherwise None.

pub const fn as_zoned_datetime(&self) -> Option<ZonedDatetime>

Returns the zoned datetime value if this is a ZonedDatetime, otherwise None.

pub fn as_list(&self) -> Option<&[Value]>

Returns the list value if this is a List, otherwise None.

pub fn as_map(&self) -> Option<&BTreeMap<PropertyKey, Value>>

Returns the map value if this is a Map, otherwise None.

pub fn as_vector(&self) -> Option<&[f32]>

Returns the vector if this is a Vector, otherwise None.

pub fn as_path(&self) -> Option<(&[Value], &[Value])>

Returns the path components if this is a Path, otherwise None.

pub const fn is_vector(&self) -> bool

Returns true if this is a vector type.

pub fn vector_dimensions(&self) -> Option<usize>

Returns the vector dimensions if this is a Vector.

pub const fn type_name(&self) -> &'static str

Returns the type name of this value.

pub fn serialize(&self) -> Result<Vec<u8>, EncodeError>

Serializes this value to bytes.

Errors

Returns an error if the value cannot be encoded (e.g. deeply nested structures).

pub fn deserialize(bytes: &[u8]) -> Result<Self, DecodeError>

Deserializes a value from bytes.

Errors

Returns an error if the bytes do not represent a valid Value.

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl From<&[f32]> for Value

fn from(v: &[f32]) -> Self

Converts to this type from the input type.

impl From<&[u8]> for Value

fn from(b: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Value

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Arc<[f32]>> for Value

fn from(v: Arc<[f32]>) -> Self

Converts to this type from the input type.

impl From<ArcStr> for Value

fn from(s: ArcStr) -> Self

Converts to this type from the input type.

impl From<Date> for Value

fn from(d: Date) -> Self

Converts to this type from the input type.

impl From<Duration> for Value

fn from(d: Duration) -> Self

Converts to this type from the input type.

impl From<HashableValue> for Value

fn from(hv: HashableValue) -> Self

Converts to this type from the input type.

impl<T: Into<Value>> From<Option<T>> for Value

fn from(opt: Option<T>) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Time> for Value

fn from(t: Time) -> Self

Converts to this type from the input type.

impl From<Timestamp> for Value

fn from(t: Timestamp) -> Self

Converts to this type from the input type.

impl From<Value> for HashableValue

fn from(value: Value) -> Self

Converts to this type from the input type.

impl<T: Into<Value>> From<Vec<T>> for Value

fn from(v: Vec<T>) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Value

fn from(b: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<ZonedDatetime> for Value

fn from(zdt: ZonedDatetime) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(f: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(f: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(i: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(i: i64) -> Self

Converts to this type from the input type.

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Value> for OrderableValue

fn try_from(value: &Value) -> Result<Self, Self::Error>

Attempts to create an OrderableValue from a Value.

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

type Error = ()

The type returned in the event of a conversion error.

impl StructuralPartialEq for Value