Struct Terminal 

pub struct Terminal { /* private fields */ }

A terminal instance wrapping a PTY.

Implementations

impl Terminal

pub fn builder() -> TerminalBuilder

Create a new terminal builder.

pub async fn screen(&self) -> Screen

Get a snapshot of the current screen state.

pub async fn type_str(&self, text: &str) -> Result<&Self>

Type a string of text into the terminal.

pub async fn send_key(&self, key: Key) -> Result<&Self>

Send a key to the terminal.

pub async fn enter(&self) -> Result<&Self>

Press Enter key.

pub async fn escape(&self) -> Result<&Self>

Press Escape key.

pub async fn send_raw(&self, bytes: &[u8]) -> Result<&Self>

Send raw bytes to the terminal.

pub async fn resize(&self, cols: u16, rows: u16) -> Result<&Self>

Resize the PTY.

pub async fn mouse_move( &self, row: u16, col: u16, held_buttons: Vec<MouseButton>, ) -> Result<&Self>

Move the mouse cursor (hover).

Note: Many TUIs ignore this unless mouse reporting is enabled.

pub async fn mouse_click( &self, row: u16, col: u16, button: MouseButton, ) -> Result<&Self>

Click a mouse button at the given cell position.

pub async fn mouse_down( &self, row: u16, col: u16, button: MouseButton, ) -> Result<&Self>

Press a mouse button at the given cell position.

pub async fn mouse_up(&self, row: u16, col: u16) -> Result<&Self>

Release any mouse button at the given cell position.

pub fn expect(&self, text: &str) -> ExpectBuilder<'_>

Wait for specific text to appear on screen.

pub fn expect_gone(&self, text: &str) -> ExpectBuilder<'_>

Wait for specific text to disappear from screen.

pub fn expect_pattern(&self, pattern: &str) -> ExpectBuilder<'_>

Wait for a regex pattern to match on screen.

pub fn expect_pattern_gone(&self, pattern: &str) -> ExpectBuilder<'_>

Wait for a regex pattern to stop matching on screen.

pub fn wait_cursor(&self, position: Position) -> ExpectBuilder<'_>

Wait for the cursor to reach a specific position.

pub fn wait_idle(&self, duration: Duration) -> ExpectBuilder<'_>

Wait for the screen to stabilize (no changes for the given duration).

pub async fn wait_exit(&self) -> Result<i32>

Wait for the process to exit.

pub async fn has_exited(&self) -> bool

Check if the process has exited.

pub async fn kill(&self) -> Result<()>

Kill the terminal process.

pub fn config(&self) -> &TerminalConfig

Get the terminal configuration.

pub async fn screenshot(&self) -> Screenshot

Take a screenshot of the current screen.

Returns a Screenshot that can be saved to a file or converted to PNG bytes.