Struct bitbazaar::cli::Bash

pub struct Bash { /* private fields */ }

Execute an arbitrary bash script.

WARNING: this opens up the possibility of dependency injection attacks, so should only be used when the command is trusted. If compiled usage is all that’s needed, use something like rust_cmd_lib instead, which only provides a macro literal interface. https://github.com/rust-shell-script/rust_cmd_lib

This is a pure rust implementation and doesn’t rely on bash being available to make it compatible with windows. Given that, it only implements a subset of bash features, and is not intended to be a full bash implementation.

Purposeful deviations from bash:

• set -e is enabled by default, each cmd line will stop if it fails

Assume everything is unimplemented unless stated below:

• && and
• || or
• ! exit code negation
• | pipe
• ~ home dir
• foo=bar param setting
• $foo param substitution
• $(echo foo) command substitution
• ' quotes
• " double quotes
• \ escaping
• (...) simple compound commands e.g. (echo foo && echo bar)
• Basic file/stderr/stdout redirection

This should theoretically work with multi line full bash scripts but only tested with single line commands.

Implementations

impl Bash

pub fn new() -> Self

Create a new Bash builder.

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

Add a new piece of logic to the bash script. E.g. a line of bash.

Multiple commands added to a Bash instance will be treated as newline separated.

pub fn chdir(self, root_dir: &Path) -> Self

Set the root directory to run the commands in.

By default, the current process’s root directory is used.

pub fn env(self, name: impl Into<String>, val: impl Into<String>) -> Self

Add an environment variable to the bash script.

pub fn run(self) -> RResult<BashOut, BashErr>

Execute the current contents of the bash script.

Trait Implementations

impl Default for Bash

fn default() -> Self

Returns the “default value” for a type.