Struct chainsop::SubProcOperation

pub struct SubProcOperation { /* private fields */ }

This structure represents a single command to run as a sub-process, the command’s arguments, and the input and output files for that sub-process. The structure itself is public but the fields are private (i.e. implementation specific); the impl section below defines the visible operations that can be performed on this structure.

Implementations

impl SubProcOperation

pub fn new(executing: &Executable) -> SubProcOperation

This is the primary method of initializing a SubProcOperation.

pub fn set_executable<T>(&mut self, exe: T) -> &mut Selfwhere T: Into<PathBuf>,

Changes the name of the command to execute.

pub fn clear_env(&mut self) -> &mut Self

Clears all environment variable settings for the environment in which this operation executes. Any previous environment variable settings are discarded.

By default, the current environment is inherited by the operation.

pub fn set_env<N, V>(&mut self, var_name: N, var_value: V) -> &mut Selfwhere N: Into<String>, V: Into<String>,

Specifies an environment variable value to be set in the environment for executing this operation. This can be used multiple times to set multiple environment variables; subsequent settings of the same variable will override previous settings.

The first argument is the environment variable name and the second argument is the value to set for that variable.

pub fn prepend_env<N, V, S>(&mut self, var: N, value: V, sep: S) -> &mut Selfwhere N: Into<String>, V: Into<String>, S: Into<String>,

Extends the operations environment by prepending a value to an environment variable. If the environment variable was not previously set, this becomes the new value for that variable. This can be used multiple times to extend the environment variable with multiple values.

The first argument is the environment variable name and the second argument is the value to prepend to that variable, and the third value is the separator between the prepended value and the existing value.

pub fn append_env<N, V, S>(&mut self, var: N, value: V, sep: S) -> &mut Selfwhere N: Into<String>, V: Into<String>, S: Into<String>,

Extends the operations environment by appending a value to an environment variable. If the environment variable was not previously set, this becomes the new value for that variable. This can be used multiple times to extend the environment variable with multiple values.

The first argument is the environment variable name and the second argument is the value to append to that variable, and the third value is the separator between the appended value and the existing value.

pub fn unset_env<N>(&mut self, var_name: N) -> &mut Selfwhere N: Into<String>,

Removes the specified environment variable from the environment in which the operation executes. Has no effect but does not fail if the environment variable does not exist.

pub fn push_arg<T>(&mut self, arg: T) -> &mut Selfwhere T: Into<OsString>,

Adds an argument to use when executing the operation. This can, for example, be used for specifying command-line option arguments when running a subprocess Executable operation. Each operation type and instance can determine how it will handle any specified arguments.

Trait Implementations

impl Clone for SubProcOperation

fn clone(&self) -> SubProcOperation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubProcOperation

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

Formats the value using the given formatter.

impl FilesPrep for SubProcOperation

fn set_dir<T>(&mut self, tgtdir: T) -> &mut Selfwhere T: AsRef<Path>,

Sets the directory from which the operation will be performed. The caller is responsible for ensuring any FileArg::Loc paths are valid when operating from that directory. This directory is usually a relative directory and is interpreted from the current working directory or the directory provided to the OpInterface::execute method.

fn set_input_file(&mut self, fname: &FileArg) -> &mut Self

Sets the input file for the operation, overriding any previous input file specification.

fn add_input_file(&mut self, fname: &FileArg) -> &mut Self

Appends the additional input file to the list of input files for this operation.

fn has_input_file(&self) -> bool

Returns true if one or more input files have been specified for this operation.

fn set_output_file(&mut self, fname: &FileArg) -> &mut Self

Sets the output file for the command, overriding any previous output file specification.

fn has_explicit_output_file(&self) -> bool

Returns true if the output file has been explicitly specified as a location (instead of being a TBD, a Glob match, or a Temp file).

impl OpInterface for SubProcOperation

fn label(&self) -> String

Returns a short identifier of this operation, usually used for user-presented identification purposes.

fn set_label(&mut self, new_label: &str) -> &mut Self

Allows the label for an operation to be updated. The label is usually used for user-presentation identification purposes.

fn execute<Exec, P>( &mut self, executor: &Exec, cwd: &Option<P> ) -> Result<ActualFile>where P: AsRef<Path>, Exec: OsRun,

Executes this command in a subprocess in the specified directory (via the OsRun execution provided). The input and output files will be determined and added to the command-line as indicated by their NamedFile values. The successful result specifies the output file written (if any).

fn execute_here(&mut self, executor: &impl OsRun) -> Result<ActualFile>

Convenience method to execute an operation with a given crate::Executor in the current directory.