Enum DocError 

#[non_exhaustive]
pub enum DocError {
    Io {
        path: PathBuf,
        source: Error,
    },
    Yaml(String),
    UnknownField(String),
    NotTestDocument {
        path: PathBuf,
    },
    MissingScenario,
    MixedVocabulary {
        found: String,
    },
    RouteSourceMissing,
    RouteSourceConflict {
        present: String,
    },
    Validation {
        index: usize,
        message: String,
    },
    UnsupportedProvisioning {
        value: String,
        endpoint: String,
    },
    ProvisioningWithoutAuthority {
        endpoint: String,
        ref_scheme: String,
    },
    ReservedEnvKey {
        key: String,
        endpoint: String,
    },
    Partners {
        endpoint: String,
        message: String,
    },
    InlineRoutes(String),
    InlineRoutesRejected,
    ExpectReplyOnUnsupportedSend {
        index: usize,
        scheme: String,
    },
    LogsBlock {
        detail: String,
    },
}

Parse and validation errors for scenario documents.

Exit-code mapping for the CLI adapter (ADR-0069 section 7): classification is by variant, never by message text. Every variant is a load-time failure and maps to exit 2.

• doc-validation class — Display carries the doc-validation: token: NotTestDocument, MissingScenario, MixedVocabulary, Validation, ReservedEnvKey, InlineRoutes, InlineRoutesRejected, ProvisioningWithoutAuthority, ExpectReplyOnUnsupportedSend, LogsBlock.
• infra-unavailable class — UnsupportedProvisioning (reserved provisioning grammar; Display names the class).
• Unit-tier message parity — RouteSourceMissing and RouteSourceConflict render the unit-tier parser’s messages verbatim, without the token, so both parsers report identical text; the CLI maps them to exit 2 as doc parse errors, the same as the unit tier does today.
• Read and serde failures — Io, Yaml, UnknownField map to exit 2 as doc parse errors (unreadable file, broken grammar).

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.

Io

The document file could not be read.

Fields

path: PathBuf

Path of the unreadable document.

source: Error

Underlying read failure.

Yaml(String)

Malformed YAML or a type mismatch at the serde layer.

UnknownField(String)

A deny_unknown_fields rejection.

NotTestDocument

The path lacks the reserved .test.yaml / .test.yml suffix.

Fields

path: PathBuf

The rejected path.

MissingScenario

The document declares no scenario: section.

MixedVocabulary

The document mixes the scenario vocabulary with unit-tier sections.

Fields

found: String

The unit-tier fields found, backticked and comma-joined.

RouteSourceMissing

No route source is declared. Same message as the unit-tier parser.

RouteSourceConflict

More than one route source is declared. Same message as the unit-tier parser.

Fields

present: String

The declared keys, backticked and comma-joined.

Validation

An action failed validation; index is the position in the scenario: list. An empty scenario: list is rejected with index 0 (the section, not an action, failed).

Fields

index: usize

Zero-based position of the action in the scenario: list.

message: String

What failed.

UnsupportedProvisioning

The endpoint declares a provisioning source that is reserved in v1; only harness is supported.

Fields

value: String

The rejected provisioning value.

endpoint: String

The endpoint that declared it.

ProvisioningWithoutAuthority

A provisioning: harness endpoint reference declares a bindVar while its scheme (direct: or fake:) binds no partner, so the variable would never receive a bound authority and the entry fails later as a verdict-class var-resolution error (rc-j87j). Rejected at load instead.

Fields

endpoint: String

The endpoint whose reference cannot fill the variable.

ref_scheme: String

The scheme of the endpoint reference (direct or fake).

ReservedEnvKey

A document env key equals an endpoint’s bindVar. The reserved set is exactly the bindVar values declared by the document’s own endpoints; the harness binding wins.

Fields

key: String

The reserved key.

endpoint: String

The endpoint that reserved it.

Partners

A partners entry failed validation; endpoint is the entry key of the failing script list.

Fields

endpoint: String

The endpoint key of the failing entry.

message: String

What failed.

InlineRoutes(String)

Inline routes failed to parse.

InlineRoutesRejected

The document’s route source is inline routes. Inline definitions cannot boot in v1; the author must declare routeFiles. Rejected at load, before partners bind, instead of failing the boot afterward (rc-9dpx).

ExpectReplyOnUnsupportedSend

A send declares expectReply on a scheme that produces no synchronous reply: only the context-stimulus direct: send returns one. Partner sends (http/https) park their roundtrips for a later receive, and fake: adapters record sends without answering, so the assertion could never run (rc-qvz6). Rejected at load, naming the action index, the scheme, and the literal expectReply field.

Fields

index: usize

Zero-based position of the action in the scenario: list.

scheme: String

The scheme of the send’s endpoint reference.

LogsBlock

A malformed document-level logs: block (rc-tdgh5): an unknown key, a level outside the accepted set, or a regex that does not compile. The detail names the offending clause.

Fields

detail: String

The offending clause and why it failed.

Trait Implementations

impl Debug for DocError

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

Formats the value using the given formatter.

impl Display for DocError

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

Formats the value using the given formatter.

impl Error for DocError

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.