Struct accesskit::TreeUpdate

pub struct TreeUpdate {
    pub nodes: Vec<(NodeId, Node)>,
    pub tree: Option<Tree>,
    pub focus: NodeId,
}

A serializable representation of an atomic change to a Tree.

The sender and receiver must be in sync; the update is only meant to bring the tree from a specific previous state into its next state. Trying to apply it to the wrong tree should immediately panic.

Note that for performance, an update should only include nodes that are new or changed. AccessKit platform adapters will avoid raising extraneous events for nodes that have not changed since the previous update, but there is still a cost in processing these nodes and replacing the previous instances.

Fields

nodes: Vec<(NodeId, Node)>

Zero or more new or updated nodes. Order doesn’t matter.

Each node in this list will overwrite any existing node with the same ID. This means that when updating a node, fields that are unchanged from the previous version must still be set to the same values as before.

It is an error for any node in this list to not be either the root or a child of another node. For nodes other than the root, the parent must be either an unchanged node already in the tree, or another node in this list.

To add a child to the tree, the list must include both the child and an updated version of the parent with the child’s ID added to Node::children.

To remove a child and all of its descendants, this list must include an updated version of the parent node with the child’s ID removed from Node::children. Neither the child nor any of its descendants may be included in this list.

tree: Option<Tree>

Rarely updated information about the tree as a whole. This may be omitted if it has not changed since the previous update, but providing the same information again is also allowed. This is required when initializing a tree.

focus: NodeId

The node within this tree that has keyboard focus when the native host (e.g. window) has focus. If no specific node within the tree has keyboard focus, this must be set to the root. The latest focus state must be provided with every tree update, even if the focus state didn’t change in a given update.

Trait Implementations

impl Clone for TreeUpdate

fn clone(&self) -> TreeUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TreeUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: FnOnce() -> TreeUpdate> From<T> for TreeUpdate

fn from(factory: T) -> Self

Converts to this type from the input type.

impl JsonSchema for TreeUpdate

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for TreeUpdate

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TreeUpdate

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 TreeUpdate