Skip to main content

A11yTree

Struct A11yTree 

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

An insertion-ordered tree of semantic nodes.

Implementations§

Source§

impl A11yTree

Source

pub fn new() -> Self

An empty tree.

Source

pub fn insert(&mut self, node: A11yNode) -> NodeId

Insert a node; ids must be unique and ascending is conventional but not required. Returns the node’s id for chaining.

Source

pub fn push(&mut self, node: A11yNode) -> NodeId

Insert with the next free id.

Source

pub fn get(&self, id: NodeId) -> Option<&A11yNode>

Look up a node.

Source

pub fn nodes(&self) -> &[A11yNode]

All nodes, in insertion order.

Source

pub fn roots(&self) -> Vec<NodeId>

Roots (nodes without a parent).

Source

pub fn focused(&self) -> Vec<NodeId>

The focused node, if exactly one claims focus.

Source

pub fn audit(&self) -> Result<TreeAudit, AuditError>

Audit the tree. Every rule is a CI gate:

  1. unique ids;
  2. parents and relation targets exist;
  3. no structural cycles;
  4. interactive roles carry an accessible name;
  5. at most one focused node, and it is reachable from a root.
Source

pub fn reachable_from_roots(&self) -> Vec<NodeId>

Every node reachable by walking parents down from the roots.

Source

pub fn children_of(&self, id: NodeId) -> Vec<NodeId>

Direct children of id.

Source

pub fn descendants_of(&self, id: NodeId) -> Vec<NodeId>

id and every node beneath it (depth-first, parents first).

Trait Implementations§

Source§

impl Clone for A11yTree

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for A11yTree

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for A11yTree

Source§

fn default() -> Self

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.