Struct Locator 

pub struct Locator { /* private fields */ }

Implementations

impl Locator

pub fn new( provider: Arc<dyn Provider>, root: Option<ElementData>, selector: &str, ) -> Locator

Create a new Locator.

Pass root: None to search the entire accessibility tree, or Some(element) to scope the search to that element’s subtree.

pub fn with_timeout(self, timeout: Duration) -> Locator

Return a new Locator with a custom auto-wait timeout for action methods.

pub fn nth(self, n: usize) -> Locator

Return a new Locator that selects the nth match (1-based).

Panics

Panics if n is 0. Use .first() or .nth(1) for the first match.

pub fn first(self) -> Locator

Return a new Locator that selects the first match.

pub fn child(self, child_selector: &str) -> Locator

Return a new Locator scoped to a direct child matching child_selector.

Appends > {child_selector} to the current selector. If either side is a comma-separated selector group, the combinator distributes over every clause: e.g. "a, b".child("c") => "a > c, b > c".

pub fn descendant(self, desc_selector: &str) -> Locator

Return a new Locator scoped to a descendant matching desc_selector.

Appends {desc_selector} to the current selector. If either side is a comma-separated selector group, the combinator distributes over every clause: e.g. "a, b".descendant("c") => "a c, b c".

pub fn selector(&self) -> &str

Get the selector string.

pub fn exists(&self) -> Result<bool, Error>

Check if a matching element exists.

pub fn count(&self) -> Result<usize, Error>

Count matching elements.

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

Get a single Element handle.

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

Get all matching elements.

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

Capture the subtree rooted at the matched element as a recursive snapshot. Resolves the selector once (no auto-wait — inspection ops should fail fast on selector miss). See Element::tree for max_depth semantics.

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

Render the subtree rooted at the matched element as an indented string. Resolves the selector once (no auto-wait). See Element::dump for the output format.

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

Click / invoke the matched element.

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

Set keyboard focus on the matched element.

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

Remove keyboard focus from the matched element.

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

Toggle the matched element (checkbox, switch).

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

Select the matched element (list item, etc.).

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

Expand the matched element.

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

Collapse the matched element.

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

Show the context menu for the matched element.

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

Increment the matched element (slider, spinner).

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

Decrement the matched element (slider, spinner).

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

Scroll the matched element into view.

pub fn set_value(&self, value: &str) -> Result<(), Error>

Set the text value of the matched element.

pub fn set_numeric_value(&self, value: f64) -> Result<(), Error>

Set the numeric value of the matched element (slider, spinner).

pub fn type_text(&self, text: &str) -> Result<(), Error>

Type text at the current cursor position on the matched element.

pub fn select_text(&self, start: u32, end: u32) -> Result<(), Error>

Select a text range within the matched element.

pub fn perform_action(&self, action: &str) -> Result<(), Error>

Perform an action by name (with auto-wait).

This is the escape hatch for platform-specific actions not covered by the named methods above. Also works for well-known action names.

pub fn wait_visible(&self, timeout: Duration) -> Result<Element, Error>

Wait until the element is visible, polling the provider.

pub fn wait_attached(&self, timeout: Duration) -> Result<Element, Error>

Wait until the element exists.

pub fn wait_detached(&self, timeout: Duration) -> Result<(), Error>

Wait until the element is removed.

pub fn wait_enabled(&self, timeout: Duration) -> Result<Element, Error>

Wait until the element is enabled.

pub fn wait_disabled(&self, timeout: Duration) -> Result<Element, Error>

Wait until the element is disabled (exists but not enabled).

pub fn wait_hidden(&self, timeout: Duration) -> Result<(), Error>

Wait until the element is hidden or removed.

pub fn wait_focused(&self, timeout: Duration) -> Result<Element, Error>

Wait until the element has keyboard focus.

pub fn wait_unfocused(&self, timeout: Duration) -> Result<Element, Error>

Wait until the element does not have keyboard focus.

pub fn wait_for_state( &self, state: ElementState, timeout: Duration, ) -> Result<Option<Element>, Error>

Wait for an ElementState condition to be met.

pub fn wait_until( &self, predicate: impl Fn(Option<&ElementData>) -> bool, timeout: Duration, ) -> Result<Option<Element>, Error>

Wait until an arbitrary predicate is satisfied, polling at ~100 ms intervals.

Trait Implementations

impl Clone for Locator

fn clone(&self) -> Locator

Returns a duplicate of the value.

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

Performs copy-assignment from source.