Struct Cmd

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.

Source

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

Configure stderr routing. Default is Redirection::Capture.

Source

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

Kill this attempt after the given duration.

Source

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

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

Source

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

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

Source

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

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.

Source

pub fn secret(self) -> Self

Mark this command as containing secrets.

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

Source

pub fn before_spawn<F>(self, hook: F) -> Self
where F: Fn(&mut Command) -> Result<()> + Send + Sync + 'static,

Register a hook called immediately before each spawn attempt.

Source

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.

Source

pub fn display(&self) -> CmdDisplay

Snapshot the command for display/logging.

Source

pub fn spawn(self) -> Result<SpawnedProcess, RunError>

Spawn the command as a long-lived process handle.

Returns a SpawnedProcess for streaming, bidirectional protocols, or any case where you need live access to stdin/stdout. Stdin and stdout are always piped; stderr follows the configured Redirection (default Redirection::Capture, drained into a background thread and surfaced on SpawnedProcess::wait).

If stdin bytes were set via stdin, they’re fed automatically in a background thread; otherwise the caller can pipe data via SpawnedProcess::take_stdin.

timeout, deadline, and retry are ignored on this path — they only apply to the one-shot run method. Use SpawnedProcess::wait_timeout or SpawnedProcess::kill for per-call bounds.

Source

pub fn spawn_and_collect_lines<F>(self, f: F) -> Result<RunOutput, RunError>
where F: FnMut(&str) -> Result<()>,

Spawn and invoke f for each line of stdout as it arrives.

Returns the final RunOutput when the child exits, or a RunError::NonZeroExit if it exited non-zero. If f returns an error, the child is killed and the error is surfaced as RunError::Spawn.

Cmd::new("cargo")
    .args(["check", "--message-format=json"])
    .spawn_and_collect_lines(|line| {
        println!("{line}");
        Ok(())
    })?;

Source