Struct ProcessHandle 

pub struct ProcessHandle { /* private fields */ }

Handle to an in-flight streaming run. Caller stores it (e.g. in a runId-keyed map) so a later cancel() can find it.

Dropping the handle does NOT cancel the run — the reader threads + wait thread continue independently. Use cancel() explicitly when the user closes the connection.

Implementations

impl ProcessHandle

pub fn cancel(&self) -> Result<(), StreamError>

SIGTERM the process, then SIGKILL after 1.5s if it’s still alive. The CLI is supposed to flush a final result on SIGTERM but we don’t trust it to do so forever.

Platform behaviour

This ends the process it spawned, not that process’s descendants. On unix the distinction rarely bites: signalling a shell that execed its payload reaches the payload, because they are the same process. On Windows cancelling is TerminateProcess, which has no notion of a process tree — so a child that spawned its own children leaves them running, and because they inherited the stdout handle, the stream stays open and no Event::Exited arrives. Killing a tree there needs a Job Object, which this does not yet create.

pub fn write_line(&self, line: &str) -> Result<(), StreamError>

Send one line to the child’s stdin, newline-terminated and flushed.

There is only one stream a caller can write to, so the name does not repeat it — Stdin::Piped on the command is where that was said.

Err when the child was spawned with Stdin::Closed (the default), or when it has exited and the pipe is gone — both of which a caller expecting an answer needs to hear about rather than block on.

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

Send raw bytes to the child’s stdin, flushed.

write_line covers newline-delimited protocols, which most CLIs and MCP’s stdio transport use. This is for the ones that frame differently — LSP counts bytes in a Content-Length header, and a stray newline there is a protocol error.

pub fn was_cancelled(&self) -> bool

Whether cancel() was called. Tagged on the final Exited event.

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

The child’s OS process id while it’s alive, or None once it has been reaped (the Child is taken on exit). Lets an embedder record the pid so a child orphaned by a hard crash can be killed on the next launch.

Trait Implementations

impl Clone for ProcessHandle

fn clone(&self) -> ProcessHandle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProcessHandle

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

Formats the value using the given formatter.