Struct Cmd

pub struct Cmd { /* private fields */ }

Cmd represents a single command.

It requires at least to set a command name. Command’s arguments and options are optional.

Note that using input/output redirection symbols (eg. |, >>, 2>) as command arguments will fail. Instead use Script.

Implementations

impl Cmd

pub fn new<S>(cmd: S) -> Self

where S: Into<String>,

Creates a new command with given name.

Examples

Cmd::new("echo");

pub fn with_args<S, T, I>(cmd: S, args: I) -> Self

where S: Into<String>, T: Into<String>, I: IntoIterator<Item = T>,

Creates a new command with given name and arguments.

Examples

Cmd::with_args("ls", ["-l", "~"]);

pub fn with_options<S>(cmd: S, options: CmdOptions) -> Self

where S: Into<String>,

Creates a new command with given name and options.

Examples

Cmd::with_options("ls", CmdOptions::default());

pub fn with_args_and_options<S, T, I>( cmd: S, args: I, options: CmdOptions, ) -> Self

where S: Into<String>, T: Into<String>, I: IntoIterator<Item = T>,

Creates a new command with given name, arguments and options.

Examples

Cmd::with_args_and_options("ls", ["-l"], CmdOptions::default());

pub fn parse(cmd_string: &str) -> Result<Self, CmdError>

Try to create a new command from given whitespace separated string. Notice that it will trim all whitespace characters.

Examples

let cmd = Cmd::parse("ls -l /some/path").unwrap();
assert_eq!(cmd, Cmd::with_args("ls", ["-l", "/some/path"]));

pub fn parse_with_options( cmd_string: &str, options: CmdOptions, ) -> Result<Self, CmdError>

Try to create a new command from given whitespace separated string and options. Notice that it will trim all whitespace characters.

Examples

let cmd = Cmd::parse_with_options("ls -l /some/path", CmdOptions::default());

pub fn set_args<S, I>(&mut self, args: I)

where S: Into<String>, I: IntoIterator<Item = S>,

Set a command arguments.

Examples

let mut cmd = Cmd::new("ls");
cmd.set_args(["-la", "~"]);

pub fn set_options(&mut self, options: CmdOptions)

Set a command options.

Examples

let mut cmd = Cmd::new("ls");
cmd.set_options(CmdOptions::default());

pub fn add_arg<S>(&mut self, arg: S)

where S: Into<String>,

Add a new argument to the end of argument list.

Examples

let mut cmd = Cmd::new("ls");
cmd.add_arg("-l");
cmd.add_arg("/some/directory");

pub fn cmd(&self) -> &str

Get command name.

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

Get command arguments.

pub fn options(&self) -> &CmdOptions

Get command options.

pub fn options_mut(&mut self) -> &mut CmdOptions

Update command options via mutable reference.

Examples

let mut cmd = Cmd::new("env");
cmd.options_mut().add_env("TEST_ENV_VAR", "value");

Trait Implementations

impl Clone for Cmd

fn clone(&self) -> Cmd

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cmd

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cmd

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Cmd

fn eq(&self, other: &Cmd) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Runnable for Cmd

fn bootstrap_cmd(&self, _process_dir: &Path) -> Result<Cmd, String>

This method should prepare process to run and return Cmd used to spawn a custom process. If you need to create some files for properly spawning a process, do it inside provided process_dir directory.

fn clean_after_fail(&self, process_dir: &Path) -> Result<(), String>

This method is called when process spawning fails. Notice that process_dir will be deleted automatically, so there is no need to delete it here.

impl Serialize for Cmd

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Cmd

impl StructuralPartialEq for Cmd