Struct Cmd 

pub struct Cmd { /* private fields */ }

Builder for a subprocess invocation.

Construct via Cmd::new, configure with builder methods, terminate with Cmd::run. Every knob composes with every other — timeout + env + retry

• stdin work together without combinatorial API explosion.

Implementations

impl Cmd

pub fn new(program: impl Into<OsString>) -> Cmd

Start a new command with the given program.

pub fn arg(self, arg: impl Into<OsString>) -> Cmd

Append a single argument.

pub fn args<I, S>(self, args: I) -> Cmd

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

Append arguments.

pub fn in_dir(self, dir: impl AsRef<Path>) -> Cmd

Set the working directory.

pub fn env(self, key: impl Into<OsString>, value: impl Into<OsString>) -> Cmd

Add one environment variable.

pub fn envs<I, K, V>(self, vars: I) -> Cmd

where I: IntoIterator<Item = (K, V)>, K: Into<OsString>, V: Into<OsString>,

Add multiple environment variables.

pub fn env_remove(self, key: impl Into<OsString>) -> Cmd

Remove an environment variable (applied after inherited env).

pub fn env_clear(self) -> Cmd

Clear the entire inherited environment; only .env() / .envs() reach the child.

pub fn stdin(self, data: impl Into<StdinData>) -> Cmd

Feed data into the child’s stdin.

Accepts Vec<u8>, &[u8], String, &str, or StdinData::from_reader for streaming input. Owned bytes are re-fed on each retry; readers are one-shot.

pub fn stderr(self, mode: Redirection) -> Cmd

Configure stderr routing. Default is Redirection::Capture.

pub fn timeout(self, timeout: Duration) -> Cmd

Kill this attempt after the given duration.

pub fn deadline(self, deadline: Instant) -> Cmd

Kill if not done by this instant (composes across retries).

pub fn retry(self, policy: RetryPolicy) -> Cmd

Attach a RetryPolicy. Defaults retry up to 3× on transient errors.

pub fn retry_when( self, f: impl Fn(&RunError) -> bool + Send + Sync + 'static, ) -> Cmd

Replace the retry predicate without changing the backoff schedule.

If no RetryPolicy is set yet, this installs the default policy and then overrides its predicate.

pub fn secret(self) -> Cmd

Mark this command as containing secrets.

CmdDisplay and RunError render args as <secret> instead of their values. Useful for docker login, kubectl --token=…, etc.

pub fn before_spawn<F>(self, hook: F) -> Cmd

where F: Fn(&mut Command) -> Result<(), Error> + Send + Sync + 'static,

Register a hook called immediately before each spawn attempt.

pub fn to_command(&self) -> Command

Build a raw std::process::Command mirroring this Cmd’s configuration.

Escape hatch for cases procpilot’s builder doesn’t cover. Does not apply stdin data, timeout, retry, or stderr redirection — those are runner-level concerns.

pub fn display(&self) -> CmdDisplay

Snapshot the command for display/logging.

pub fn run(self) -> Result<RunOutput, RunError>

Run the command, blocking until it completes (or times out).

Trait Implementations

impl Debug for Cmd

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

Formats the value using the given formatter.