Struct Session 

pub struct Session { /* private fields */ }

One running terminal application controlled in-process by its caller.

Session is the embedded equivalent of the CLI session lifecycle. It owns a PTY and the visible terminal state, so callers can send input, wait for content, take shots, and resize without spawning a new termctrl command for each action.

Implementations

impl Session

pub fn start( command: &[String], cwd: Option<&Path>, record: Option<&Path>, options: &Options, ) -> Result<Self>

Start command inside a live PTY-backed session.

pub fn send(&mut self, input: &[u8]) -> Result<()>

Send one input burst to the terminal application.

pub fn send_all(&mut self, input: &[Vec<u8>], pace: Duration) -> Result<()>

Send ordered input bursts, optionally pacing them for recorded interactions.

pub fn wait_for_text(&mut self, text: &str, timeout: Duration) -> Result<()>

Wait until visible terminal text contains text.

pub fn wait_for_idle( &mut self, settle: Duration, timeout: Duration, ) -> Result<()>

Wait until no terminal output has arrived for settle.

pub fn wait_for_exit( &mut self, timeout: Duration, ) -> Result<Option<ProcessExit>>

Wait for the terminal application to exit, returning None on timeout.

pub fn capture( &mut self, settle: Duration, deadline: Duration, ) -> Result<CaptureResult>

Capture visible terminal state and report whether it settled, exited, or reached a limit.

pub fn status(&mut self) -> Result<SessionStatus>

Inspect session lifecycle, geometry, and whether a visible frame is available.

pub fn logs(&mut self, ansi: bool) -> Result<Vec<u8>>

Return readable normal-screen scrollback, or the exact retained ANSI/VT stream.

pub fn resize( &mut self, cols: u16, rows: u16, cell_width: u16, cell_height: u16, ) -> Result<()>

Resize the PTY and reflow subsequent terminal parsing at the new dimensions.

pub fn mark(&mut self, name: &str) -> Result<()>

Add a named moment to the active recording timeline.

pub fn stop(&mut self) -> Result<()>

Terminate the application owned by this session.

Trait Implementations

impl Drop for Session

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.