Struct Command

pub struct Command {
    pub envs: Option<HashMap<String, String>>,
    pub current_dir: Option<PathBuf>,
    pub stdin: Option<Stdio>,
    pub stdout: Option<Stdio>,
    pub stderr: Option<Stdio>,
    pub expand: bool,
    /* private fields */
}

The command builder.

The aim of this builder is to be able to declare a command using the same API from std::process::Command, without any I/O interaction. I/O connectors can then take data from this builder to build I/O-specific commands.

Refs: std::process::Command

Fields

envs: Option<HashMap<String, String>>

Environment variables explicitly set for the child process.

Refs: std::process::Command::get_envs

current_dir: Option<PathBuf>

Working directory of the child process.

Refs: std::process::Command::get_current_dir

stdin: Option<Stdio>

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

Refs: std::process::Command::stdin

stdout: Option<Stdio>

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

Refs: std::process::Command::stdout

stderr: Option<Stdio>

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

Refs: std::process::Command::stderr

expand: bool

Available on crate feature expand only.

Should shell-expand program and arguments.

When true, tilde ~ and environment variables $ENV are expanded for the program and arguments only.

Requires the expand cargo feature.

Implementations

impl Command

pub fn new<S: ToString>(program: S) -> Self

Constructs a new Command for launching the program at path program. This is just a builder, it does not launch any program on its own. Only I/O connectors do spawn processes.

Refs: std::process::Command::new

pub fn expand<'a>(&self, input: &'a str) -> Cow<'a, str>

Available on crate feature expand only.

pub fn get_program(&self) -> Cow<'_, str>

Gets the program as str Cow.

If the expand cargo feature is enabled, and Command::expand is true, then program is also shell-expanded.

pub fn arg<S: ToString>(&mut self, arg: S) -> &mut Self

Adds an argument to pass to the program.

Refs: std::process::Command::arg

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

where I: IntoIterator<Item = S>, S: ToString,

Adds multiple arguments to pass to the program.

Refs: std::process::Command::args

pub fn get_args(&self) -> Option<Vec<Cow<'_, str>>>

Gets the arguments as str Cows.

If the expand cargo feature is enabled, and Command::expand is true, then arguments are also shell-expanded.

pub fn env<K, V>(&mut self, key: K, val: V) -> &mut Self

where K: ToString, V: ToString,

Inserts or updates an explicit environment variable mapping.

Refs: std::process::Command::env

pub fn envs<I, K, V>(&mut self, vars: I) -> &mut Self

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

Inserts or updates multiple explicit environment variable mappings.

Refs: std::process::Command::envs

pub fn env_remove<K: AsRef<str>>(&mut self, key: K) -> &mut Self

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

Refs: std::process::Command::env_remove

pub fn env_clear(&mut self) -> &mut Self

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

Refs: std::process::Command::env_clear

pub fn current_dir<P: Into<PathBuf>>(&mut self, dir: P) -> &mut Self

Sets the working directory for the child process.

Refs: std::process::Command::current_dir

pub fn stdin<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command

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

Refs: std::process::Command::stdin

pub fn stdout<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command

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

Refs: std::process::Command::stdout

pub fn stderr<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command

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

Refs: std::process::Command::stderr

Trait Implementations

impl Clone for Command

fn clone(&self) -> Self

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 Default for Command

fn default() -> Command

Returns the “default value” for a type.

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

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>( deserializer: D, ) -> Result<Command, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<Command> for Command

Available on crate feature std only.

Converts a Command builder to a std::process::Command.

fn from(builder: Command) -> Self

Converts to this type from the input type.

impl From<Command> for Command

Available on crate feature tokio only.

Converts a Command builder to a std::process::Command.

fn from(builder: Command) -> Self

Converts to this type from the input type.

impl PartialEq for Command

fn eq(&self, other: &Self) -> 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

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Command