Enum Redirection 

#[non_exhaustive]
pub enum Redirection {
    Capture,
    Inherit,
    Null,
    File(Arc<File>),
}

Where a child process’s stdout or stderr goes.

The stderr default is Capture (every error variant carries captured stderr, so that’s almost always what you want). The stdout default is also Capture for Cmd::run — the bytes end up in RunOutput::stdout.

For Cmd::spawn, stdout is always piped internally so callers can take_stdout or read through the handle; a non-Capture stdout redirection here is not currently supported on the spawn path.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Capture

Capture into memory (default). Available in RunOutput on success and in error variants on failure.

Inherit

Inherit the parent’s file descriptor. Useful when the child should prompt the user (e.g., ssh password prompts) or when the user should see live progress.

Null

Discard (/dev/null). The corresponding captured field will be empty.

File(Arc<File>)

Redirect to a file. The Arc lets Cmd stay Clone — the underlying file is try_clone()d per spawn so every stage / retry gets its own file descriptor. Construct via Redirection::file to avoid wrapping the Arc by hand.

Implementations

impl Redirection

pub fn file(f: File) -> Redirection

Build a File variant from a std::fs::File, wrapping it in Arc internally. Prefer this over constructing the variant directly.

Trait Implementations

impl Clone for Redirection

fn clone(&self) -> Redirection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Redirection

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

Formats the value using the given formatter.

impl Default for Redirection

fn default() -> Redirection

Returns the “default value” for a type.