Enum Command 

#[non_exhaustive]
pub enum Command {
    Shell {
        command: String,
        current_dir: Option<PathBuf>,
        timeout: Option<Duration>,
    },
    ReadFile {
        path: PathBuf,
        current_dir: Option<PathBuf>,
        timeout: Option<Duration>,
    },
    WriteFile {
        path: PathBuf,
        content: String,
        current_dir: Option<PathBuf>,
        timeout: Option<Duration>,
    },
}

Commands that can be executed by the executor Conceptually, Shell allows any kind of input, and other commands enable more optimized implementations.

There is an ongoing consideration to make this an associated type on the executor

TODO: Should be able to borrow everything?

Use the constructor helpers (e.g. Command::shell) and then chain configuration methods such as Command::with_current_dir or Command::current_dir for builder-style ergonomics.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Shell

Fields

command: String

current_dir: Option<PathBuf>

timeout: Option<Duration>

ReadFile

Fields

path: PathBuf

current_dir: Option<PathBuf>

timeout: Option<Duration>

WriteFile

Fields

path: PathBuf

content: String

current_dir: Option<PathBuf>

timeout: Option<Duration>

Implementations

impl Command

pub fn shell<S: Into<String>>(cmd: S) -> Self

pub fn read_file<P: Into<PathBuf>>(path: P) -> Self

pub fn write_file<P: Into<PathBuf>, S: Into<String>>( path: P, content: S, ) -> Self

pub fn with_current_dir<P: Into<PathBuf>>(self, path: P) -> Self

Override the working directory used when executing this command.

Executors may interpret relative paths in the context of their own working directory.

pub fn current_dir<P: Into<PathBuf>>(&mut self, path: P) -> &mut Self

Override the working directory using the std::process::Command builder-lite style API.

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

pub fn current_dir_path(&self) -> Option<&Path>

pub fn with_timeout(self, timeout: Duration) -> Self

Override the timeout used when executing this command.

pub fn timeout(&mut self, timeout: Duration) -> &mut Self

Override the timeout using the builder-style API.

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

Remove any timeout previously configured on this command.

pub fn timeout_duration(&self) -> Option<&Duration>

Returns the timeout associated with this command, if any.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.