Struct Reference 

pub struct Reference {
    pub path: String,
    pub type_info: Option<TypeInfo>,
}

A reference to a value at another path.

References are the foundation of HATEOAS in StructFS. Instead of embedding full values or documenting path construction rules, stores return references that clients can follow.

Examples

use structfs_core_store::Reference;

// Minimal reference
let r = Reference::new("handles/0");

// Reference with type hint
let r = Reference::with_type("handles/0", "handle");

// Reference to an action
let r = Reference::with_type("meta/open", "action");

Fields

path: String

The path to the referenced value.

type_info: Option<TypeInfo>

Optional type information.

Implementations

impl Reference

pub fn new(path: impl Into<String>) -> Self

Create a minimal reference with just a path.

pub fn with_type(path: impl Into<String>, type_name: impl Into<String>) -> Self

Create a reference with a type name.

pub fn to_value(&self) -> Value

Convert to a Value::Map representation.

This produces the canonical reference format:

{"path": "handles/0", "type": {"name": "handle"}}

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

Try to parse a Reference from a Value.

A value is a reference if it’s a map containing a path key whose value is a string.

pub fn is_reference(value: &Value) -> bool

Check if a Value is a reference.

A value is a reference if it’s a map containing a path key whose value is a string.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl Eq for Reference

impl PartialEq for Reference

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Reference