Struct StreamingRunner 

pub struct StreamingRunner { /* private fields */ }

A streaming process runner that allows async iteration over output

Implementations

impl StreamingRunner

pub fn new(command: impl Into<String>) -> Self

Create a streaming runner for a command string interpreted by the platform shell.

pub fn from_argv<P, I, S>(program: P, args: I) -> Self

where P: Into<OsString>, I: IntoIterator<Item = S>, S: Into<OsString>,

Create a streaming runner for an executable and exact argument vector.

Unlike StreamingRunner::new, this constructor bypasses the platform shell. Argument boundaries are therefore preserved on every platform, including Windows, without requiring shell-specific quoting.

pub fn cwd(self, path: impl Into<PathBuf>) -> Self

Set the working directory

pub fn env(self, env: HashMap<String, String>) -> Self

Set environment variables

pub fn stdin(self, content: impl Into<String>) -> Self

Set stdin content

pub fn kill_signal(self, signal: impl Into<String>) -> Self

Configure the signal used to stop the process when it is killed without an explicit signal — i.e. OutputStream::kill or abandoning the stream. Mirrors the JavaScript killSignal option (default SIGTERM).

The reported exit code follows the conventional 128 + signal mapping (e.g. SIGTERM => 143, SIGINT => 130, SIGKILL => 137).

pub fn exit_pump_grace_ms(self, ms: u64) -> Self

Configure the grace period (in milliseconds) to keep draining the stdio pipes after the process exits before aborting lingering readers. Mirrors the JavaScript exitPumpGrace option (default 100ms).

pub fn stream(self) -> OutputStream

Start the process and return a stream of output chunks

pub async fn collect(self) -> Result<CommandResult>

Run to completion and collect all output