Enum ScenarioFailure 

#[non_exhaustive]
pub enum ScenarioFailure {
    ReceiveTimeout {
        endpoint: String,
        deadline: Duration,
        lanes: String,
    },
    ValidationMismatch {
        action: usize,
        detail: String,
    },
    VarUnresolved {
        name: String,
    },
    ActionTransport {
        action: usize,
        source: TransportError,
    },
    PartnerStartup {
        message: String,
    },
    ArrivalLaneOverflow {
        endpoint: String,
        dropped: usize,
    },
    ShutdownFailure {
        message: String,
    },
    LogCaptureUnavailable {
        detail: String,
    },
}

Why a scenario failed (ADR-0069 §7). Verdict-class variants mean the system under test failed the scenario; apparatus-class variants mean the scenario never got a meaningful answer. The CLI maps verdict-class failures to exit 1 and apparatus-class failures to exit 2; doc validation also maps to exit 2.

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.

ReceiveTimeout

Nothing reached the partner before the deadline (verdict class, receive-timeout).

Fields

endpoint: String

The endpoint URI that delivered nothing.

deadline: Duration

The deadline that elapsed.

lanes: String

Rendered lane evidence (already redacted, ADR-0051): the ; no arrival matched; lanes recorded: [...] suffix, or empty when the construction site saw no lanes.

ValidationMismatch

A validation failed (verdict class, validation-mismatch).

Fields

action: usize

Index of the failing action, zero-based.

detail: String

What was expected and what arrived.

VarUnresolved

A referenced variable was never set (apparatus class, scenario-var-unresolved, bd rc-whof): an unset variable is an authoring bug, not a product failure — the scenario never got a meaningful answer.

Fields

name: String

The variable name no extract ever set.

ActionTransport

A send or receive failed at the transport before any assertion ran (apparatus class, action-transport-failure).

Fields

action: usize

Index of the failing action, zero-based.

source: TransportError

The transport failure.

PartnerStartup

A partner listener bound but its handler failed to start (apparatus class, partner-startup-failure). Reserved in v1: no adapter separates bind from handler start, and the CLI maps bind failures to partner-bind-failure doc errors.

Fields

message: String

Startup failure detail.

ArrivalLaneOverflow

The partner’s arrival lane dropped arrivals while the scenario was not receiving (apparatus class, arrival-lane-overflow): the harness lost them before the system under test could fail the scenario on substance.

Fields

endpoint: String

The endpoint URI whose lane dropped arrivals.

dropped: usize

How many arrivals the lane dropped while full.

ShutdownFailure

Teardown of the boot or a partner timed out or erred after the verdict was recorded (apparatus class, shutdown-failure).

Fields

message: String

Teardown failure detail.

LogCaptureUnavailable

The document declares a logs: block but the harness’s capture subscriber does not own the process’s tracing seat (apparatus class, log-capture-unavailable, rc-tdgh5): a foreign tracing subscriber won the first-wins try_init, so the events the block asserts against never reach the harness. The scenario never got a meaningful answer.

Fields

detail: String

Why capture cannot run (the foreign-subscriber condition).

Trait Implementations

impl Clone for ScenarioFailure

fn clone(&self) -> ScenarioFailure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScenarioFailure

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

Formats the value using the given formatter.

impl Display for ScenarioFailure

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

Formats the value using the given formatter.

impl Error for ScenarioFailure

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 ScenarioFailure

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScenarioFailure