Struct CommandBuilder 

pub struct CommandBuilder { /* private fields */ }

Command builder for synchronous execution.

Implementations

impl CommandBuilder

pub fn new<S: AsRef<OsStr>>(program: S) -> Self

Creates a new command builder for the specified program.

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

Adds a single argument to the command.

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

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

Adds multiple arguments to the command.

pub fn env<K, V>(self, key: K, value: V) -> Self

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

Sets an environment variable for the command.

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

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

Sets multiple environment variables for the command.

pub fn env_clear(self) -> Self

Clears all environment variables inherited from the parent process.

pub fn env_remove<K>(self, key: K) -> Self

where K: AsRef<OsStr>,

Removes an environment variable from the command’s environment.

pub fn current_dir<D>(self, dir: D) -> Self

where D: AsRef<Path>,

Sets the working directory for the command.

pub fn stdin<T: Into<Stdio>>(self, stdin: T) -> Self

Configures the stdin handle for the command.

pub fn stdout<T: Into<Stdio>>(self, stdout: T) -> Self

Configures the stdout handle for the command.

pub fn stderr<T: Into<Stdio>>(self, stderr: T) -> Self

Configures the stderr handle for the command.

pub fn capture_output(self) -> Self

Configures the command to capture both stdout and stderr.

pub fn inherit_stdin(self) -> Self

Configures the command to inherit stdin from the parent process.

pub fn inherit_stdout(self) -> Self

Configures the command to inherit stdout from the parent process.

pub fn inherit_stderr(self) -> Self

Configures the command to inherit stderr from the parent process.

pub fn null_stdin(self) -> Self

Configures the command to read from null stdin.

pub fn null_stdout(self) -> Self

Configures the command to write to null stdout.

pub fn null_stderr(self) -> Self

Configures the command to write to null stderr.

pub fn creation_flags(self, flags: u32) -> Self

Sets the process creation flags (Windows only).

Sets the process creation flags to be passed to CreateProcess. These will always be ORed with CREATE_UNICODE_ENVIRONMENT.

Errors

This method does not return errors directly, but the spawned process may fail if the flags are invalid.

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

Spawns the command as a child process.

pub fn output(&mut self) -> Result<Output>

Executes the command and captures its output.

pub fn execute(&mut self) -> ScriptResult<Output>

Executes the command and captures its output, returning a ScriptResult.

pub fn status(&mut self) -> Result<ExitStatus>

Waits for the command to complete and returns its exit status.

pub fn execute_with_timeout(self, timeout: Duration) -> ScriptResult<Output>

Executes the command with a timeout.

If the command does not complete within the specified duration, the child process is killed and a timeout error is returned.

Note: The builder is consumed by this operation and cannot be reused.

Errors

Returns ScriptError::Timeout if the command exceeds the timeout. Returns ScriptError::IoError if the command fails to start or execute.

Trait Implementations

impl Debug for CommandBuilder

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

Formats the value using the given formatter.