Struct ExecSpecBuilder

pub struct ExecSpecBuilder {
    pub working_dir: Option<PathBuf>,
    pub executable: Option<OsString>,
    pub clargs: Vec<OsString>,
    pub env: HashMap<String, String>,
    /* private fields */
}

Builds exec specs

Fields

working_dir: Option<PathBuf>

The working directory to run the executable in

executable: Option<OsString>

The executable

clargs: Vec<OsString>

The command line args for the executable

env: HashMap<String, String>

The environment variables for the executable. By default, the exec spec will inherit from the parent process.

Warning

ONLY The environment variables in this map will be passed to the executable.

Implementations

impl ExecSpecBuilder

pub fn new() -> Self

Create a new ExecSpecBuilder.

pub fn default_env() -> HashMap<String, String>

The default environment variables

pub fn with_env<I: IntoIterator<Item = (String, String)>>( &mut self, env: I, ) -> &mut Self

Changes the environment variables to the contents of this map.

Warning

This will clear all previously set values in the environment map

pub fn extend_env<I: IntoIterator<Item = (String, String)>>( &mut self, env: I, ) -> &mut Self

Adds variables to the environment

pub fn add_env<'a>( &mut self, env: &str, value: impl Into<Option<&'a str>>, ) -> &mut Self

Adds variables to the environment

pub fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self

Add an arg to the command

pub fn args<I, S: AsRef<OsStr>>(&mut self, args: I) -> &mut Self

where I: IntoIterator<Item = S>,

Add many args to the command

pub fn with_arg<S: AsRef<OsStr>>(self, arg: S) -> Self

Add an arg to the command

pub fn with_args<I, S: AsRef<OsStr>>(self, args: I) -> Self

where I: IntoIterator<Item = S>,

Add many args to the command

pub fn exec<E: AsRef<OsStr>>(&mut self, exec: E) -> &mut Self

Set the executable for the exec spec

pub fn with_exec<E: AsRef<OsStr>>(self, exec: E) -> Self

Set the executable for the exec spec

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

Set the working directory for the exec spec. If the path is relative, it will be resolved to the project directory.

pub fn stdin<In>(&mut self, input: In) -> &mut Self

where In: Into<Input>,

Set the standard input for the executable. doesn’t need to be set

pub fn with_stdin<In>(self, input: In) -> Self

where In: Into<Input>,

Set the standard input for the executable. doesn’t need to be set

pub fn stdout<O>(&mut self, output: O) -> &mut Self

where O: Into<Output>,

Sets the output type for this exec spec

pub fn with_stdout<O>(self, output: O) -> Self

where O: Into<Output>,

Sets the output type for this exec spec

pub fn stderr<O>(&mut self, output: O) -> &mut Self

where O: Into<Output>,

Sets the output type for this exec spec

pub fn with_stderr<O>(self, output: O) -> Self

where O: Into<Output>,

Sets the output type for this exec spec

pub fn build(self) -> Result<ExecSpec, ExecSpecBuilderError>

Build the exec spec from the builder

Error

Will return an error if the working directory or the executable isn’t set.