Struct xscript::LocalEnv

pub struct LocalEnv(/* private fields */);

A local execution environment.

Implementations

impl LocalEnv

pub fn new<P: AsRef<Path>>(cwd: P) -> Self

Creates an execution environment with the given working directory.

pub fn current_dir() -> Result<Self, Error>

Creates an execution environment with the current working directory.

pub fn cwd(&self) -> &Path

The working directory of the environment.

pub fn set_cwd<P: AsRef<Path>>(&mut self, cwd: P) -> &mut Self

Sets the working directory of the environment.

pub fn with_cwd<P: AsRef<Path>>(self, cwd: P) -> Self

Sets the working directory of the environment.

pub fn vars(&self) -> &Vars

The environment variables of the environment.

pub fn set_vars(&mut self, vars: Vars) -> &mut Self

Sets the environment variables of the environment.

pub fn with_vars(self, vars: Vars) -> Self

Sets the environment variables of the environment.

pub fn set_var<N: AsRef<OsStr>, V: AsRef<OsStr>>( &mut self, name: N, value: V ) -> &mut Self

Sets an environment variable.

pub fn with_var<N: AsRef<OsStr>, V: AsRef<OsStr>>( self, name: N, value: V ) -> Self

Sets an environment variable.

pub fn default_stdin(&self) -> &In

The default stdin input to provide to commands.

pub fn with_default_stdin(self, stdin: In) -> Self

Sets the default stdin input to provide to commands.

pub fn default_stdout(&self) -> &Out

Indicates what to do with the stdout output of commands by default.

pub fn with_default_stdout(self, stdout: Out) -> Self

Sets what to do with the stdout output of commands by default.

pub fn default_stderr(&self) -> &Out

Indicates what to do with the stderr output of commands by default.

pub fn with_default_stderr(self, stderr: Out) -> Self

pub fn with_echo(self) -> Self

Enables the echoing of commands.

pub fn without_echo(self) -> Self

Disables the echoing of commands.

pub fn change_dir<P: AsRef<Path>>( &mut self, path: P ) -> Result<&mut Self, Error>

Changes the working directory of the environment.

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

Resolves a path relative to the working directory of the environment.

Trait Implementations

impl Clone for LocalEnv

fn clone(&self) -> LocalEnv

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LocalEnv

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

Formats the value using the given formatter.

impl Run<OsString> for LocalEnv

fn run(&self, cmd: Cmd<OsString>) -> Result<RunOutput, RunError<OsString>>

Runs a command returning its output.

fn read_str(&self, cmd: Cmd<S>) -> Result<String, RunError<S>>

Runs a command returning its stdout output as a string.

fn read_bytes(&self, cmd: Cmd<S>) -> Result<Vec<u8>, RunError<S>>

Runs a command returning its stderr output as a string.

impl RunAsync<OsString> for LocalEnv

Available on crate feature tokio only.

fn run( &self, cmd: Cmd ) -> Pin<Box<dyn Future<Output = RunResult<RunOutput, OsString>> + '_>>

Available on crate feature async only.

fn read_str( &self, cmd: Cmd<S> ) -> Pin<Box<dyn Future<Output = RunResult<String, S>> + '_>>

Available on crate feature async only.

fn read_bytes( &self, cmd: Cmd<S> ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, RunError<S>>> + '_>>

Available on crate feature async only.