Skip to main content

A11yTree

Struct A11yTree 

Source
pub struct A11yTree { /* private fields */ }
Expand description

Builds and diffs accesskit TreeUpdates from an A11yNode tree.

The struct stores the flat map of nodes (by NodeId) after a build, so subsequent calls to A11yTree::diff can compute minimal deltas.

The content-hash map (hashes) stores the OxiUI-side hash of each node at the time of the last build_and_store call. A11yTree::diff uses these hashes instead of format!("{:?}", node) string comparison, which avoids the overhead of serializing accesskit::Node (which doesn’t impl PartialEq).

Implementations§

Source§

impl A11yTree

Source

pub fn build(root: &A11yNode) -> TreeUpdate

Walk root and its descendants depth-first, producing a TreeUpdate that describes the full tree.

Also stores the snapshot internally so future diff calls can compute minimal deltas.

Source

pub fn build_and_store(&mut self, root: &A11yNode) -> TreeUpdate

Build the full tree and store the snapshot for later diffing.

Returns a TreeUpdate identical to A11yTree::build.

In addition to the AccessKit snapshot, this method collects the OxiUI-side content hash of every node and stores it in self.hashes. A11yTree::diff uses these hashes for efficient change detection.

Source

pub fn set_focus(&mut self, id: Option<NodeId>)

Set the currently-focused node.

Pass None to clear the focus (the adapter will typically move focus back to the root).

Source

pub fn focus(&self) -> Option<NodeId>

Return the currently-focused node, if any.

Source

pub fn focus_update(&self) -> TreeUpdate

Produce a minimal TreeUpdate that only updates the focus field.

Useful when only focus has changed and no node properties have changed.

Source

pub fn announce(&mut self, text: &str, urgency: LiveSetting) -> NodeId

Insert a transient live-region announcement node.

Creates a synthetic accesskit::Role::Status node carrying text as its value, with the live-region politeness derived from urgency. The node is appended to the internal snapshot; the caller is responsible for removing it on the next tick (by calling build_and_store with a tree that doesn’t include this id).

Returns the newly-allocated NodeId so the caller can track it.

Source

pub fn diff(old: &A11yTree, new_tree: &A11yTree) -> TreeUpdate

Compute a minimal TreeUpdate delta from old to new_tree.

Only nodes whose content has changed (or that are brand-new) are included in the returned nodes list. Nodes that were removed are handled implicitly by AccessKit: when the parent’s children list no longer references a node, the platform adapter orphans it.

Change detection uses the OxiUI-side content hashes stored in self.hashes rather than format!("{:?}", accesskit::Node) string comparison. This is both faster and correct: accesskit::Node does not implement PartialEq, so the Debug-string approach was a pragmatic workaround. The hash approach is O(1) per node after the initial build.

The returned update’s focus is taken from new_tree.focus.

Trait Implementations§

Source§

impl Default for A11yTree

Source§

fn default() -> A11yTree

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.