Struct ProcessOutput 

pub struct ProcessOutput {
    pub stdout: String,
    pub stderr: String,
    pub stdall: String,
    pub exit_code: Option<i32>,
    pub signal: Option<String>,
    pub duration: Duration,
    pub error: Option<ErrorInfo>,
    pub from: String,
}

The result of running a command: captured streams, exit status and timing.

stdall holds stdout and stderr interleaved in arrival order. Following zx, the textual accessors (text, lines, json, buffer and Display) read stdall, which equals stdout whenever the command wrote no stderr.

Fields

stdout: String

Captured standard output.

stderr: String

Captured standard error.

stdall: String

Standard output and error interleaved in arrival order.

exit_code: Option<i32>

Exit code; None when the process was killed by a signal or never ran.

signal: Option<String>

Name of the terminating signal (for example SIGTERM).

duration: Duration

Wall-clock run time.

error: Option<ErrorInfo>

Set when the command could not be started.

from: String

Where the command came from (the command text by default).

Implementations

impl ProcessOutput

pub fn new( exit_code: Option<i32>, signal: Option<&str>, stdout: impl Into<String>, stderr: impl Into<String>, stdall: impl Into<String>, ) -> Self

Build an output from its main parts.

pub fn from_error(error: ErrorInfo, from: impl Into<String>) -> Self

An output describing a command that could not be run.

pub fn with_from(self, from: impl Into<String>) -> Self

Set the from location used in messages.

pub fn with_duration(self, duration: Duration) -> Self

Set the duration.

pub fn ok(&self) -> bool

true when the command ran and exited with code 0.

pub fn text(&self) -> String

The combined output as text.

pub fn text_hex(&self) -> String

The combined output hex-encoded (zx text('hex')).

pub fn value_of(&self) -> &str

The combined output, trimmed (zx valueOf()).

pub fn buffer(&self) -> Vec<u8>

The combined output as bytes.

pub fn json<T: DeserializeOwned>(&self) -> Result<T, Error>

Parse the combined output as JSON.

pub fn lines(&self) -> Vec<String>

Split the combined output on \r?\n, dropping a trailing empty piece.

pub fn lines_with(&self, delimiter: &str) -> Vec<String>

Split the combined output on a custom delimiter.

pub fn exit_code_info(&self) -> Option<&'static str>

Description of the exit code (for example Command not found).

pub fn message(&self) -> String

The zx error message for this output.

Trait Implementations

impl AsRef<Path> for ProcessOutput

fn as_ref(&self) -> &Path

The trimmed combined output as a path (handy for cd(&output)).

impl Clone for ProcessOutput

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 ProcessOutput

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

Formats the value using the given formatter.

impl Default for ProcessOutput

fn default() -> Self

Returns the “default value” for a type.

impl Display for ProcessOutput

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

Formats the value using the given formatter.

impl Error for ProcessOutput

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl IntoIterator for &ProcessOutput

type Item = String

The type of the elements being iterated over.

type IntoIter = IntoIter<String>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoZxArg for &ProcessOutput

fn into_zx_arg(self) -> ZxArg

Perform the conversion.

impl IntoZxArg for ProcessOutput

fn into_zx_arg(self) -> ZxArg

Perform the conversion.

impl PartialEq for ProcessOutput

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ProcessOutput