Struct App 

pub struct App {
    pub name: String,
    pub pid: Option<u32>,
    pub data: ElementData,
    /* private fields */
}

A running application, the entry point for accessibility queries.

App is not an Element — it represents the application as a whole and provides a locator to search its accessibility tree.

Fields

name: String

Application name.

pid: Option<u32>

Process ID.

data: ElementData

The underlying element data for this application.

Implementations

impl App

pub fn by_name_with( provider: Arc<dyn Provider>, name: &str, timeout: Duration, ) -> Result<App, Error>

Find an application by exact name, using an explicit provider.

Prefer App::by_name from the xa11y crate which uses the global singleton provider. Use this variant when you need to supply a specific provider (e.g. a mock in unit tests).

Polls the accessibility API until the app appears or timeout elapses. Duration::ZERO performs exactly one attempt (no waiting). Only Error::SelectorNotMatched triggers a retry; other errors (permission, parse, platform) short-circuit immediately.

pub fn by_pid_with( provider: Arc<dyn Provider>, pid: u32, timeout: Duration, ) -> Result<App, Error>

Find an application by process ID, using an explicit provider.

Prefer App::by_pid from the xa11y crate which uses the global singleton provider. See by_name_with for the timeout / polling semantics.

pub fn list_with(provider: Arc<dyn Provider>) -> Result<Vec<App>, Error>

List all running applications, using an explicit provider.

Prefer App::list from the xa11y crate which uses the global singleton provider.

pub fn locator(&self, selector: &str) -> Locator

Create a Locator to search this application’s accessibility tree.

pub fn subscribe(&self) -> Result<Subscription, Error>

Subscribe to accessibility events from this application.

pub fn children(&self) -> Result<Vec<Element>, Error>

Get direct children (typically windows) of this application.

pub fn tree(&self, max_depth: Option<usize>) -> Result<TreeNode, Error>

Capture the application’s accessibility tree as a recursive snapshot, rooted at the application element.

Equivalent to self.as_element().tree(max_depth). See Element::tree for max_depth semantics.

pub fn dump(&self, max_depth: Option<usize>) -> Result<String, Error>

Render the application’s accessibility tree as an indented string, rooted at the application element.

The primary inspection helper for figuring out the role/name of every element in an app before writing selectors. Equivalent to self.as_element().dump(max_depth). See Element::dump for the output format.

pub fn as_element(&self) -> Element

Get an Element handle for the application root.

Useful when you want to use Element-level methods (e.g. tree, dump, children) without going through a locator.

pub fn provider(&self) -> &Arc<dyn Provider>

Get the provider reference.

Trait Implementations

impl AppExt for App

fn by_name(name: &str, timeout: Duration) -> Result<Self>

Find an application by exact name using the global singleton provider, polling until it appears or timeout elapses. Pass Duration::ZERO for a single attempt with no waiting. See App::by_name_with for retry semantics.

fn by_pid(pid: u32, timeout: Duration) -> Result<Self>

Find an application by process ID using the global singleton provider, polling until it appears or timeout elapses. See by_name for retry semantics.

fn list() -> Result<Vec<Self>>

List all running applications using the global singleton provider.

impl Debug for App

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

Formats the value using the given formatter.

impl Display for App

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

Formats the value using the given formatter.