Struct Spec 

pub struct Spec {
    pub schema: String,
    pub root: String,
    pub elements: HashMap<String, Element>,
    pub title: Option<TitleBinding>,
    pub layout: Option<String>,
    pub data: Value,
}

Top-level v2 JSON-UI document.

A Spec is a flat element map keyed by ID with a single root pointer. Children are referenced by string ID, not by nesting, which keeps the structure human-auditable and preserves a stable anchor for every element.

Fields

schema: String

Schema version tag ("ferro-json-ui/v2").

root: String

ID of the root element (must exist as a key in elements).

elements: HashMap<String, Element>

Flat map of element ID to element body. Element IDs are ^[A-Za-z_][A-Za-z0-9_-]{0,127}$.

title: Option<TitleBinding>

Optional document title (used by layouts to populate <title>). Accepts a literal string or {"$data": "/path"} binding.

layout: Option<String>

Optional layout name (e.g. "dashboard", "app").

data: Value

Arbitrary data payload consumed by data-path references inside elements.

Implementations

impl Spec

pub fn builder() -> SpecBuilder

Entry point for fluent construction of a Spec.

The first .element(id, _) call sets the root if it has not been explicitly set via .root(). The terminal .build() runs the same structural validation as Spec::from_json.

pub fn merge_data(self, handler_data: Value) -> Self

Merge handler-provided data into spec.data via a shallow top-level merge.

If handler_data is a JSON Object, its keys are inserted into self.data, overwriting matching keys (handler wins — locked per 119-CONTEXT D-04). If self.data is Value::Null (the default for specs built without .data(...)), it is initialized to an empty object before inserting — otherwise as_object_mut() would return None and the handler keys would be silently dropped (119-RESEARCH §Pitfall 4).

If handler_data is not an Object (Null, Array, String, Number, Bool), it is silently ignored — a debug_assert! fires in dev builds but production never panics (119-CONTEXT D-04).

Consuming builder (mut self -> Self) for consistency with SpecBuilder.

pub fn from_json(json: &str) -> Result<Spec, SpecError>

Parse a v2 spec from its JSON representation.

Returns Ok(spec) only if the JSON is well-formed AND the element graph passes every structural check. Never panics on arbitrary input.

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Spec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Spec

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Spec