Struct StateStore 

pub struct StateStore { /* private fields */ }

Implementations

impl StateStore

pub fn new() -> Self

pub fn begin_render(&self) -> RenderStateTransaction

Start an isolated render-state transaction.

Dropping the transaction leaves the committed store unchanged. Passing it to StateStore::commit_render installs compatible state and removes instances not reached during the successful render.

pub fn begin_render_scope( &self, scope: ComponentInstancePath, ) -> RenderStateTransaction

Start a transaction that reconciles only one component subtree. State belonging to other window roots remains untouched on commit.

pub fn commit_render(&mut self, transaction: RenderStateTransaction)

pub fn remove_scope(&mut self, scope: &ComponentInstancePath)

Remove one component subtree, including every descendant instance.

pub fn mount_instance( &mut self, path: ComponentInstancePath, schema: &ComponentStateSchema, ) -> Result<StateReconcileReport, StateError>

Mount or reconcile one instance without cleaning any other path. Used to make candidate component defaults readable during view.

Errors

Returns invalid-schema/default errors.

pub fn get(&self, path: &ComponentInstancePath, field: &str) -> Option<&UiValue>

pub fn set( &mut self, path: &ComponentInstancePath, field: &str, value: UiValue, ) -> Result<bool, StateError>

Update a declared field on a committed component instance.

Errors

Returns StateError::UnknownInstance, StateError::UnknownField, or StateError::InvalidValue when the update violates committed state.

pub fn instance_count(&self) -> usize

pub fn paths(&self) -> BTreeSet<ComponentInstancePath>

pub fn is_sensitive(&self, path: &ComponentInstancePath, field: &str) -> bool

pub fn inspect(&self) -> Vec<StateInstanceSnapshot>

pub fn inspect_instance( &self, path: &ComponentInstancePath, ) -> Option<StateInstanceSnapshot>

Inspect one component instance without cloning unrelated component state.

Trait Implementations

impl Clone for StateStore

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateStore

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

Formats the value using the given formatter.

impl Default for StateStore

fn default() -> Self

Returns the “default value” for a type.