Struct ProcessHandle 

pub struct ProcessHandle { /* private fields */ }

Handle for driving an interactive or non-interactive process.

This provides a unified interface for both PTY and pipe-based processes:

• Write to stdin via writer_sender()
• Read merged stdout/stderr via output_receiver()
• Check exit status via has_exited() and exit_code()
• Clean up via terminate()

Implementations

impl ProcessHandle

pub fn writer_sender(&self) -> Sender<Vec<u8>>

Returns a channel sender for writing raw bytes to the child stdin.

Example

let writer = handle.writer_sender();
writer.send(b"input\n".to_vec()).await?;

pub fn output_receiver(&self) -> Receiver<Bytes>

Returns a broadcast receiver that yields stdout/stderr chunks.

Multiple receivers can be created; each receives all output from the point of subscription.

pub fn has_exited(&self) -> bool

True if the child process has exited.

pub fn exit_code(&self) -> Option<i32>

Returns the exit code if the process has exited.

pub fn is_output_drained(&self) -> bool

True once the stdout/stderr reader task has drained the child streams.

pub fn terminate(&self)

Attempts to kill the child and abort helper tasks.

This is idempotent and safe to call multiple times.

pub fn terminate_process(&self)

Kill the child process group without aborting the readers or wait task.

Session owners use this path when they still need to drain output and reap the child after termination. Call Self::terminate when the caller is abandoning the session and does not need that final drain.

pub fn is_running(&self) -> bool

Check if the process is still running.

pub async fn write( &self, bytes: impl Into<Vec<u8>>, ) -> Result<(), SendError<Vec<u8>>>

Send bytes to the process stdin.

Returns an error if the stdin channel is closed.

pub fn is_writer_closed(&self) -> bool

Check if the writer channel is closed.

Trait Implementations

impl Debug for ProcessHandle

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

Formats the value using the given formatter.

impl Drop for ProcessHandle

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.