Struct PtyHandle 

pub struct PtyHandle { /* private fields */ }

Async-friendly wrapper around a PTY master/child pair.

The reader runs on a blocking Tokio thread and pushes raw byte chunks into an unbounded mpsc channel. Consumers drain the channel via try_read_output().

Implementations

impl PtyHandle

pub fn spawn( command: &str, working_dir: Option<&str>, env: HashMap<String, String>, rows: u16, cols: u16, ) -> Result<PtyHandle, RuntimeError>

Spawn a command on a new PTY.

Arguments

• command — the program (and optional arguments) to run, e.g. "bash" or "ssh user@host".
• working_dir — optional working directory for the child process.
• env — additional environment variables (merged on top of inherited env).
• rows / cols — initial terminal dimensions.

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

Write raw bytes to the PTY (reaches the child’s stdin).

pub async fn try_read_output(&mut self, timeout: Duration) -> Vec<u8>

Read all available output from the PTY, waiting up to timeout for data.

Behavior:

1. Drain everything currently in the channel (non-blocking).
2. If nothing was found, wait up to timeout for the first chunk.
3. After getting something (or timing out), drain any remaining buffered data.

Returns an empty Vec if no data arrived within the timeout.

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

Resize the PTY to new dimensions.

pub fn is_alive(&mut self) -> bool

Check whether the child process is still running.

Once the child exits, subsequent calls return false without syscalls.

Trait Implementations

impl Drop for PtyHandle

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.