Struct Shell 

pub struct Shell { /* private fields */ }

A command factory carrying Options (the zx $).

Shell::new() snapshots the current scope; the builder methods return a modified copy (zx presets such as $({verbose: true})).

Implementations

impl Shell

pub fn new() -> Self

A shell using the options of the current scope.

pub fn with_options(opts: Options) -> Self

A shell with explicit options.

pub fn options(&self) -> &Options

The options used by this shell.

pub fn options_mut(&mut self) -> &mut Options

Mutable access to the options.

pub fn cwd(self, v: impl AsRef<Path>) -> Self

Set the working directory.

pub fn env(self, v: HashMap<String, String>) -> Self

Replace the whole environment.

pub fn shell(self, v: impl Into<String>) -> Self

Set the shell executable.

pub fn prefix(self, v: impl Into<String>) -> Self

Set the command prefix.

pub fn postfix(self, v: impl Into<String>) -> Self

Set the command postfix.

pub fn verbose(self, v: bool) -> Self

Enable or disable verbose logging.

pub fn quiet(self, v: bool) -> Self

Enable or disable quiet mode.

pub fn nothrow(self, v: bool) -> Self

Do not fail on non-zero exit codes.

pub fn timeout(self, v: Duration) -> Self

Kill commands after timeout.

pub fn timeout_signal(self, v: impl Into<String>) -> Self

Signal used on timeout.

pub fn kill_signal(self, v: impl Into<String>) -> Self

Default signal for kill().

pub fn prefer_local(self, v: bool) -> Self

Prepend <cwd>/node_modules/.bin to PATH when true.

pub fn prefer_local_dirs(self, v: Vec<PathBuf>) -> Self

Prepend <dir>/node_modules/.bin for each of dirs to PATH.

pub fn input(self, v: impl Into<Vec<u8>>) -> Self

Data written to stdin of every command.

pub fn quote_with(self, v: QuoteFn) -> Self

Use a custom quoting function.

pub fn env_var(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set a single environment variable (seeding from the process environment when no explicit environment was configured yet).

pub fn use_bash(self) -> Self

Switch to bash.

pub fn use_pwsh(self) -> Self

Switch to pwsh.

pub fn use_powershell(self) -> Self

Switch to powershell.exe.

pub fn cmd<S: AsRef<str>>(&self, pieces: &[S], args: &[ZxArg]) -> ProcessPromise

Build a command from template pieces and arguments (the zx tagged template). Arguments are quoted with the shell’s quote function.

pub fn command(&self, cmd: impl Into<String>) -> ProcessPromise

Build a command from a raw string (no interpolation, no quoting).

Trait Implementations

impl Clone for Shell

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 Shell

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

Formats the value using the given formatter.

impl Default for Shell

fn default() -> Self

Returns the “default value” for a type.