Struct UiDocument 

pub struct UiDocument {
    pub version: u32,
    pub root: UiNode,
}

Fields

version: u32

root: UiNode

Implementations

impl UiDocument

pub fn apply_edit(&mut self, edit: UiGraphEdit) -> Result<(), UiGraphError>

Apply one edit. On failure the document is left unchanged.

Errors

Returns the structural, property, or validation error from the edit.

pub fn apply_edits( &mut self, edits: Vec<UiGraphEdit>, ) -> Result<(), UiGraphError>

Apply every edit against one in-memory candidate, then publish once.

Errors

Returns the first failing edit. The document is unchanged on failure.

pub fn set_property( &mut self, id: &str, property: &str, value: Option<Value>, ) -> Result<(), UiGraphError>

Set or clear one serialized property via a dotted JSON path.

Errors

Returns an error when the node is missing, the path is invalid, or the resulting node fails schema validation.

impl UiDocument

pub fn new(root: UiNode) -> UiDocument

pub fn from_json(source: &str) -> Result<UiDocument, UiGraphError>

Parse and validate a graph before it can reach the widget tree.

Errors

Returns a JSON decoding or graph-validation error.

pub fn to_json_pretty(&self) -> Result<String, UiGraphError>

Serialize the validated graph in a stable, human-readable form.

Errors

Returns a graph-validation or JSON encoding error.

pub fn validate(&self) -> Result<(), UiGraphError>

Check version, size, identity, accessibility, binding, and geometry invariants for the complete graph.

Errors

Returns the first violated graph invariant.

pub fn node(&self, id: &str) -> Option<&UiNode>

pub fn nodes(&self) -> Vec<&UiNode>

Every source node in depth-first builder order.

pub fn node_mut(&mut self, id: &str) -> Option<&mut UiNode>

pub fn insert_child( &mut self, parent_id: &str, index: usize, node: UiNode, ) -> Result<(), UiGraphError>

Insert node into a row or column at index. The graph is changed only after the complete candidate validates.

Errors

Returns an error for an unknown/non-collection parent, an out-of-range index, or any graph invariant violated by the inserted subtree.

pub fn remove_node(&mut self, id: &str) -> Result<UiNode, UiGraphError>

Remove a non-root node and return its complete subtree.

A container’s single required child cannot be removed; replace that child or remove the container instead.

Errors

Returns an error for the root, an unknown node, or a container’s required child. A failure leaves the graph unchanged.

pub fn replace_node( &mut self, id: &str, replacement: UiNode, ) -> Result<(), UiGraphError>

Replace a node in place, including the root, with a validated subtree.

Errors

Returns an error for an unknown target or any invariant violated by the replacement. A failure leaves the graph unchanged.

pub fn move_node( &mut self, id: &str, new_parent_id: &str, index: usize, ) -> Result<(), UiGraphError>

Reparent a non-root subtree into a row or column. index names the position in the destination after the source has been detached.

Errors

Returns an error when moving the root, moving into the subtree itself, removing a container’s required child, selecting an invalid parent or index, or violating another graph invariant. A failure is atomic.

Trait Implementations

impl Clone for UiDocument

fn clone(&self) -> UiDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UiDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UiDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UiDocument

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

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.

impl UiDocumentExt for UiDocument

fn build(&self, theme: &Theme) -> Result<Box<dyn Widget>, UiGraphError>

Build the retained widget subtree represented by this graph.

fn build_with( &self, _theme: &Theme, context: &UiBuildContext, ) -> Result<Box<dyn Widget>, UiGraphError>

Build with process-local services such as screen navigation.

impl StructuralPartialEq for UiDocument