Enum Step 

pub enum Step {
    Click {
        target: String,
    },
    DoubleClick {
        target: String,
    },
    Type {
        text: String,
    },
    Key {
        chord: String,
    },
    Drag {
        from: String,
        to: String,
    },
    Scroll {
        target: String,
        amount: i32,
        axis: Axis,
    },
    Verify {
        target: String,
    },
    WaitFor {
        target: String,
    },
    WaitGone {
        target: String,
    },
    Pause {
        ms: u64,
    },
}

What a step does.

Variants

Click

Click the resolved point of a labeled region.

Fields

target: String

DoubleClick

Double-click the resolved point of a labeled region.

Fields

target: String

Type

Type literal text through the platform’s Unicode path — layout independent, and unable to express shortcuts (use key).

Fields

text: String

Key

Press a chord of physical keys, e.g. cmd+s.

Fields

chord: String

Drag

Press at one region’s point, move, release at another’s.

Fields

from: String

to: String

Scroll

Hover a region and turn the wheel over it.

target picks what to scroll — a wheel event goes to whatever is under the cursor — and resolves exactly like a click’s does. amount is the one quantity in this tool that is not exact: it counts 15° wheel clicks, and how far that moves depends on the reader’s own OS scroll-speed setting. Scroll until something is visible (wait_for), never a fixed distance.

Fields

target: String

amount: i32

axis: Axis

Verify

Confirm a labeled region still matches its saved crop.

Fields

target: String

WaitFor

Poll until a labeled region matches its saved crop again, or the timeout expires. The honest alternative to guessing with a sleep: the OS accepts an event long before an app finishes reacting.

Fields

target: String

WaitGone

Poll until a labeled region STOPS matching — “wait until this spinner goes away”, “wait until the button changes state”.

Fields

target: String

Pause

Wait a fixed duration. Present because some waits genuinely have no observable, and pretending otherwise would push people to sleep-and-hope outside the tool.

Fields

ms: u64

Implementations

impl Step

pub fn targets(&self) -> Vec<&str>

Every session label this step needs. Resolution fails before any action runs when one is missing.

pub fn injects(&self) -> bool

Whether this step posts input, as opposed to only looking at the screen.

The distinction decides which regions must be present before a run starts. Acting on a region whose position cannot be trusted clicks an unknown thing; looking for one that is absent is the entire job of wait_for.

pub fn summary(&self) -> String

A short human label for reports and dry-run output.

Trait Implementations

impl Clone for Step

fn clone(&self) -> Step

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Step

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Step

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Step

impl PartialEq for Step

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Step

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Step