Struct Shell

Source

pub struct Shell { /* private fields */ }

Expand description

A Shell is the main API entry point.

Almost all of the crate’s functionality is available as methods of the Shell object.

Shell is a stateful object. It maintains a logical working directory and an environment map. They are independent from process’s std::env::current_dir and std::env::var, and only affect paths and commands passed to the Shell.

By convention, variable holding the shell is named sh.

§Example

use xshell::{cmd, Shell};

let sh = Shell::new()?;
let _d = sh.push_dir("./target");
let cwd = sh.current_dir();
cmd!(sh, "echo current dir is {cwd}").run()?;

let process_cwd = std::env::current_dir().unwrap();
assert_eq!(cwd, process_cwd.join("./target"));

Implementations§

Source §

impl Shell

Source

pub fn new() -> Result<Shell>

Creates a new Shell.

Fails if std::env::current_dir returns an error.

Source

pub fn current_dir(&self) -> PathBuf

Returns the working directory for this Shell.

All relative paths are interpreted relative to this directory, rather than std::env::current_dir.

Source

pub fn change_dir<P: AsRef<Path>>(&self, dir: P)

Changes the working directory for this Shell.

Note that this doesn’t affect std::env::current_dir.

Source

pub fn push_dir<P: AsRef<Path>>(&self, path: P) -> PushDir<'_>

Temporary changes the working directory of this Shell.

Returns a RAII guard which reverts the working directory to the old value when dropped.

Note that this doesn’t affect std::env::current_dir.

Source

pub fn var<K: AsRef<OsStr>>(&self, key: K) -> Result<String>

Fetches the environmental variable key for this Shell.

Returns an error if the variable is not set, or set to a non-utf8 value.

Environment of the Shell affects all commands spawned via this shell.

Source

pub fn var_os<K: AsRef<OsStr>>(&self, key: K) -> Option<OsString>

Fetches the environmental variable key for this Shell as OsString Returns None if the variable is not set.

Environment of the Shell affects all commands spawned via this shell.

Source

pub fn set_var<K: AsRef<OsStr>, V: AsRef<OsStr>>(&self, key: K, val: V)

Sets the value of key environment variable for this Shell to val.

Note that this doesn’t affect std::env::var.

Source

pub fn push_env<K: AsRef<OsStr>, V: AsRef<OsStr>>( &self, key: K, val: V, ) -> PushEnv<'_>

Temporary sets the value of key environment variable for this Shell to val.

Returns a RAII guard which restores the old environment when dropped.

Note that this doesn’t affect std::env::var.

Source

pub fn read_file<P: AsRef<Path>>(&self, path: P) -> Result<String>

Read the entire contents of a file into a string.

Source

pub fn read_binary_file<P: AsRef<Path>>(&self, path: P) -> Result<Vec<u8>>

Read the entire contents of a file into a vector of bytes.

Source

pub fn read_dir<P: AsRef<Path>>(&self, path: P) -> Result<Vec<PathBuf>>

Returns a sorted list of paths directly contained in the directory at path.

Source

pub fn write_file<P: AsRef<Path>, C: AsRef<[u8]>>( &self, path: P, contents: C, ) -> Result<()>

Write a slice as the entire contents of a file.

This function will create the file and all intermediate directories if they don’t exist.

Source

pub fn copy_file<S: AsRef<Path>, D: AsRef<Path>>( &self, src: S, dst: D, ) -> Result<()>

Copies src into dst.

src must be a file, but dst need not be. If dst is an existing directory, src will be copied into a file in the dst directory whose name is same as that of src.

Otherwise, dst is a file or does not exist, and src will be copied into it.

Source