Enum Failure 

pub enum Failure {
    MatchTimeout {
        pattern: String,
        span: IrSpan,
        shell: String,
        effective: Box<IrTimeout>,
        context: FailureContext,
    },
    FailPatternMatched {
        pattern: String,
        matched_line: String,
        span: IrSpan,
        shell: String,
        context: FailureContext,
    },
    ShellExited {
        shell: String,
        exit_code: Option<i32>,
        span: IrSpan,
        context: FailureContext,
    },
    Runtime {
        message: String,
        span: IrSpan,
        shell: Option<String>,
        context: FailureContext,
    },
    PureMatch {
        value: String,
        pattern: String,
        is_regex: bool,
        span: IrSpan,
        match_context: MatchContext,
        context: FailureContext,
    },
    MultiMatch {
        shell: String,
        patterns: Vec<MultiMatchPattern>,
        matched: Vec<usize>,
        span: IrSpan,
        effective: Box<IrTimeout>,
        context: FailureContext,
    },
}

Variants

MatchTimeout

Fields

pattern: String

span: IrSpan

shell: String

effective: Box<IrTimeout>

The timeout that fired. Boxed to keep Failure’s variant size comparable to the others (avoids clippy::large_enum_variant).

context: FailureContext

FailPatternMatched

Fields

pattern: String

matched_line: String

span: IrSpan

shell: String

context: FailureContext

ShellExited

Fields

shell: String

exit_code: Option<i32>

span: IrSpan

context: FailureContext

Runtime

Fields

message: String

span: IrSpan

shell: Option<String>

context: FailureContext

PureMatch

Fields

value: String

pattern: String

is_regex: bool

span: IrSpan

match_context: MatchContext

context: FailureContext

MultiMatch

Fields

shell: String

patterns: Vec<MultiMatchPattern>

All patterns in source order.

matched: Vec<usize>

Indices into patterns that matched before the block timed out.

span: IrSpan

effective: Box<IrTimeout>

The block-level timeout that fired. Boxed to keep variant size in line with the other failures (see clippy::large_enum_variant).

context: FailureContext

Implementations

impl Failure

pub fn from_pure_eval( err: PureEvalError, match_context: MatchContext, context: FailureContext, ) -> Self

Build a Failure from a pure-evaluation error. A failed pure match inside a pure fn body becomes Failure::PureMatch; a malformed interpolated regex becomes a runtime error naming the bad pattern. match_context names where the pure match ran (fn, test/effect preamble, overlay, or shell); a non-shell context carries no shell on the derived Runtime failure.

pub fn summary(&self) -> String

pub fn failure_type(&self) -> &'static str

pub fn context(&self) -> &FailureContext

Trait Implementations

impl Clone for Failure

fn clone(&self) -> Failure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Failure

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

Formats the value using the given formatter.

impl Display for Failure

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

Formats the value using the given formatter.

impl Error for Failure

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<&Failure> for DiagnosticReport

fn from(failure: &Failure) -> Self

Converts to this type from the input type.

impl From<Failure> for ExecError

fn from(source: Failure) -> Self

Converts to this type from the input type.