Struct SpawnOptionsBuilder 

pub struct SpawnOptionsBuilder { /* private fields */ }

Builder for SpawnOptions.

Implementations

impl SpawnOptionsBuilder

pub fn new(argv: Vec<String>, backend: SpawnBackend) -> Self

Create a new builder with the specified argument vector.

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

Set environment variables.

pub fn cwd(self, cwd: String) -> Self

Set the working directory.

pub fn stdin(self, data: impl Into<Box<[u8]>>) -> Self

Provide data to be written to the child’s stdin.

pub fn capture_stdout(self) -> Self

Enable stdout capture.

Examples found in repository

examples/spawn_ls.rs (line 10)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("Spawning '/bin/ls -l'...");

    let output = SpawnOptions::builder(
        vec!["/bin/ls".to_string(), "-l".to_string()],
        SpawnBackend::PosixSpawn,
    )
    .capture_stdout()
    .timeout_ms(5000)
    .build()?
    .run()?;

    println!("Exit status: {:?}", output.status);
    println!("Output length: {} bytes", output.stdout.len());
    println!("--- STDOUT ---");
    println!("{}", String::from_utf8_lossy(&output.stdout));
    println!("--------------");

    Ok(())
}

pub fn capture_stderr(self) -> Self

Enable stderr capture.

pub fn wait(self, wait: bool) -> Self

Set whether to wait for the process to terminate (default: true).

pub fn pgroup(self, pgroup: ProcessGroup) -> Self

Set process group and isolation policy.

pub fn session_containment(self) -> Self

Contain the child inside the process group/session it is placed into.

A seccomp filter installed in the child (after the daemon’s own setsid/setpgid, before execve) denies setsid, setpgid, setpgrp, unshare, and setns. Because filters are inherited across fork and execve and can only be tightened, never loosened, the child and every descendant are locked into the group/session — making kill_group (timeout/cancel deactivation) total even against a hostile root child that tries to escape by daemonizing or changing its process group. Requires an isolated process group (ProcessGroup::new(None, true)); rejected on SpawnBackend::PosixSpawn, which has no child setup step.

pub fn max_output(self, max: usize) -> Self

Set the combined stdout+stderr output buffer size (default: 1MB).

If captured output exceeds this limit, spawn drains the child pipes to completion and returns EOVERFLOW.

pub fn timeout_ms(self, ms: u32) -> Self

Set the execution timeout in milliseconds.

Examples found in repository

examples/spawn_ls.rs (line 11)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("Spawning '/bin/ls -l'...");

    let output = SpawnOptions::builder(
        vec!["/bin/ls".to_string(), "-l".to_string()],
        SpawnBackend::PosixSpawn,
    )
    .capture_stdout()
    .timeout_ms(5000)
    .build()?
    .run()?;

    println!("Exit status: {:?}", output.status);
    println!("Output length: {} bytes", output.stdout.len());
    println!("--- STDOUT ---");
    println!("{}", String::from_utf8_lossy(&output.stdout));
    println!("--------------");

    Ok(())
}

pub fn kill_grace_ms(self, ms: u32) -> Self

Set the grace period before SIGKILL (default: 2s).

pub fn cancel(self, policy: CancelPolicy) -> Self

Set the cancellation policy (default: Kill).

pub fn fd_policy(self, policy: SpawnFdPolicy) -> Self

Set the child file-descriptor inheritance policy.

pub fn early_exit(self, callback: fn(&[u8]) -> bool) -> Self

Set an early exit callback.

pub fn chunk_sink<F>(self, sink: F) -> Self

where F: Fn(bool, &[u8]) -> SinkResult + Send + Sync + 'static,

Enable streaming drain: forward every retained output chunk to sink as it is read instead of accumulating it for the completion Output.

The sink returns SinkResult::Pause when its bounded queue is full; the drain then stops reading the child (kernel backpressure applies) without dropping the held chunk and without blocking the reactor. Resume via the managed-process or drain resume methods once the queue drains. When a sink is set, max_output no longer truncates: bytes are never dropped on the streaming path.

pub fn pty(self) -> Self

Spawn the child on a pseudo-terminal (see SpawnOptions::pty).

Mutually exclusive with pipe capture: the slave replaces capture_stdout/capture_stderr/stdin as the child’s stdio, and the master replaces the stdout pipe on the drain (single merged stream).

pub fn build(self) -> Result<SpawnOptions, CoreError>

Build the spawn options.

Examples found in repository

examples/spawn_ls.rs (line 12)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("Spawning '/bin/ls -l'...");

    let output = SpawnOptions::builder(
        vec!["/bin/ls".to_string(), "-l".to_string()],
        SpawnBackend::PosixSpawn,
    )
    .capture_stdout()
    .timeout_ms(5000)
    .build()?
    .run()?;

    println!("Exit status: {:?}", output.status);
    println!("Output length: {} bytes", output.stdout.len());
    println!("--- STDOUT ---");
    println!("{}", String::from_utf8_lossy(&output.stdout));
    println!("--------------");

    Ok(())
}

Trait Implementations

impl Clone for SpawnOptionsBuilder

fn clone(&self) -> SpawnOptionsBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.