Struct Command 

pub struct Command { /* private fields */ }

Implementations

impl Command

pub fn new(value: impl AsRef<OsStr>) -> Self

pub fn argument(self, value: impl AsRef<OsStr>) -> Self

pub fn optional_argument(self, optional: Option<impl AsRef<OsStr>>) -> Self

pub fn optional_flag(self, condition: bool, flag: impl AsRef<OsStr>) -> Self

Adds a flag argument only if the condition is true.

let verbose = true;
cmd_proc::Command::new("echo")
    .optional_flag(verbose, "--verbose");

pub fn option(self, name: impl AsRef<OsStr>, value: impl AsRef<OsStr>) -> Self

Adds a CLI option (name + value).

cmd_proc::Command::new("git")
    .option("--message", "hello");
// equivalent to: .argument("--message").argument("hello")

pub fn optional_option( self, name: impl AsRef<OsStr>, value: Option<impl AsRef<OsStr>>, ) -> Self

Adds a CLI option (name + value) only if the value is Some.

cmd_proc::Command::new("git")
    .optional_option("--author", Some("Alice"));
// adds "--author Alice" only if Some

pub fn arguments<T: AsRef<OsStr>>( self, value: impl IntoIterator<Item = T>, ) -> Self

pub fn working_directory(self, dir: impl AsRef<Path>) -> Self

pub fn env(self, key: &EnvVariableName<'_>, val: impl AsRef<OsStr>) -> Self

pub fn envs<'a, I, V>(self, vars: I) -> Self

where I: IntoIterator<Item = (EnvVariableName<'a>, V)>, V: AsRef<OsStr>,

pub fn env_remove(self, key: &EnvVariableName<'_>) -> Self

Remove an environment variable from the child process.

pub fn stdin_bytes(self, data: impl Into<Vec<u8>>) -> Self

pub fn stdout_capture(self) -> CaptureSingle<Stdout>

Capture stdout from this command.

pub fn stderr_capture(self) -> CaptureSingle<Stderr>

Capture stderr from this command.

pub fn stdout_null(self) -> Self

Redirect stdout to /dev/null.

pub fn stderr_null(self) -> Self

Redirect stderr to /dev/null.

pub fn stdout_inherit(self) -> Self

Inherit stdout from the parent process (default).

pub fn stderr_inherit(self) -> Self

Inherit stderr from the parent process (default).

pub fn build(self) -> Command

Consume the builder and return the underlying tokio::process::Command.

Use this when you need full control over the child process (e.g. interactive stdin/stdout piping) beyond what the capture API provides.

pub async fn status(self) -> Result<(), CommandError>

Execute the command and return success or an error.