axuielement 0.2.0

Safe Rust bindings for Apple's AXUIElement — drive other apps' UIs (read attributes, perform actions) on macOS
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Errors returned by the `axuielement` crate.

use core::fmt;

use crate::ffi;

#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum AXError {
    Failure,
    IllegalArgument(String),
    InvalidUIElement,
    CannotComplete,
    AttributeUnsupported(String),
    ActionUnsupported(String),
    NotificationUnsupported,
    NotImplemented,
    APIDisabled,
    NoValue,
    /// Raw IOReturn-style error code.
    Other(i32),
}

impl AXError {
    pub(crate) fn from_status(s: i32, ctx: &str) -> Self {
        match s {
            ffi::kAXErrorFailure => Self::Failure,
            ffi::kAXErrorIllegalArgument => Self::IllegalArgument(ctx.to_string()),
            ffi::kAXErrorInvalidUIElement => Self::InvalidUIElement,
            ffi::kAXErrorCannotComplete => Self::CannotComplete,
            ffi::kAXErrorAttributeUnsupported => Self::AttributeUnsupported(ctx.to_string()),
            ffi::kAXErrorActionUnsupported => Self::ActionUnsupported(ctx.to_string()),
            ffi::kAXErrorNotificationUnsupported => Self::NotificationUnsupported,
            ffi::kAXErrorNotImplemented => Self::NotImplemented,
            ffi::kAXErrorAPIDisabled => Self::APIDisabled,
            ffi::kAXErrorNoValue => Self::NoValue,
            other => Self::Other(other),
        }
    }
}

impl fmt::Display for AXError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Failure => write!(f, "AX failure"),
            Self::IllegalArgument(c) => write!(f, "illegal argument: {c}"),
            Self::InvalidUIElement => write!(f, "invalid UI element"),
            Self::CannotComplete => write!(f, "cannot complete"),
            Self::AttributeUnsupported(c) => write!(f, "attribute unsupported: {c}"),
            Self::ActionUnsupported(c) => write!(f, "action unsupported: {c}"),
            Self::NotificationUnsupported => write!(f, "notification unsupported"),
            Self::NotImplemented => write!(f, "not implemented"),
            Self::APIDisabled => write!(
                f,
                "Accessibility API disabled — open System Settings → Privacy & Security → Accessibility"
            ),
            Self::NoValue => write!(f, "no value"),
            Self::Other(s) => write!(f, "AXError {s}"),
        }
    }
}

impl std::error::Error for AXError {}