Struct ExecSpec

pub struct ExecSpec {
    pub working_dir: PathBuf,
    pub executable: OsString,
    pub clargs: Vec<OsString>,
    pub env: HashMap<String, String>,
    pub input: Input,
    pub output: Output,
    pub output_err: Output,
}

The exec spec helps define something to execute by the project

Fields

working_dir: PathBuf

The working directory to run the executable in

executable: OsString

The executable

clargs: Vec<OsString>

The command line args for the executable

env: HashMap<String, String>

The environment variables for the executable.

Warning

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

input: Input

The input to the program, if needed

output: Output

Where the program’s stdout is emitted

output_err: Output

Where the program’s stderr is emitted

Implementations

impl ExecSpec

pub fn working_dir(&self) -> &Path

The working directory of the exec spec. If the path is relative, then the relative path is calculated relative to the the base directory of a project.

pub fn executable(&self) -> &OsStr

The executable to run

pub fn args(&self) -> &[OsString]

Command line args for the exec spec

pub fn env(&self) -> &HashMap<String, String>

The environment variables for the exec spec

pub fn execute_spec<P>(self, path: P) -> ProjectResult<ExecHandle>

where P: AsRef<Path>,

Try to executes an exec-spec, using the given path to resolve the current directory. If creating the program is successful, returns an ExecSpecHandle. This is a non-blocking method, as the actual command is ran in a separate thread.

Execution of the spec begins as soon as this method is called. However, all scheduling is controlled by the OS.

Error

This method will return an error if the given path can not be canonicalized into an absolute path, or the executable specified by this spec does not exist.

pub fn finish(&mut self) -> Result<ExitStatus>

👎Deprecated

Waits for the running child process to finish. Will return Some(exit_status) only if a child process has already been started. Otherwise, a None result will be given

Trait Implementations

impl Clone for ExecSpec

fn clone(&self) -> ExecSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecSpec

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

Formats the value using the given formatter.

impl Default for ExecSpec

fn default() -> ExecSpec

Returns the “default value” for a type.

impl VisitProject<Result<(), Error>> for ExecSpec

fn visit(&mut self, project: &Project) -> Result<(), Error>

Executes the exec spec in the project.