Struct ShellJs 

pub struct ShellJs {
    pub config: Config,
    pub env: HashMap<String, String>,
    /* private fields */
}

A portable Rust counterpart of the ShellJS command-call interface. Arguments are individual values; command calls never concatenate them as shell syntax. Unlike JavaScript ShellJS, cwd changes affect this session only.

Fields

config: Config

Session configuration.

env: HashMap<String, String>

Environment used by commands.

Implementations

impl ShellJs

pub fn new() -> Self

Create a session rooted in the current directory.

pub fn cwd(&self) -> &Path

Current session directory.

pub fn error(&self) -> Option<&str>

Error text from the last command, or None after success.

pub fn error_code(&self) -> i32

Exit code of the last command.

pub async fn call( &mut self, command: &str, args: &[&str], ) -> Result<CommandResult>

Run a supported ShellJS command. Unsupported command names return 127; external programs use cmd (argv) or exec (explicit shell syntax).

pub async fn cat(&mut self, args: &[&str]) -> Result<CommandResult>

Run cat with separate argument values.

pub async fn chmod(&mut self, args: &[&str]) -> Result<CommandResult>

Run chmod with separate argument values.

pub async fn cp(&mut self, args: &[&str]) -> Result<CommandResult>

Run cp with separate argument values.

pub async fn echo(&mut self, args: &[&str]) -> Result<CommandResult>

Run echo with separate argument values.

pub async fn find(&mut self, args: &[&str]) -> Result<CommandResult>

Run find with separate argument values.

pub async fn grep(&mut self, args: &[&str]) -> Result<CommandResult>

Run grep with separate argument values.

pub async fn head(&mut self, args: &[&str]) -> Result<CommandResult>

Run head with separate argument values.

pub async fn ln(&mut self, args: &[&str]) -> Result<CommandResult>

Run ln with separate argument values.

pub async fn ls(&mut self, args: &[&str]) -> Result<CommandResult>

Run ls with separate argument values.

pub async fn mkdir(&mut self, args: &[&str]) -> Result<CommandResult>

Run mkdir with separate argument values.

pub async fn mv(&mut self, args: &[&str]) -> Result<CommandResult>

Run mv with separate argument values.

pub async fn pwd(&mut self, args: &[&str]) -> Result<CommandResult>

Run pwd with separate argument values.

pub async fn rm(&mut self, args: &[&str]) -> Result<CommandResult>

Run rm with separate argument values.

pub async fn sed(&mut self, args: &[&str]) -> Result<CommandResult>

Run sed with separate argument values.

pub async fn sort(&mut self, args: &[&str]) -> Result<CommandResult>

Run sort with separate argument values.

pub async fn tail(&mut self, args: &[&str]) -> Result<CommandResult>

Run tail with separate argument values.

pub async fn touch(&mut self, args: &[&str]) -> Result<CommandResult>

Run touch with separate argument values.

pub async fn uniq(&mut self, args: &[&str]) -> Result<CommandResult>

Run uniq with separate argument values.

pub async fn which(&mut self, args: &[&str]) -> Result<CommandResult>

Run which with separate argument values.

pub async fn basename(&mut self, args: &[&str]) -> Result<CommandResult>

Run basename with separate argument values.

pub async fn dirname(&mut self, args: &[&str]) -> Result<CommandResult>

Run dirname with separate argument values.

pub async fn sleep(&mut self, args: &[&str]) -> Result<CommandResult>

Run sleep with separate argument values.

pub async fn env(&mut self, args: &[&str]) -> Result<CommandResult>

Run env with separate argument values.

pub async fn seq(&mut self, args: &[&str]) -> Result<CommandResult>

Run seq with separate argument values.

pub async fn tee(&mut self, args: &[&str]) -> Result<CommandResult>

Run tee with separate argument values.

pub async fn cd(&mut self, args: &[&str]) -> Result<CommandResult>

Change this session’s directory without changing the host process cwd.

pub async fn test(&mut self, args: &[&str]) -> Result<bool>

Evaluate a file test, returning a boolean.

pub async fn cmd( &mut self, program: &str, args: &[&str], ) -> Result<CommandResult>

Execute a program with exact arguments, bypassing the shell.

pub async fn exec(&mut self, command: &str) -> Result<CommandResult>

Execute an explicitly supplied shell command.

pub fn dirs(&self) -> CommandResult

List the current directory followed by the saved directory stack.

pub async fn pushd(&mut self, args: &[&str]) -> Result<CommandResult>

Save the current directory and change to the provided directory.

pub async fn popd(&mut self) -> Result<CommandResult>

Restore the most recently saved directory.

pub fn tempdir(&self) -> PathBuf

Return the platform temporary directory.

pub fn set(&mut self, option: &str) -> Result<CommandResult>

Set fatal (-e/+e), verbose (-v/+v) or glob (-f/+f) modes.

pub async fn to( &mut self, result: &CommandResult, path: &str, append: bool, ) -> Result<CommandResult>

Write captured stdout to a file (append=true corresponds to toEnd).

pub fn command(&self, name: &str, args: &[&str]) -> String

Build a safely quoted native command for explicit mixed pipelines.

Trait Implementations

impl Debug for ShellJs

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

Formats the value using the given formatter.

impl Default for ShellJs

fn default() -> Self

Returns the “default value” for a type.