Enum Operation 

pub enum Operation {
    Open(OpenOptions),
    Run(RunOptions),
    Restart {
        graceful_timeout_ms: u64,
    },
    Close,
    FinishTrace {
        failed: bool,
    },
    State,
    Text {
        full: bool,
    },
    PackedScreen {
        full: bool,
    },
    Cells {
        x: u16,
        y: u16,
        w: u16,
        h: u16,
    },
    GetCommand,
    GetOutput,
    GetExitCode,
    GetCwd,
    GetCursor,
    GetModes,
    GetColors,
    GetSize,
    GetTitle,
    GetClipboard,
    GetBellCount,
    GetBellEvents,
    Write {
        data: String,
    },
    Submit {
        data: Option<String>,
    },
    Key {
        keys: Vec<String>,
        action: KeyAction,
    },
    Mouse {
        action: MouseAction,
    },
    Resize {
        cols: u16,
        rows: u16,
    },
    Signal {
        name: String,
    },
    WaitTitle {
        text: String,
        regex: bool,
        timeout_ms: Option<u64>,
        not: bool,
    },
    WaitClipboard {
        timeout_ms: Option<u64>,
    },
    WaitClipboardMatch {
        pattern: ClipboardPattern,
        timeout_ms: Option<u64>,
    },
    WaitIdle {
        timeout_ms: Option<u64>,
    },
    WaitCommand {
        timeout_ms: Option<u64>,
    },
    WaitExit {
        timeout_ms: Option<u64>,
    },
    WaitReady {
        timeout_ms: Option<u64>,
    },
    WaitBell {
        timeout_ms: Option<u64>,
    },
    FindLocator {
        query: LocatorQuery,
    },
    ResolveLocator {
        query: LocatorQuery,
    },
    WaitLocator {
        query: LocatorQuery,
        not: bool,
        timeout_ms: Option<u64>,
    },
    ClickLocator {
        query: LocatorQuery,
        options: MouseOptions,
        clicks: u8,
        timeout_ms: Option<u64>,
    },
    HighlightLocator {
        query: LocatorQuery,
        timeout_ms: Option<u64>,
    },
    ExpectTitle {
        text: String,
        regex: bool,
        not: bool,
        timeout_ms: Option<u64>,
    },
    ExpectExitCode {
        code: i32,
        timeout_ms: Option<u64>,
    },
    ExpectMode {
        mode: String,
        enabled: bool,
        timeout_ms: Option<u64>,
    },
    ExpectColors {
        foreground: Option<String>,
        background: Option<String>,
        cursor: Option<String>,
        palette: Vec<(u8, String)>,
        timeout_ms: Option<u64>,
    },
    ExpectCursor {
        visible: Option<bool>,
        shape: Option<String>,
        x: Option<u16>,
        y: Option<u16>,
        timeout_ms: Option<u64>,
    },
    ExpectOutput {
        text: String,
        regex: bool,
    },
    ExpectBellCount {
        count: u64,
        timeout_ms: Option<u64>,
    },
    Snapshot {
        name: String,
        update: bool,
        include_style: bool,
        include_title: bool,
        cwd: Option<String>,
    },
    Screenshot {
        full: bool,
        path: Option<String>,
        zoom: Option<f64>,
        background: Option<CaptureBackground>,
    },
    StartRecording {
        path: String,
        format: Option<RecordingFormat>,
        fps: Option<u8>,
        speed: Option<f64>,
        idle_time_limit: Option<f64>,
        zoom: Option<f64>,
        background: Option<CaptureBackground>,
    },
    StopRecording,
}

Variants

Open(OpenOptions)

Run(RunOptions)

Restart

Fields

graceful_timeout_ms: u64

Close

FinishTrace

Fields

failed: bool

State

Text

Fields

full: bool

PackedScreen

Fields

full: bool

Cells

Fields

x: u16

y: u16

w: u16

h: u16

GetCommand

GetOutput

GetExitCode

GetCwd

GetCursor

GetModes

GetColors

GetSize

GetTitle

GetClipboard

GetBellCount

GetBellEvents

Write

Fields

data: String

Submit

Fields

data: Option<String>

Key

Fields

keys: Vec<String>

action: KeyAction

Mouse

Fields

action: MouseAction

Resize

Fields

cols: u16

rows: u16

Signal

Fields

name: String

WaitTitle

Fields

text: String

regex: bool

timeout_ms: Option<u64>

not: bool

WaitClipboard

Fields

timeout_ms: Option<u64>

WaitClipboardMatch

Fields

pattern: ClipboardPattern

timeout_ms: Option<u64>

WaitIdle

Fields

timeout_ms: Option<u64>

WaitCommand

Fields

timeout_ms: Option<u64>

WaitExit

Fields

timeout_ms: Option<u64>

WaitReady

Fields

timeout_ms: Option<u64>

WaitBell

Fields

timeout_ms: Option<u64>

FindLocator

Fields

query: LocatorQuery

ResolveLocator

Fields

query: LocatorQuery

WaitLocator

Fields

query: LocatorQuery

not: bool

timeout_ms: Option<u64>

ClickLocator

Fields

query: LocatorQuery

options: MouseOptions

clicks: u8

timeout_ms: Option<u64>

HighlightLocator

Fields

query: LocatorQuery

timeout_ms: Option<u64>

ExpectTitle

Fields

text: String

regex: bool

not: bool

timeout_ms: Option<u64>

ExpectExitCode

Fields

code: i32

timeout_ms: Option<u64>

ExpectMode

Wait for a terminal mode to reach enabled.

Fields

mode: String

enabled: bool

timeout_ms: Option<u64>

ExpectColors

Wait for the terminal’s colors to match those named.

Fields

foreground: Option<String>

background: Option<String>

cursor: Option<String>

palette: Vec<(u8, String)>

OSC 4 palette entries to match, as (index, color).

timeout_ms: Option<u64>

ExpectCursor

Wait for the cursor to match every property the caller named.

Fields

visible: Option<bool>

shape: Option<String>

x: Option<u16>

y: Option<u16>

timeout_ms: Option<u64>

ExpectOutput

Fields

text: String

regex: bool

ExpectBellCount

Fields

count: u64

timeout_ms: Option<u64>

Snapshot

Fields

name: String

update: bool

include_style: bool

include_title: bool

cwd: Option<String>

Screenshot

Fields

full: bool

path: Option<String>

zoom: Option<f64>

background: Option<CaptureBackground>

StartRecording

Fields

path: String

format: Option<RecordingFormat>

fps: Option<u8>

speed: Option<f64>

idle_time_limit: Option<f64>

zoom: Option<f64>

background: Option<CaptureBackground>

StopRecording

Implementations

impl Operation

pub fn wait_clipboard_match( pattern: impl Into<ClipboardPattern>, timeout_ms: Option<u64>, ) -> Self

Wait for clipboard text or a regex.

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Operation

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

Formats the value using the given formatter.