Skip to main content

ProcessResult

Struct ProcessResult 

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

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 exit_code or call ensure_success.

Implementations§

Source§

impl<T> ProcessResult<T>

Source

pub fn stdout(&self) -> &T

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

Source

pub fn into_stdout(self) -> T

Consume the result and return just the captured standard output.

Source

pub fn stderr(&self) -> &str

The captured standard error.

Source

pub fn exit_code(&self) -> i32

The raw process exit code (whatever the OS reported).

Source

pub fn timed_out(&self) -> bool

Whether the run was killed because it exceeded its timeout.

Source

pub fn is_success(&self) -> bool

Whether the process exited with code 0.

Source

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

Return self unchanged when the run succeeded, otherwise the matching error: Error::Timeout if the run was killed by its deadline (checked first — a timed-out run has no meaningful exit code), else Error::Exit for a non-zero exit, carrying the code and (truncated) standard error.

Mirrors the .NET EnsureSuccess() / ProcessExitException.

Source§

impl ProcessResult<String>

Source

pub fn combined(&self) -> String

Standard output followed by standard error, concatenated — handy when a tool interleaves diagnostics across both streams. Mirrors the .NET / vcs combined().

Trait Implementations§

Source§

impl<T> Clone for ProcessResult<T>
where T: Clone,

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for ProcessResult<T>
where T: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> PartialEq for ProcessResult<T>
where T: PartialEq,

Source§

fn eq(&self, other: &ProcessResult<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl<T> Eq for ProcessResult<T>
where T: Eq,

Source§

impl<T> StructuralPartialEq for ProcessResult<T>

Auto Trait Implementations§

§

impl<T> Freeze for ProcessResult<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for ProcessResult<T>
where T: RefUnwindSafe,

§

impl<T> Send for ProcessResult<T>
where T: Send,

§

impl<T> Sync for ProcessResult<T>
where T: Sync,

§

impl<T> Unpin for ProcessResult<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for ProcessResult<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for ProcessResult<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.