Struct PtySession 

pub struct PtySession { /* private fields */ }

A spawned PTY session with captured output.

Implementations

impl PtySession

pub fn read_output(&mut self) -> Vec<u8>

Read any available output without blocking.

pub fn read_output_result(&mut self) -> Result<Vec<u8>>

Read any available output without blocking (fallible).

pub fn read_until( &mut self, pattern: &[u8], timeout: Duration, ) -> Result<Vec<u8>>

Read output until a pattern is found or a timeout elapses. Uses bounded retries for transient read errors.

pub fn read_until_with_options( &mut self, pattern: &[u8], options: ReadUntilOptions, ) -> Result<Vec<u8>>

Read output until a pattern is found, with configurable retry behavior.

This variant supports:

• Bounded retries on transient errors (e.g., WouldBlock, Interrupted)
• Minimum bytes threshold before pattern matching
• Configurable retry delay

Example

let options = ReadUntilOptions::with_timeout(Duration::from_secs(5))
    .retries(3)
    .retry_delay(Duration::from_millis(50))
    .min_bytes(10);
let output = session.read_until_with_options(b"ready", options)?;

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

Send input bytes to the child process.

pub fn wait(&mut self) -> Result<ExitStatus>

Wait for the child to exit and return its status.

pub fn output(&self) -> &[u8]

Access all captured output so far.

pub fn child_pid(&self) -> Option<u32>

Child process id (if available on this platform).

pub fn drain_remaining(&mut self, timeout: Duration) -> Result<usize>

Drain all remaining output until EOF or timeout.

Call this after wait() to ensure all output from the child process has been captured. This is important because output may still be in transit through the PTY after the process exits.

Returns the total number of bytes drained.

pub fn wait_and_drain(&mut self, drain_timeout: Duration) -> Result<ExitStatus>

Wait for the child and drain all remaining output.

This is a convenience method that combines wait() with drain_remaining(). It ensures deterministic capture by waiting for both the child to exit AND all output to be received.

Trait Implementations

impl Debug for PtySession

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

Formats the value using the given formatter.

impl Drop for PtySession

fn drop(&mut self)

Executes the destructor for this type.