Struct UiDocument 

pub struct UiDocument {
    pub id: UiDocumentId,
    pub revision: u64,
    pub placement: UiPlacement,
    pub modal: bool,
    pub nodes: Vec<UiNode>,
}

One semantic UI document, independent of a device’s view or graphics APIs.

Fields

id: UiDocumentId

Stable document identifier.

revision: u64

Source and interaction epoch, serialized as a decimal string.

Increment this when the node structure, declared actions, or interaction policy changes. It is not a per-value or per-frame tick; adapters validate input values against the current document state at dispatch time.

placement: UiPlacement

Requested spatial placement; adapters never silently replace it.

modal: bool

Whether this document captures platform navigation and draws a scrim.

Modal documents prevent scene navigation while active. Modeless documents remain an overlay, so scene controls such as sliders do not hide the scene.

nodes: Vec<UiNode>

Flat, deterministic document order for typed UI nodes.

Implementations

impl UiDocument

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

Validates document structure and required adapter capabilities.

Errors

Returns an error for malformed identifiers, bounds, duplicate nodes, or a world placement requested without room tracking.

pub fn validate_event( &self, event: &UiEvent, ) -> Result<ValidatedUiEvent, PresentationError>

Validates an input event against this exact document revision and node role.

This method checks only the semantic contract. Applying an accepted action remains an application responsibility.

Errors

Returns an error for stale documents, disabled nodes, mismatched actions, malformed text, or slider values outside the node’s declared range.

pub fn next_focus( &self, current: Option<&UiNodeId>, direction: UiNavigation, ) -> Option<UiNodeId>

Returns the next enabled focusable node in document order, wrapping at either end.

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UiDocument