Trait CommandBuilder

pub trait CommandBuilder {
    // Required methods
    fn with_arg<S: AsRef<OsStr>>(self, arg: S) -> Self;
    fn with_env<K, V>(self, key: K, val: V) -> Self
       where K: AsRef<OsStr>,
             V: AsRef<OsStr>;
    fn with_current_dir<P: AsRef<Path>>(self, path: P) -> Self;
    fn pipe(self, next: Command) -> Result<Self>
       where Self: Sized;
    fn pipe_stderr(self, next: Command) -> Result<Self>
       where Self: Sized;

    // Provided methods
    fn with_args<I, S>(self, args: I) -> Self
       where Self: Sized,
             I: IntoIterator<Item = S>,
             S: AsRef<OsStr> { ... }
    fn maybe_with_arg<S>(self, apply: bool, arg: S) -> Self
       where Self: Sized,
             S: AsRef<OsStr> { ... }
    fn maybe_with_args<I, S>(self, apply: bool, args: I) -> Self
       where Self: Sized,
             I: IntoIterator<Item = S>,
             S: AsRef<OsStr> { ... }
    fn with_envs<I, K, V>(self, vars: I) -> Self
       where Self: Sized,
             I: IntoIterator<Item = (K, V)>,
             K: AsRef<OsStr>,
             V: AsRef<OsStr> { ... }
}

Methods on Command which take self.

This is useful with cargs!.

Example

cmd!(ls)
    .with_args(cargs!(foo/bar, zog))
    .run()
    .ok();

Required Methods

fn with_arg<S: AsRef<OsStr>>(self, arg: S) -> Self

Akin to Command::arg.

fn with_env<K, V>(self, key: K, val: V) -> Self

where K: AsRef<OsStr>, V: AsRef<OsStr>,

Akin to Command::env.

fn with_current_dir<P: AsRef<Path>>(self, path: P) -> Self

Akin to Command::current_dir.

fn pipe(self, next: Command) -> Result<Self>

where Self: Sized,

Pipe stdout of this into next command.

fn pipe_stderr(self, next: Command) -> Result<Self>

where Self: Sized,

Pipe stderr of this into next command.

Provided Methods

fn with_args<I, S>(self, args: I) -> Self

where Self: Sized, I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Akin to Command::args.

fn maybe_with_arg<S>(self, apply: bool, arg: S) -> Self

where Self: Sized, S: AsRef<OsStr>,

Add the argument if apply is true.

fn maybe_with_args<I, S>(self, apply: bool, args: I) -> Self

where Self: Sized, I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Add the arguments if apply is true.

fn with_envs<I, K, V>(self, vars: I) -> Self

where Self: Sized, I: IntoIterator<Item = (K, V)>, K: AsRef<OsStr>, V: AsRef<OsStr>,

Akin to Command::envs.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl CommandBuilder for Command

fn with_arg<S: AsRef<OsStr>>(self, arg: S) -> Self

fn with_env<K, V>(self, key: K, val: V) -> Self

where K: AsRef<OsStr>, V: AsRef<OsStr>,

fn with_current_dir<P: AsRef<Path>>(self, dir: P) -> Self

fn pipe(self, next: Command) -> Result<Self>

fn pipe_stderr(self, next: Command) -> Result<Self>

Implementors