Struct ExternalFailure 

pub struct ExternalFailure { /* private fields */ }

An application-declared failure from an authoritative external operation.

Use this narrow escape hatch when a command delegates to another executable and must preserve that executable’s exact nonzero status and stderr payload. Returning ordinary handler or hook errors continues to use Standout’s normal runtime status (1); this type does not configure general error mapping.

ExternalFailure can flow through a handler’s existing HandlerResult error seam via ?/Into<anyhow::Error>. For pre-dispatch, wrap it with HookError::pre_dispatch_external.

Implementations

impl ExternalFailure

pub fn new( status: u8, diagnostic: impl Into<String>, ) -> Result<Self, InvalidExternalStatus>

Declares an external failure with an exact nonzero process status and verbatim stderr payload.

pub const fn exit_status(&self) -> ExitStatus

Returns the exact status declared by the application.

pub fn diagnostic(&self) -> &str

Returns the stderr payload without adding or removing any text.

pub fn with_source<E>(self, source: E) -> Self

where E: Error + Send + Sync + 'static,

Attaches the error that caused the external operation to fail.

Trait Implementations

impl Clone for ExternalFailure

fn clone(&self) -> ExternalFailure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalFailure

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

Formats the value using the given formatter.

impl Display for ExternalFailure

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

Formats the value using the given formatter.

impl Error for ExternalFailure

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 From<ExternalFailure> for RunError

fn from(failure: ExternalFailure) -> Self

Converts to this type from the input type.