Struct TerminalCaptureOptions 

pub struct TerminalCaptureOptions {

    pub file: String,
    pub args: Vec<String>,
    pub cwd: Option<PathBuf>,
    pub env: HashMap<String, String>,
    pub env_remove: Vec<String>,
    pub env_clear: bool,
    pub cols: u16,
    pub rows: u16,
    pub aspect_ratio: Option<f64>,
    pub settle_duration: Duration,
    pub frames_on_write: bool,
    pub recording: bool,
    pub interactions: Vec<TerminalInteraction>,
    pub stop_marker: Option<String>,
    pub stop_marker_grace: Duration,
    pub timeout: Option<Duration>,
    pub artifact_directory: Option<PathBuf>,
    pub artifacts: Option<Vec<TerminalArtifact>>,
    pub on_trace: Option<TerminalTraceCallback>,
}

Fields

file: String

args: Vec<String>

cwd: Option<PathBuf>

env: HashMap<String, String>

Variables set on top of the inherited environment.

env_remove: Vec<String>

Inherited variables to drop, applied after env (issue #229).

env_clear: bool

Start from an empty environment instead of the parent’s (issue #229). TERM, COLUMNS, LINES and env are still set.

cols: u16

rows: u16

Ignored when aspect_ratio is set.

aspect_ratio: Option<f64>

Derive rows as max(1, round(cols / (2 * aspect_ratio))), like the JS aspectRatio option (JS defaults to 4 / 3, i.e. 30 rows for 80 columns; None keeps rows, 24 by default).

settle_duration: Duration

frames_on_write: bool

Retain a frame after every parsed PTY write instead of waiting for idle.

recording: bool

Disable recording history; keep the latest frame and last 1MB of output.

interactions: Vec<TerminalInteraction>

stop_marker: Option<String>

stop_marker_grace: Duration

timeout: Option<Duration>

Deadline for the whole run. None keeps the child alive indefinitely, which is the default for crate::terminal::open_terminal sessions.

artifact_directory: Option<PathBuf>

artifacts: Option<Vec<TerminalArtifact>>

Which files to write to artifact_directory; None writes all of TerminalArtifact::ALL. Renderers of unselected files are skipped.

on_trace: Option<TerminalTraceCallback>

Receives output, interaction, timeout and exit events as they happen.

Trait Implementations

impl Clone for TerminalCaptureOptions

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 TerminalCaptureOptions

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

Formats the value using the given formatter.

impl Default for TerminalCaptureOptions

fn default() -> Self

Returns the “default value” for a type.