Enum RequireSuccessError 

#[non_exhaustive]
pub enum RequireSuccessError {
    #[non_exhaustive]
    UnsuccessfulCommand {
        invocation: Box<Invocation>,
        status: ExitStatus,
        stderr: Capture,
    },
}

The error returned when a command ended without success

The error carries the three answers that the reader of a report needs: which command ran, how it ended, and what it said. A program states why it stopped on its standard error, so the error carries that capture and its message shows it.

The command ran. Nothing failed inside the crate, and the error exists because the caller stated that only success is acceptable.

The invocation travels in a box. A result carries its error by value, so the size of the error reaches every function that returns one. The box keeps the error small, and a caller that wraps it in an error of its own needs no box for it.

A later release can add variants, and it can add fields to a variant. Match with a wildcard arm, and bind the fields of a variant with ...

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

UnsuccessfulCommand

The command ended without success

The exit status says how the command ended. A command that ran to its end reports a code, and a command that a signal stopped reports no code at all.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

invocation: Box<Invocation>

The command that ended without success

status: ExitStatus

The status with which the command ended

stderr: Capture

What the command wrote to its standard error

Trait Implementations

impl Clone for RequireSuccessError

fn clone(&self) -> RequireSuccessError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequireSuccessError

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

Formats the value using the given formatter.

impl Display for RequireSuccessError

States which command ended how, and what it wrote about it

The message holds the capture of the standard error, because the reader of a report has only this message and the command wrote its reason there. A command that wrote nothing says so, so that no reader looks for a text that does not exist.

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

Formats the value using the given formatter.

impl Eq for RequireSuccessError

impl Error for RequireSuccessError

Reports the error to the tools of the ecosystem

The error has no source. The command ran, and no other operation failed under this one.

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 PartialEq for RequireSuccessError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RequireSuccessError