Struct CaptureOptions 

#[non_exhaustive]
pub struct CaptureOptions {
    pub include_tree: bool,
    pub include_screenshot: bool,
    pub text_limit: Option<usize>,
    pub max_nodes: usize,
    pub max_depth: usize,
    pub max_screenshot_dimension: Option<u32>,
    pub launch_if_needed: bool,
    pub window: Option<WindowSelector>,
    pub include_menu_bar: bool,
}

Limits and toggles for Computer::get_app_state.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

include_tree: bool

Walk the accessibility tree. Disabling this invalidates element indexes.

include_screenshot: bool

Capture a screenshot. Disabling this prevents coordinate-based actions.

text_limit: Option<usize>

Maximum characters kept per text attribute; None keeps everything.

max_nodes: usize

Maximum number of raw accessibility nodes visited.

max_depth: usize

Maximum tree depth visited.

max_screenshot_dimension: Option<u32>

Screenshots larger than this on either side are downscaled; None keeps full resolution.

launch_if_needed: bool

Launch the app (without activating it) if it is installed but not running.

window: Option<WindowSelector>

The window to capture; None picks the focused or main window.

include_menu_bar: bool

Also capture the app’s menu bar, as a second root after the window’s tree.

Only macOS keeps the menu bar outside the window; on Windows and Linux it is already part of the window’s tree, so this has no effect there.

Implementations

impl CaptureOptions

pub const fn include_tree(self, yes: bool) -> Self

Sets include_tree.

pub const fn include_screenshot(self, yes: bool) -> Self

Sets include_screenshot.

pub const fn text_limit(self, limit: Option<usize>) -> Self

Sets text_limit.

pub const fn max_nodes(self, max: usize) -> Self

Sets max_nodes.

pub const fn max_depth(self, max: usize) -> Self

Sets max_depth.

pub const fn max_screenshot_dimension(self, max: Option<u32>) -> Self

Sets max_screenshot_dimension.

pub const fn launch_if_needed(self, yes: bool) -> Self

Sets launch_if_needed.

pub fn window(self, window: WindowSelector) -> Self

Sets window.

pub const fn include_menu_bar(self, yes: bool) -> Self

Sets include_menu_bar.

Trait Implementations

impl Clone for CaptureOptions

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 CaptureOptions

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

Formats the value using the given formatter.

impl Default for CaptureOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CaptureOptions

impl PartialEq for CaptureOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CaptureOptions