Enum RefError 

#[non_exhaustive]
pub enum RefError {
    External {
        ref_str: String,
    },
    TargetNotFound {
        ref_str: String,
    },
    Cycle {
        ref_str: String,
    },
    SiblingKeysIgnored {
        ref_str: String,
    },
}

Non-fatal error for a specific $ref pointer.

The resolver handled these gracefully by preserving the raw $ref object in the output, but the reference was not expanded.

Use ref_str() to extract the $ref value without pattern matching.

Variants

Variant	Cause	Raw $ref preserved?
External	URI like https://… or ./file.json	Yes
TargetNotFound	JSON Pointer resolves to nothing	Yes
Cycle	Already visiting this ref (recursion loop)	Yes
SiblingKeysIgnored	Resolved target is not an object; siblings dropped	No (ref resolved)

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.

External

External URI reference — not supported by this resolver.

Produced when a $ref value does not start with #. Examples: https://example.com/schema.json, ./common.yaml#/Foo.

Fields

ref_str: String

The full $ref string (e.g. "https://example.com/schema.json").

TargetNotFound

Internal reference target not found in the document.

The $ref starts with # but the JSON Pointer does not resolve to any value in the root document.

Fields

ref_str: String

The full $ref string (e.g. "#/components/schemas/Missing").

Cycle

Circular reference detected — kept as raw $ref to break the cycle.

The target exists but is already being resolved in the current call stack. The raw $ref object is preserved to prevent infinite recursion.

Fields

ref_str: String

The full $ref string (e.g. "#/components/schemas/Node").

SiblingKeysIgnored

Sibling keys alongside $ref were dropped because the resolved target is not a JSON object and merging is impossible.

The $ref itself was successfully resolved, but any sibling keys (e.g. description, title) present in the same object were lost because they cannot be merged into a non-object value.

Fields

ref_str: String

The full $ref string (e.g. "#/definitions/status").

Implementations

impl RefError

pub fn ref_str(&self) -> &str

Returns the $ref string that caused this error.

This is a convenience accessor that avoids pattern matching when you only need the ref string regardless of the error variant.

Example

use openapi_deref::RefError;

let err = RefError::TargetNotFound { ref_str: "#/missing".into() };
assert_eq!(err.ref_str(), "#/missing");

Trait Implementations

impl Clone for RefError

fn clone(&self) -> RefError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefError

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

Formats the value using the given formatter.

impl Display for RefError

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

Formats the value using the given formatter.

impl Error for RefError

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 RefError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RefError

impl StructuralPartialEq for RefError