Struct Prepare

pub struct Prepare {
    pub command: OsString,
    pub stdin: Stdio,
    pub stdout: Stdio,
    pub stderr: Stdio,
    pub args: Vec<OsString>,
    pub env: Vec<(OsString, OsString)>,
    pub use_shell: bool,
}

A structure to keep settings to use when invoking a command via spawn(), after creating it with prepare().

Fields

command: OsString

The command to invoke (either with or without shell depending on use_shell.

stdin: Stdio

The way standard input is configured.

stdout: Stdio

The way standard output is configured.

stderr: Stdio

The way standard error is configured.

args: Vec<OsString>

The arguments to pass to the spawned process.

env: Vec<(OsString, OsString)>

environment variables to set in the spawned process.

use_shell: bool

If true, we will use sh to execute the command.

Implementations

impl Prepare

Builder

pub fn with_shell(self) -> Self

If called, the command will not be executed directly, but with sh.

This also allows to pass shell scripts as command, or use commands that contain arguments which are subsequently parsed by sh.

pub fn without_shell(self) -> Self

Unconditionally turn off using the shell when spawning the command. Note that not using the shell is the default so an effective use of this method is some time after with_shell() was called.

pub fn stdin(self, stdio: Stdio) -> Self

Configure the process to use stdio for _stdin.

pub fn stdout(self, stdio: Stdio) -> Self

Configure the process to use stdio for stdout.

pub fn stderr(self, stdio: Stdio) -> Self

Configure the process to use stdio for _stderr.

pub fn arg(self, arg: impl Into<OsString>) -> Self

Add arg to the list of arguments to call the command with.

pub fn args(self, args: impl IntoIterator<Item = impl Into<OsString>>) -> Self

Add args to the list of arguments to call the command with.

pub fn env(self, key: impl Into<OsString>, value: impl Into<OsString>) -> Self

Add key with value to the environment of the spawned command.

impl Prepare

Finalization

pub fn spawn(self) -> Result<Child>

Spawn the command as configured.

Trait Implementations

impl From<Prepare> for Command

fn from(prep: Prepare) -> Command

Converts to this type from the input type.