Struct LinuxBackend 

pub struct LinuxBackend { /* private fields */ }

Available on Linux only.

The Linux implementation of Backend, built on AT-SPI.

Implementations

impl LinuxBackend

pub fn new() -> Result<Self>

Connects to the AT-SPI accessibility bus.

Session variables this process lacks (DISPLAY, DBUS_SESSION_BUS_ADDRESS, XAUTHORITY, XDG_RUNTIME_DIR, AT_SPI_BUS_ADDRESS, …) are discovered from the user’s running desktop processes, so the backend also works from services, cron jobs and SSH sessions.

Errors

Fails if there is no D-Bus session or the accessibility bus is not running.

Trait Implementations

impl Backend for LinuxBackend

type Handle = LinuxElement

Handle to a live accessibility element (e.g. AXUIElement, IUIAutomationElement).

fn list_apps(&self) -> Result<Vec<AppInfo>>

Running apps plus installed apps the user can launch.

fn launch_app(&self, app: &AppInfo) -> Result<AppInfo>

Starts app without bringing it to the foreground and returns its running record.

fn list_windows(&self, app: &AppInfo) -> Result<Vec<WindowInfo>>

The app’s windows, front to back where the platform knows the order. Each one with an id can be passed back as CaptureRequest::window.

fn capture( &self, app: &AppInfo, request: &CaptureRequest, ) -> Result<Capture<Self::Handle>>

Captures the app’s current window, or the one CaptureRequest::window names.

fn perform_action(&self, element: &Self::Handle, action: &str) -> Result<()>

Invokes a named accessibility action (as listed in Action::name).

fn set_value(&self, element: &Self::Handle, value: &str) -> Result<()>

Writes an element’s value.

fn value(&self, element: &Self::Handle) -> Result<Option<String>>

Reads an element’s full, untruncated value.

fn select_text( &self, element: &Self::Handle, value: &str, range: Range<usize>, ) -> Result<()>

Selects range (byte offsets into value, the element’s current value). An empty range places the caret.

fn click( &self, _target: InputTarget<'_>, point: Point, button: MouseButton, count: u32, ) -> Result<()>

Clicks count times at a screen point.

fn scroll( &self, _target: InputTarget<'_>, point: Point, dx: f64, dy: f64, ) -> Result<()>

Scrolls at a screen point by (dx, dy) points; positive dy reveals content below.

fn drag(&self, _target: InputTarget<'_>, from: Point, to: Point) -> Result<()>

Presses the primary button at from, moves to to, and releases.

fn type_text(&self, _target: InputTarget<'_>, text: &str) -> Result<()>

Types literal text.

fn press_key(&self, _target: InputTarget<'_>, chord: &KeyChord) -> Result<()>

Presses and releases a key chord.

fn permissions(&self) -> Permissions

Permissions currently held by this process.

fn request_permissions(&self) -> Permissions

Asks the OS to prompt the user for missing permissions, then reports the current state.

fn insert_text(&self, app: &AppInfo, text: &str) -> Result<bool>

Inserts text at the caret of the focused element without synthesizing keystrokes. Returns Ok(false) when the focused element does not support it, so the caller can fall back to Backend::type_text.

impl Clone for LinuxBackend

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinuxBackend

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

Formats the value using the given formatter.