Struct InteractivePtySession 

pub struct InteractivePtySession { /* private fields */ }

Re-exported native PTY process and interactive session types. Canonical interactive PTY recipe for downstream Rust consumers.

NativePtyProcess remains the low-level primitive. This wrapper owns the interactive setup that callers commonly forget to assemble correctly.

Implementations

impl InteractivePtySession

pub fn new(process: NativePtyProcess) -> Self

Create an interactive PTY session with default options.

pub fn with_options( process: NativePtyProcess, options: InteractivePtyOptions, ) -> Self

Create an interactive PTY session with explicit options.

pub fn process(&self) -> &NativePtyProcess

Return the wrapped low-level PTY process.

pub fn start(&self) -> Result<(), PtyError>

Start the wrapped PTY process and configured interactive helpers.

pub fn pump_output( &self, timeout: Option<f64>, consume_all: bool, ) -> Result<InteractivePtyPumpResult, PtyError>

Read and optionally drain available PTY output.

When query responses are enabled, terminal queries in each chunk are answered before the chunk is returned.

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

Resize the interactive PTY.

pub fn send_interrupt(&self) -> Result<(), PtyError>

Send an interrupt to the interactive PTY child.

pub fn wait(&self, timeout: Option<f64>) -> Result<i32, PtyError>

Wait for the interactive PTY child to exit.

pub fn wait_and_drain( &self, timeout: Option<f64>, drain_timeout: f64, ) -> Result<i32, PtyError>

Wait for the child to exit, then drain remaining PTY output.

pub fn terminate(&self) -> Result<(), PtyError>

Request graceful termination of the interactive PTY child.

pub fn kill(&self) -> Result<(), PtyError>

Forcefully terminate the interactive PTY child.

pub fn close(&self) -> Result<(), PtyError>

Close the interactive PTY session.