Skip to main content

Value

Enum Value 

Source
#[non_exhaustive]
pub enum Value {
Show 21 variants Null, Bool(bool), Integer(i64), Float(f64), String(String), Bytes(Vec<u8>), Array(Vec<Value>), Object(HashMap<String, Value>), Uuid(String), Ulid(String), DateTime(NdbDateTime), NaiveDateTime(NdbDateTime), Duration(NdbDuration), Decimal(Decimal), Geometry(Geometry), Set(Vec<Value>), Regex(String), Range { start: Option<Box<Value>>, end: Option<Box<Value>>, inclusive: bool, }, Record { table: String, id: String, }, ArrayCell(ArrayCell), Vector(Arc<[f32]>),
}
Expand description

A dynamic value that can represent any field type in a document or any parameter in a SQL query.

§Serialization policy

JSON (#[serde(untagged)]) — API-boundary format, documented lossy. JSON output uses plain JSON types ("string", 1, true, null, […], {…}) so that HTTP/pgwire clients see idiomatic JSON without tagged wrappers. This is intentional but lossy for six variants:

VariantJSON representationRound-trip loss
Uuid(s)"<s>"decoded as String
Ulid(s)"<s>"decoded as String
Regex(s)"<s>"decoded as String
Range {…}nulldecoded as Null
Record {…}nulldecoded as Null
ArrayCell{"coords":[…], "attrs":[…]}decoded as Object without type discriminator
Vector(v)[f32, …] (JSON number array)decoded as Array<Float>

Round-trip through JSON is NOT preserved for these six variants. JSON is permitted only at the HTTP/pgwire API boundary (decode_payload_to_json() in the Control Plane); it must never be used for Data Plane storage, WAL records, or cross-plane messages.

zerompk MessagePack (hand-rolled ToMessagePack/FromMessagePack in value/msgpack.rs) — internal transport format, lossless. Every variant round-trips through MessagePack without loss. All internal paths (Data Plane, SPSC bridge, WAL payloads) MUST use zerompk. JSON is reserved for the API boundary and forbidden in these contexts.

#[non_exhaustive] — new value kinds will be added in future releases (e.g. Vector, typed collections). This attribute enforces Rust API hygiene only; the concrete serialization contract is described above.

Variants (Non-exhaustive)§

This enum is marked as 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

SQL NULL / missing value.

§

Bool(bool)

Boolean.

§

Integer(i64)

Signed 64-bit integer.

§

Float(f64)

64-bit floating point.

§

String(String)

UTF-8 string.

§

Bytes(Vec<u8>)

Raw bytes (embeddings, serialized blobs).

§

Array(Vec<Value>)

Ordered array of values.

§

Object(HashMap<String, Value>)

Nested key-value object.

§

Uuid(String)

UUID (any version, stored as 36-char hyphenated string).

§

Ulid(String)

ULID (26-char Crockford Base32).

§

DateTime(NdbDateTime)

UTC timestamp with microsecond precision (timezone-aware).

§

NaiveDateTime(NdbDateTime)

Naive (local/no-timezone) timestamp with microsecond precision.

§

Duration(NdbDuration)

Duration with microsecond precision (signed).

§

Decimal(Decimal)

Arbitrary-precision decimal (financial calculations, exact arithmetic).

§

Geometry(Geometry)

GeoJSON-compatible geometry (Point, LineString, Polygon, etc.).

§

Set(Vec<Value>)

Ordered set of unique values (auto-deduplicated, maintains insertion order).

§

Regex(String)

Compiled regex pattern (stored as pattern string).

§

Range

A range of values with optional bounds.

Fields

§start: Option<Box<Value>>

Start bound (None = unbounded).

§end: Option<Box<Value>>

End bound (None = unbounded).

§inclusive: bool

Whether the end bound is inclusive (..= vs ..).

§

Record

A typed reference to another record: table:id.

Fields

§table: String

The table/collection name.

§id: String

The record’s document ID.

§

ArrayCell(ArrayCell)

One N-dimensional array cell (coords + attrs). Used by the array engine to carry a single cell across the SQL / wire boundary.

§

Vector(Arc<[f32]>)

Dense f32 embedding vector (e.g. HNSW, neural embeddings).

Stored as a reference-counted slice to allow cheap cloning without copying the underlying floats. Serialized as raw bytes (bytemuck::cast_slice) with zerompk tag 20; JSON serializes as a plain number array (lossy — decodes as Array<Float>, not Vector).

Implementations§

Source§

impl Value

Source

pub fn eq_coerced(&self, other: &Value) -> bool

Coerced equality: Value vs Value with numeric/string coercion.

Single source of truth for type coercion in filter evaluation. Used by matches_binary (msgpack path) and matches_value (Value path).

Source

pub fn cmp_coerced(&self, other: &Value) -> Ordering

Coerced ordering: Value vs Value with numeric/string coercion.

Single source of truth for ordering in filter/sort evaluation.

Source§

impl Value

Source

pub fn is_null(&self) -> bool

Returns true if this value is Null.

Source

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

Try to extract as a string reference.

Source

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

Try to extract as i64.

Source

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

Try to extract as f64.

Source

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

Try to extract as bool.

Source

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

Try to extract as byte slice (for embeddings).

Source

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

Try to extract as UUID string.

Source

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

Try to extract as ULID string.

Source

pub fn as_datetime(&self) -> Option<&NdbDateTime>

Try to extract as DateTime (timezone-aware).

Source

pub fn as_naive_datetime(&self) -> Option<&NdbDateTime>

Try to extract as NaiveDateTime (no timezone).

Source

pub fn as_duration(&self) -> Option<&NdbDuration>

Try to extract as Duration.

Source

pub fn as_decimal(&self) -> Option<&Decimal>

Try to extract as Decimal.

Source

pub fn as_geometry(&self) -> Option<&Geometry>

Try to extract as Geometry.

Source

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

Try to extract as a set (deduplicated array).

Source

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

Try to extract as regex pattern string.

Source

pub fn as_record(&self) -> Option<(&str, &str)>

Try to extract as a record reference (table, id).

Source

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

Return the type name of this value as a string.

Source

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

Look up a field by name. Returns None for non-Object variants.

Source

pub fn get_mut(&mut self, field: &str) -> Option<&mut Value>

Mutable field lookup. Returns None for non-Object variants.

Source

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

Try to extract as an object (HashMap reference).

Source

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

Try to extract as a mutable object.

Source

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

Try to extract as an array slice.

Source

pub fn as_array_iter(&self) -> Option<impl Iterator<Item = &Value>>

Get array elements (for IN/array operations).

Source

pub fn vector(floats: impl Into<Arc<[f32]>>) -> Value

Construct a Value::Vector from any slice of f32 values.

Source

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

Try to extract as an f32 embedding slice.

Source§

impl Value

Source

pub fn to_sql_literal(&self) -> String

Convert to a SQL literal string for substitution into SQL text.

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Value

Source§

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

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

impl Default for Value

Source§

fn default() -> Value

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Value

Source§

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

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

impl From<&[f32]> for Value

Source§

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

Converts to this type from the input type.
Source§

impl From<&str> for Value

Source§

fn from(s: &str) -> Value

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<Decimal> for Value

Source§

fn from(d: Decimal) -> Value

Converts to this type from the input type.
Source§

impl From<Geometry> for Value

Source§

fn from(g: Geometry) -> Value

Converts to this type from the input type.
Source§

impl From<NdbDateTime> for Value

Source§

fn from(dt: NdbDateTime) -> Value

Converts to this type from the input type.
Source§

impl From<NdbDuration> for Value

Source§

fn from(d: NdbDuration) -> Value

Converts to this type from the input type.
Source§

impl From<String> for Value

Source§

fn from(s: String) -> Value

Converts to this type from the input type.
Source§

impl From<Value> for Value

Source§

fn from(v: Value) -> Value

Converts to this type from the input type.
Source§

impl From<Value> for Value

Source§

fn from(v: Value) -> Value

Converts to this type from the input type.
Source§

impl From<Vec<f32>> for Value

Source§

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

Converts to this type from the input type.
Source§

impl From<Vec<u8>> for Value

Source§

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

Converts to this type from the input type.
Source§

impl From<bool> for Value

Source§

fn from(b: bool) -> Value

Converts to this type from the input type.
Source§

impl From<f64> for Value

Source§

fn from(f: f64) -> Value

Converts to this type from the input type.
Source§

impl From<i64> for Value

Source§

fn from(i: i64) -> Value

Converts to this type from the input type.
Source§

impl<'a> FromMessagePack<'a> for Value

Source§

fn read<R>(reader: &mut R) -> Result<Value, Error>
where R: Read<'a>,

Reads the MessagePack representation of this value from the provided reader.
Source§

impl PartialEq for Value

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Serialize for Value

Source§

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. Read more
Source§

impl ToMessagePack for Value

Source§

fn write<W>(&self, writer: &mut W) -> Result<(), Error>
where W: Write,

Writes the MessagePack representation of this value into the provided writer.
Source§

impl StructuralPartialEq for Value

Auto Trait Implementations§

§

impl Freeze for Value

§

impl RefUnwindSafe for Value

§

impl Send for Value

§

impl Sync for Value

§

impl Unpin for Value

§

impl UnsafeUnpin for Value

§

impl UnwindSafe for Value

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> FromMessagePackOwned for T
where T: for<'a> FromMessagePack<'a>,

Source§

impl<T> NodeDbMarker for T
where T: Send + Sync + ?Sized,

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,