Struct ProcessPromise 

pub struct ProcessPromise { /* private fields */ }

A prepared command (zx ProcessPromise). Nothing runs until it is awaited, run, run_sync or spawn is called.

Implementations

impl ProcessPromise

pub fn new(opts: Options, cmd: impl Into<String>) -> Self

A command with the given options.

pub fn failed(opts: Options, err: ZxError) -> Self

A command that fails immediately with err when run.

pub fn cmd(&self) -> &str

The command without prefix and postfix.

pub fn full_cmd(&self) -> String

The command as passed to the shell: prefix + cmd + postfix.

pub fn options(&self) -> &Options

The options of this command.

pub fn nothrow(self) -> Self

Resolve with the output even when the command fails.

pub fn quiet(self) -> Self

Suppress logging for this command.

pub fn verbose(self) -> Self

Log the command and its output to stderr.

pub fn timeout(self, timeout: Duration) -> Self

Kill the command after timeout (with the timeout signal).

pub fn timeout_with(self, timeout: Duration, signal: impl Into<String>) -> Self

Kill the command after timeout with signal.

pub fn kill_signal(self, signal: impl Into<String>) -> Self

Default signal for RunningProcess::kill.

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

Write data to the command’s stdin.

pub fn pipe(self, dest: ProcessPromise) -> ProcessPromise

Feed this command’s stdout into dest’s stdin; returns dest.

When this command fails (and is not nothrow) the destination is stopped and inherits its exit code, so the pipeline fails as a whole.

pub fn pipe_stderr(self, dest: ProcessPromise) -> ProcessPromise

Feed this command’s stderr into dest.

pub fn pipe_stdall(self, dest: ProcessPromise) -> ProcessPromise

Feed this command’s interleaved stdout and stderr into dest.

pub fn pipe_from(self, from: PipeFrom, dest: ProcessPromise) -> ProcessPromise

Feed the selected stream into dest. If dest already has a source, this command is attached at the head of its pipeline.

pub async fn pipe_to_file(self, path: impl AsRef<Path>) -> ZxResult

Run the command writing its stdout into the file at path.

pub async fn pipe_to_file_from( self, from: PipeFrom, path: impl AsRef<Path>, ) -> ZxResult

Run the command writing the selected stream into the file at path.

pub async fn run(self) -> ZxResult

Run the command to completion.

pub fn run_sync(self) -> ZxResult

Run the command synchronously (on a helper thread with its own runtime, so it is safe to call from inside or outside of tokio).

pub fn spawn(self) -> RunningProcess

Start the command in the background (requires a tokio runtime).

Trait Implementations

impl Clone for ProcessPromise

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessPromise

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

Formats the value using the given formatter.

impl IntoFuture for ProcessPromise

type Output = Result<ProcessOutput, ProcessOutput>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = Result<ProcessOutput, ProcessOutput>> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.