Struct TerminalSession 

pub struct TerminalSession { /* private fields */ }

A live pseudo-terminal session with typed VT state.

Implementations

impl TerminalSession

pub fn spawn(options: SessionOptions) -> Result<Self, TerminalError>

Start a child process in a fresh native PTY.

pub fn send(&self, events: &[InputEvent]) -> Result<usize, TerminalError>

Send a prevalidated batch of text and typed key events.

pub fn capture( &self, region: Option<CellRegion>, ) -> Result<ScreenCapture, TerminalError>

Capture the current screen, optionally including detailed cells.

pub fn resize(&self, rows: u16, columns: u16) -> Result<(), TerminalError>

Resize both the native PTY and the VT parser.

pub fn wait_idle( &self, quiet: Duration, timeout: Duration, ) -> Result<WaitIdleResult, TerminalError>

Wait until no child output has arrived for quiet.

pub fn wait_idle_after( &self, after_revision: u64, quiet: Duration, timeout: Duration, ) -> Result<WaitIdleResult, TerminalError>

Wait for a state revision newer than after_revision, then for quiet.

This fences a send-then-capture sequence against output that was already quiet before the input was written. The wait remains notification-driven.

pub fn wait_exit( &self, timeout: Duration, ) -> Result<ProcessStatus, TerminalError>

Wait for the child process to reach a terminal state.

pub fn end(&self, timeout: Duration) -> Result<ProcessStatus, TerminalError>

Terminate the child, close terminal handles, and join worker threads.

Trait Implementations

impl Drop for TerminalSession

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.