Struct ProcessResult 

pub struct ProcessResult<T> { /* private fields */ }

The captured result of running a process to completion.

T is the standard-output payload: String for the text helpers (output_string) or Vec<u8> for the raw-bytes helper (output_bytes). Standard error is always captured as text. A non-zero exit code is not treated as an error on its own — inspect code or call ensure_success.

Implementations

impl<T> ProcessResult<T>

pub fn stdout(&self) -> &T

The captured standard output (text or bytes depending on T).

pub fn into_stdout(self) -> T

Consume the result and return just the captured standard output.

pub fn stderr(&self) -> &str

The captured standard error.

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

The process exit code, or None when the run yielded no code — killed by its timeout (timed_out is then true) or terminated by a signal on Unix (timed_out is false). There is no synthetic sentinel: a missing code is None, never -1.

pub fn timed_out(&self) -> bool

Whether the run was killed because it exceeded its timeout.

pub fn is_success(&self) -> bool

Whether the process exited with code 0.

pub fn ensure_success(self) -> Result<ProcessResult<T>, Error>

where T: StdoutText,

Return self unchanged when the run succeeded, otherwise the matching error: Error::Timeout if the run was killed by its deadline (checked first), an IO error if it was killed by a signal (no exit code), else Error::Exit for a non-zero exit, carrying the code and both (truncated) captured streams.

impl ProcessResult<String>

pub fn combined(&self) -> String

Standard output followed by standard error, concatenated — handy when a tool interleaves diagnostics across both streams.

pub fn diagnostic(&self) -> &str

The best human-facing message from a captured run: standard error if it carries text, otherwise standard output — git/jj put CONFLICT … and nothing to commit on stdout, so a probe that captured the result (rather than erroring) can build the same friendly message Error::diagnostic gives the erroring path.

Trait Implementations

impl<T> Clone for ProcessResult<T>

where T: Clone,

fn clone(&self) -> ProcessResult<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ProcessResult<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq for ProcessResult<T>

where T: PartialEq,

fn eq(&self, other: &ProcessResult<T>) -> 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<T> Eq for ProcessResult<T>

where T: Eq,

impl<T> StructuralPartialEq for ProcessResult<T>