Enum ResolveError 

#[non_exhaustive]
pub enum ResolveError {
    NotALocalReference {
        reference: String,
    },
    ExternalDocument {
        document: String,
    },
    MalformedPointer {
        reference: String,
    },
    UnsupportedRootSection {
        section: String,
    },
    UnknownSection {
        section: String,
    },
    ComponentsMissing {
        section: Section,
    },
    NotFound {
        section: Section,
        name: String,
    },
    SectionMismatch {
        expected: Section,
        found: Section,
    },
    PointerTooDeep {
        reference: String,
    },
    ReferenceChainTooLong {
        reference: String,
        last: String,
        max_hops: usize,
    },
    CyclicReference {
        reference: String,
    },
    DiscriminatorMappingMismatch {
        property_name: String,
        value: String,
        schema: String,
    },
}

Everything that can go wrong while resolving a $ref.

The variants distinguish a broken document (a dangling name, a $ref to the wrong kind of component) from a reference this crate structurally cannot follow (another file, a pointer into the middle of a component), so a caller can decide which ones are worth aborting on.

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.

NotALocalReference

The reference is not a JSON pointer into the current document.

Fields

reference: String

The reference as it appeared in the document.

ExternalDocument

The reference points into another document, which this crate does not load.

Fields

document: String

The part of the reference before the #, e.g. common.yaml.

MalformedPointer

The reference is a local pointer but has too few segments to name a component.

Fields

reference: String

The reference as it appeared in the document.

UnsupportedRootSection

The pointer starts at a section of the document that cannot hold $ref targets.

Fields

section: String

The first pointer segment, e.g. info.

UnknownSection

The pointer names a #/components sub-section that does not exist.

Fields

section: String

The offending segment, e.g. request_bodies instead of requestBodies.

ComponentsMissing

The pointer names a component but the document has no components object.

Fields

section: Section

The section the pointer asked for.

NotFound

The pointer is well formed but names something the section does not contain.

Fields

section: Section

The section that was searched.

name: String

The component name, after JSON pointer unescaping.

SectionMismatch

The pointer names a valid component of a different kind than the caller asked for.

Fields

expected: Section

The section implied by the requested type.

found: Section

The section the pointer actually names.

PointerTooDeep

The pointer continues past a component, into its contents.

Fields

reference: String

The reference as it appeared in the document.

ReferenceChainTooLong

The chain of references never reached an inline item; the document is most likely cyclic.

Fields

reference: String

The reference the walk started from.

last: String

The reference the walk gave up on, which is where the cycle runs.

max_hops: usize

The hop limit that was hit, crate::MAX_REFERENCE_HOPS.

CyclicReference

A component other than a schema contains, directly or through other components, a $ref back to itself, so it has no finite fully resolved form. A header whose content encoding names that same header is the one way a document can do this.

Schemas are allowed to contain themselves; see NestedSchema. Only ResolvedOpenAPI reports this; borrowing resolution stops at the first item and never notices the cycle.

Fields

reference: String

The $ref that closed the cycle, as it appeared in the document.

DiscriminatorMappingMismatch

A discriminator on a oneOf or anyOf schema maps a value to a schema that is not one of the alternatives, so the mapping could never select anything. Only ResolvedOpenAPI reports this.

Fields

property_name: String

The discriminator’s propertyName.

value: String

The payload value whose mapping is wrong.

schema: String

The name of the schema the mapping value denotes.

Trait Implementations

impl Clone for ResolveError

fn clone(&self) -> ResolveError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResolveError

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

Formats the value using the given formatter.

impl Display for ResolveError

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

Formats the value using the given formatter.

impl Eq for ResolveError

impl Error for ResolveError

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 ResolveError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ResolveError