Struct CommandOutput 

pub struct CommandOutput { /* private fields */ }

Captured output and status information from a finished command.

CommandOutput stores retained raw stdout and stderr bytes. When the runner is configured with per-stream capture limits, the retained bytes may be a prefix of the full output; use Self::stdout_truncated and Self::stderr_truncated to detect that case. By default, Self::stdout and Self::stderr validate retained bytes as UTF-8 and return str::Utf8Error for invalid output. If the command was run with CommandRunner::lossy_output enabled, the runner also stores lossy UTF-8 text where invalid byte sequences are replaced with the Unicode replacement character.

Author

Haixing Hu

Implementations

impl CommandOutput

pub fn exit_code(&self) -> Option<i32>

Returns the command exit code.

Returns

Some(code) when the platform reports a numeric process exit code, or None when the process ended in a way that does not map to a numeric code.

pub const fn exit_status(&self) -> &ExitStatus

Returns the full process exit status.

Returns

Platform-specific process exit status reported by the operating system.

pub fn termination_signal(&self) -> Option<i32>

Returns the signal that terminated the process on Unix platforms.

Returns

Some(signal) when the process was terminated by a signal, otherwise None.

pub fn stdout(&self) -> Result<&str, Utf8Error>

Returns captured standard output as UTF-8 text.

Returns

Ok(&str) when stdout is valid UTF-8. If the command runner used lossy output mode, this returns the stored lossy text even when the original bytes were not valid UTF-8.

Errors

Returns str::Utf8Error when stdout contains invalid UTF-8 and the command runner did not enable lossy output mode.

pub fn stderr(&self) -> Result<&str, Utf8Error>

Returns captured standard error as UTF-8 text.

Returns

Ok(&str) when stderr is valid UTF-8. If the command runner used lossy output mode, this returns the stored lossy text even when the original bytes were not valid UTF-8.

Errors

Returns str::Utf8Error when stderr contains invalid UTF-8 and the command runner did not enable lossy output mode.

pub const fn elapsed(&self) -> Duration

Returns the observed command duration.

Returns

Duration from process spawn to observed termination.

pub fn stdout_bytes(&self) -> &[u8]

Returns the captured standard output bytes.

Returns

A borrowed slice containing stdout exactly as emitted by the process.

pub fn stderr_bytes(&self) -> &[u8]

Returns the captured standard error bytes.

Returns

A borrowed slice containing stderr exactly as emitted by the process.

pub const fn stdout_truncated(&self) -> bool

Returns whether captured stdout was truncated by a configured limit.

Returns

true when stdout emitted more bytes than the runner retained.

pub const fn stderr_truncated(&self) -> bool

Returns whether captured stderr was truncated by a configured limit.

Returns

true when stderr emitted more bytes than the runner retained.

Trait Implementations

impl Clone for CommandOutput

fn clone(&self) -> CommandOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandOutput

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

Formats the value using the given formatter.

impl PartialEq for CommandOutput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CommandOutput

impl StructuralPartialEq for CommandOutput