Struct ScriptedTerminal 

pub struct ScriptedTerminal { /* private fields */ }

A scripted, in-memory terminal that replays canned input and captures output.

Implementations

impl ScriptedTerminal

pub fn key_driven() -> Self

A key-driven scripted terminal (advertises key input, like a raw TTY).

pub fn line_driven() -> Self

A line-driven scripted terminal (advertises line input, like cooked stdio).

pub fn with_line(self, line: impl Into<String>) -> Self

Queue one input line (line-driven scripts).

pub fn with_lines<I, S>(self, lines: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Queue several input lines in order.

pub fn with_key(self, key: Key) -> Self

Queue one keystroke (key-driven scripts).

pub fn with_keys<I>(self, keys: I) -> Self

where I: IntoIterator<Item = Key>,

Queue several keystrokes in order.

pub fn output(&self) -> &str

Everything written to the terminal so far, for assertions.

pub const fn is_interactive(&self) -> bool

Whether the terminal is currently in interactive (raw) mode.

Trait Implementations

impl Debug for ScriptedTerminal

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

Formats the value using the given formatter.

impl Default for ScriptedTerminal

fn default() -> ScriptedTerminal

Returns the “default value” for a type.

impl Terminal for ScriptedTerminal

fn capabilities(&self) -> Capabilities

The interaction model this terminal supports.

fn read_line(&mut self) -> AppResult<Option<String>>

Read one whole line (line-driven terminals).

fn read_key(&mut self) -> AppResult<Key>

Read one decoded keystroke (key-driven terminals).

fn write(&mut self, text: &str) -> AppResult<()>

Write text verbatim (no trailing newline).

fn write_line(&mut self, text: &str) -> AppResult<()>

Write text followed by a newline (a carriage return + line feed in raw mode).

fn flush(&mut self) -> AppResult<()>

Flush any buffered output.

fn clear_last_lines(&mut self, _count: u16) -> AppResult<()>

Move the cursor up count lines and clear from there down, so the next frame overwrites the previous one. A no-op for line-driven terminals.

fn begin_interactive(&mut self) -> AppResult<()>

Enter interactive (raw) mode before a key-driven loop. A no-op for line-driven terminals.

fn end_interactive(&mut self) -> AppResult<()>

Leave interactive (raw) mode after a key-driven loop. A no-op for line-driven terminals.