Struct Command

pub struct Command {
    pub name: OsString,
    pub arguments: Vec<OsString>,
    pub inherit_environment: bool,
    pub environment: HashMap<OsString, Option<OsString>>,
    pub current_dir: Option<PathBuf>,
    pub stdin: Option<Stdio>,
    pub stdout: Option<Stdio>,
    pub stderr: Option<Stdio>,
}

A process builder, providing fine-grained control over how a new process should be spawned. Equivalent to std’s Command but allowing field access cloning and serialization.

Fields

name: OsString

Name of the program invoked.

arguments: Vec<OsString>

Arguments passed to the child process.

inherit_environment: bool

Controlls whether the child process will inherit the parent process’ environment.

environment: HashMap<OsString, Option<OsString>>

Environment for the child process, None represents variables that will not be inherited from the parent, even when inherit_environment == true.

current_dir: Option<PathBuf>

Working directory for the child process.

stdin: Option<Stdio>

Child process’ standard input (stdin) handle, None will use default for invocation type.

stdout: Option<Stdio>

Child process’ standard output (stdout) handle, None will use default for invocation type.

stderr: Option<Stdio>

Child process’ standard error (stderr) handle, None will use default for invocation type.

Implementations

impl Command

Builder

pub fn new(name: impl AsRef<OsStr>) -> Self

Constructs a new Command. more

pub fn arg(self, arg: impl AsRef<OsStr>) -> Self

Adds an argument to pass to the program. more

pub fn args(self, args: impl IntoIterator<Item = impl AsRef<OsStr>>) -> Self

Adds multiple arguments to pass to the program. more

pub fn env(self, key: impl AsRef<OsStr>, val: impl AsRef<OsStr>) -> Self

Inserts or updates an environment variable. more

pub fn envs( self, vars: impl IntoIterator<Item = (impl AsRef<OsStr>, impl AsRef<OsStr>)>, ) -> Self

Inserts or updates multiple environment variables. more

pub fn env_remove(self, key: impl AsRef<OsStr>) -> Self

Removes an explicitly set environment variable and prevents inheriting it from a parent process. more

pub fn env_clear(self) -> Self

Clears all explicitly set environment variables and prevents inheriting any parent process environment variables. more

pub fn env_no_inherit(self) -> Self

Prevents inheriting any parent process environment variables (like env_clear without clearing set envs).

pub fn current_dir(self, key: impl AsRef<Path>) -> Self

Sets the working directory for the child process. more

pub fn stdin(self, stdin: Stdio) -> Self

Configuration for the child process’s standard input (stdin) handle. more

pub fn stdout(self, stdout: Stdio) -> Self

Configuration for the child process’s standard output (stdout) handle. more

pub fn stderr(self, stderr: Stdio) -> Self

Configuration for the child process’s standard error (stderr) handle. more

impl Command

Setters

pub fn add_arg(&mut self, arg: impl AsRef<OsStr>)

Adds an argument to pass to the program. more

pub fn add_args(&mut self, args: impl IntoIterator<Item = impl AsRef<OsStr>>)

Adds multiple arguments to pass to the program. more

pub fn set_env(&mut self, key: impl AsRef<OsStr>, val: impl AsRef<OsStr>)

Inserts or updates an environment variable. more

pub fn set_envs( &mut self, vars: impl IntoIterator<Item = (impl AsRef<OsStr>, impl AsRef<OsStr>)>, )

Inserts or updates multiple environment variables. more

pub fn remove_env(&mut self, key: impl AsRef<OsStr>)

Removes an explicitly set environment variable and prevents inheriting it from a parent process. more

pub fn set_current_dir(&mut self, path: impl AsRef<Path>)

Sets the working directory for the child process. more

impl Command

Execution

pub fn spawn(&self) -> Result<Child>

Behaves identical to std’s Command::spawn.

pub fn output(&self) -> Result<Output>

Behaves identical to std’s Command::output.

pub fn status(&self) -> Result<ExitStatus>

Behaves identical to std’s Command::status.

pub fn to_std(&self) -> StdCommand

Convert this command to a std::process::Command.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Command> for Command

fn from(_: &Command) -> Self

Converts to this type from the input type.

impl PartialEq for Command

fn eq(&self, other: &Command) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Command

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Command

impl StructuralPartialEq for Command