Struct Options 

pub struct Options {

    pub cwd: Option<PathBuf>,
    pub env: Option<HashMap<String, String>>,
    pub shell: Option<String>,
    pub prefix: String,
    pub postfix: String,
    pub verbose: bool,
    pub quiet: bool,
    pub nothrow: bool,
    pub timeout: Option<Duration>,
    pub timeout_signal: String,
    pub kill_signal: String,
    pub prefer_local: PreferLocal,
    pub input: Option<Vec<u8>>,
    pub quote: QuoteFn,
}

Options controlling how commands are run (the fields of zx $).

Fields

cwd: Option<PathBuf>

Working directory; None means the process working directory.

env: Option<HashMap<String, String>>

Full environment; None inherits the process environment.

shell: Option<String>

Shell executable; None means no shell is available.

prefix: String

Text prepended to every command.

postfix: String

Text appended to every command.

verbose: bool

Log commands and their stdout to stderr.

quiet: bool

Suppress all logging, including the echo of the command’s stderr.

nothrow: bool

Resolve (return Ok) even when the command fails.

timeout: Option<Duration>

Kill the command after this long.

timeout_signal: String

Signal used when the timeout fires.

kill_signal: String

Default signal for RunningProcess::kill.

prefer_local: PreferLocal

Prepend local node_modules/.bin directories to PATH.

input: Option<Vec<u8>>

Data written to the command’s stdin.

quote: QuoteFn

Function used to quote interpolated arguments.

Implementations

impl Options

pub fn builtin() -> Self

Built-in defaults: bash (found via PATH, falling back to sh) with the set -euo pipefail; prefix, everything else off.

pub fn use_bash(&mut self)

Switch to bash: which bash (or sh), set -euo pipefail; prefix, no postfix, quote.

pub fn use_pwsh(&mut self)

Switch to pwsh with PowerShell quoting.

pub fn use_powershell(&mut self)

Switch to powershell.exe with PowerShell quoting.

pub fn resolve_env<I, K, V>(&mut self, prefix: &str, env: I)

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

Apply <prefix>* environment variables (camel-cased) onto the options.

Recognised names: cwd, preferLocal, verbose, quiet, timeout, timeoutSignal, killSignal, prefix, postfix, shell. Empty values and unknown names are ignored.

pub fn effective_cwd(&self) -> PathBuf

The effective working directory for spawned commands.

Trait Implementations

impl Clone for Options

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 Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.