Struct Command 

pub struct Command { /* private fields */ }

Structured description of an external command to run.

Command stores a program and argument vector instead of parsing a shell-like command line. This avoids quoting ambiguity and accidental shell injection. Use Self::shell only when shell parsing, redirection, expansion, or pipes are intentionally required.

Author

Haixing Hu

Implementations

impl Command

pub fn new(program: &str) -> Self

Creates a command from a program name or path.

Parameters

• program - Executable name or path to run.

Returns

A command with no arguments or per-command overrides.

pub fn new_os<S>(program: S) -> Self

where S: AsRef<OsStr>,

Creates a command from a program name or path that may not be UTF-8.

Parameters

• program - Executable name or path to run.

Returns

A command with no arguments or per-command overrides.

pub fn shell(command_line: &str) -> Self

Creates a command executed through the platform shell.

On Unix-like platforms this creates sh -c <command_line>. On Windows this creates cmd /C <command_line>. Prefer Self::new with explicit arguments when shell parsing is not required.

Parameters

• command_line - Shell command line to execute.

Returns

A command that invokes the platform shell.

pub fn arg(self, arg: &str) -> Self

Adds one positional argument.

Parameters

• arg - Argument to append.

Returns

The updated command.

pub fn arg_os<S>(self, arg: S) -> Self

where S: AsRef<OsStr>,

Adds one positional argument that may not be UTF-8.

Parameters

• arg - Argument to append.

Returns

The updated command.

pub fn args(self, args: &[&str]) -> Self

Adds multiple positional arguments.

Parameters

• args - Arguments to append in order.

Returns

The updated command.

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

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Adds multiple positional arguments that may not be UTF-8.

Parameters

• args - Arguments to append in order.

Returns

The updated command.

pub fn working_directory<P>(self, working_directory: P) -> Self

where P: Into<PathBuf>,

Sets a per-command working directory.

Parameters

• working_directory - Directory used as the child process working directory.

Returns

The updated command.

pub fn env(self, key: &str, value: &str) -> Self

Adds or overrides an environment variable for this command.

Parameters

• key - Environment variable name.
• value - Environment variable value.

Returns

The updated command.

pub fn env_os<K, V>(self, key: K, value: V) -> Self

where K: AsRef<OsStr>, V: AsRef<OsStr>,

Adds or overrides an environment variable that may not be UTF-8.

Parameters

• key - Environment variable name.
• value - Environment variable value.

Returns

The updated command.

pub fn env_remove(self, key: &str) -> Self

Removes an inherited or previously configured environment variable.

Parameters

• key - Environment variable name to remove.

Returns

The updated command.

pub fn env_remove_os<S>(self, key: S) -> Self

where S: AsRef<OsStr>,

Removes an environment variable whose name may not be UTF-8.

Parameters

• key - Environment variable name to remove.

Returns

The updated command.

pub fn env_clear(self) -> Self

Clears all inherited environment variables for this command.

Environment variables added after this call are still passed to the child process.

Returns

The updated command.

pub fn stdin_null(self) -> Self

Connects the command stdin to null input.

Returns

The updated command.

pub fn stdin_inherit(self) -> Self

Inherits stdin from the parent process.

Returns

The updated command.

pub fn stdin_bytes<B>(self, bytes: B) -> Self

where B: Into<Vec<u8>>,

Writes bytes to the child process stdin.

The runner writes the bytes on a helper thread after spawning the child process, then closes stdin so the child can observe EOF.

Parameters

• bytes - Bytes to send to stdin.

Returns

The updated command.

pub fn stdin_file<P>(self, path: P) -> Self

where P: Into<PathBuf>,

Reads child process stdin from a file.

Parameters

• path - File path to open and connect to stdin.

Returns

The updated command.

pub fn program(&self) -> &OsStr

Returns the executable name or path.

Returns

Program executable name or path as an OsStr.

pub fn arguments(&self) -> &[OsString]

Returns the configured argument list.

Returns

Borrowed argument list in submission order.

pub fn working_directory_override(&self) -> Option<&Path>

Returns the per-command working directory override.

Returns

Some(path) when the command has a working directory override, or None when the runner default should be used.

pub fn environment(&self) -> &[(OsString, OsString)]

Returns environment variable overrides.

Returns

Borrowed environment variable entries in insertion order.

pub fn removed_environment(&self) -> &[OsString]

Returns environment variable removals.

Returns

Borrowed environment variable names removed before spawning the command.

pub const fn clears_environment(&self) -> bool

Returns whether the inherited environment is cleared.

Returns

true when the command should start from an empty environment.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate 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 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 Eq for Command

impl StructuralPartialEq for Command