Enum Value 

#[non_exhaustive]
pub enum Value {
    Null,
    Bool(bool),
    Integer(i64),
    Unsigned(u64),
    Float(f64),
    String(String),
    Bytes(Vec<u8>),
    Array(Vec<Value>),
    Map(BTreeMap<String, Value>),
}

A tree-shaped value that can be read from or written to a Store.

This is the universal data representation in StructFS. It maps directly to JSON, MessagePack, CBOR, etc., but is encoding-agnostic.

Design Notes

• Uses BTreeMap for deterministic UTF-8 key ordering
• Includes Bytes for binary data (unlike JSON, but like CBOR/MessagePack)
• Integers cover the union of i64 and u64; signedness is not semantic

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

A present null value. Distinct from “path doesn’t exist”.

Bool(bool)

Boolean value.

Integer(i64)

Signed 64-bit integer.

Unsigned(u64)

Nonnegative integer storage; normalized values use this only above i64::MAX.

Float(f64)

64-bit floating point.

String(String)

UTF-8 string.

Bytes(Vec<u8>)

Binary data (for formats that support it: CBOR, MessagePack, etc.)

Array(Vec<Value>)

Ordered sequence of values.

Map(BTreeMap<String, Value>)

Key-value map with string keys (the “struct” part).

Implementations

impl Value

pub fn normalize(&mut self)

Normalize signedness and NaNs recursively. Ordinary PartialEq is unchanged.

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

Equality defined by StructFS Value v1, including NaN equality and signed zero.

pub fn null() -> Self

Create a null value.

pub fn map() -> Self

Create an empty map.

pub fn array() -> Self

Create an empty array.

pub fn is_null(&self) -> bool

Check if this value is null.

pub fn is_map(&self) -> bool

Check if this value is a map (struct).

pub fn is_array(&self) -> bool

Check if this value is an array.

pub fn get(&self, path: &Path) -> Option<&Value>

Get a reference to a nested value by path.

Returns None if the path doesn’t exist or can’t be navigated (e.g., trying to index into a string).

pub fn get_mut(&mut self, path: &Path) -> Option<&mut Value>

Get a mutable reference to a nested value by path.

pub fn set(&mut self, path: &Path, value: Value) -> Result<(), Error>

Set a value at a path, creating intermediate maps as needed.

Errors

Returns an error if the path traverses through a non-container value (e.g., trying to set foo/bar when foo is a string).

pub fn remove(&mut self, path: &Path) -> Result<Option<Value>, Error>

Remove a value at a path, returning it if it existed.

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

fn default() -> Value

Returns the “default value” for a type.

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

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<&str> for Value

fn from(v: &str) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<Value> for Record

fn from(v: 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(v: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(v: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<u64> for Value

fn from(v: u64) -> Self

Converts to this type from the input type.

impl PartialEq for Value

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Value

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Value