Enum CaptureFailure 

pub enum CaptureFailure {
    Shadowed {
        environment: Option<PathBuf>,
    },
    InvalidPath {
        reason: String,
    },
    BodyNotJson {
        reason: String,
        content_type: Option<String>,
    },
    NoMatch,
    Ambiguous {
        count: usize,
        sample: Vec<String>,
    },
    NotAScalar {
        kind: &'static str,
    },
    HeaderNotFound {
        header: String,
        present: Vec<String>,
    },
}

Why one entry of a capture block did not produce a value.

Typed rather than a bare string so a front-end can branch on it — and so the granularity the assertion JSON paths already draw (“not a valid JSON path” is a broken file, “the body is not JSON” is a fact about this response, “matched nothing” is a fact about the pair) survives into anything reading a run rather than being recoverable only by matching on prose. Display renders the wording, in core, so every front-end says the same thing about the same failure.

Variants

Shadowed

The name is already defined by the active environment file. See the note on this variant’s message for why that is rejected rather than resolved in either direction.

Fields

environment: Option<PathBuf>

The environment file that already defines the name, or None when the environment did not come from a file.

InvalidPath

The path is not a JSON path at all.

Fields

reason: String

BodyNotJson

The response body did not parse as JSON, so there was nothing to query.

Fields

reason: String

serde_json’s own message, position included.

content_type: Option<String>

The response’s content-type, when it had one — a body with none at all is a different mistake from one that announced text/html.

NoMatch

The path is valid and the body is JSON, and the path selected nothing.

Ambiguous

The source selected more than one value, so there is no single value to bind the name to. Raised for a JSON path matching several values, and — the same philosophy applied to a second source — for a header capture whose name repeats in the response (Set-Cookie is the common case). See the module docs for why a capture does not resolve a repeated header by taking the first or last value, the way an assertion checking the same header does.

Fields

count: usize

sample: Vec<String>

The first few matches, rendered, for the message.

NotAScalar

The path selected exactly one value and that value has no text form a {{name}} could be replaced with: null, an array or an object.

Fields

kind: &'static str

null, an array, an object.

HeaderNotFound

A header: capture named a header the response does not carry.

Fields

header: String

present: Vec<String>

The header names the response does carry, for the same reason a missing assertion header lists them: the answer is usually a casing or spelling difference, visible once both are on screen.

Trait Implementations

impl Clone for CaptureFailure

fn clone(&self) -> CaptureFailure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CaptureFailure

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

Formats the value using the given formatter.

impl Display for CaptureFailure

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

Formats the value using the given formatter.

impl Eq for CaptureFailure

impl PartialEq for CaptureFailure

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CaptureFailure