Skip to main content Crate ui_automata Copy item path Source pub use yaml::PhaseEvent ;debug duration expression Simple expression evaluator for the Eval action. lint Workflow YAML linter. schema Manual JsonSchema implementations for types that use custom serde deserializers. yaml AnchorDef Declaration of a named anchor. Executor Runs plans against a live UIA desktop. LaunchContext Context stored after a successful launch: wait, used by ShadowDom::resolve
to filter the first resolution of root anchors. Output Workflow output buffer. Populated by Extract actions during execution
and returned to the caller after the workflow completes. Plan An ordered sequence of steps toward a single goal, with local recovery handlers. RecoveryHandler A domain heuristic that fires when the executor detects a known “lost state”. SelectorPath ShadowDom A cached registry of named live element handles. Does not own the desktop;
callers pass &D to the methods that need to re-query the UIA tree. Step A single automation intent: execute an action, then wait for an expected UI state. TabHandle State for a mounted Tab anchor. TabInfo Basic info about a browser tab. TextMatch Matches element text. Exactly one field should be set. TitleMatch Matches a window title. Exactly one field should be set. Workflow A sequence of named plans run in order through a single executor. WorkflowPhase Owned data for one phase of a Workflow. WorkflowState Workflow-level mutable state: output, locals, and per-run flags.
Separated from Executor so it can be created, passed around, and
returned independently (e.g. across subflow invocations). Action AutomataError ClickType Type of mouse click to perform. Condition Custom Deserialize via TryFrom<serde_yaml::Value> to work around the
serde limitation that #[serde(tag)] + #[serde(flatten)] don’t compose
in serde_yaml. We hand-roll the mapping from a YAML map to enum variants. ExtractAttribute Which text property to read from each matched element during an Extract action. LaunchWait How to identify the launched application’s window after calling launch:. OnFailure Controls executor behaviour when a step’s expect condition times out (and any
fallback action also fails to satisfy it). OnSuccess Controls executor behaviour immediately after a step succeeds. ResumeStrategy What the executor does after a recovery handler fires. RetryPolicy What the executor does when a step’s expect condition times out. Tier Lifetime tier of a registered anchor. WindowState Observable state of a window anchor. DEFAULT_TIMEOUT EXEC_EXIT_CODE_KEY Key written to locals by every Exec action — holds the integer exit code as a string.
Read by the Condition::ExecSucceeded Browser CDP browser: operations for controlling browser sessions and tabs. Desktop Platform desktop: discovers windows and provides foreground state. Element A UI element handle. Implementations wrap platform-specific COM/UIA objects. sub_output Replace all {output.<key>} tokens in s.
Checks the output buffer first (first value per key), then local vars.
Unknown keys expand to an empty string.