Struct OpenApiDiagnostic 

pub struct OpenApiDiagnostic {
    pub kind: DiagnosticKind,
    pub pointer: Option<String>,
    pub source_preview: Option<String>,
    pub context: Option<String>,
    pub line: Option<usize>,
}

Structured diagnostic emitted by the OpenAPI importer. Implements std::error::Error so it can be stored inside anyhow::Error, enabling callers to downcast and inspect the structured data instead of parsing the human-readable error string.

Fields

kind: DiagnosticKind

Machine-readable classification of the issue.

pointer: Option<String>

JSON pointer into the document where the issue was detected.

source_preview: Option<String>

A snippet of the document at the pointer location.

context: Option<String>

Human-readable context when there is no pointer (e.g. "parameter \foo`“`).

line: Option<usize>

Approximate 1-based source line for the node at pointer, when resolvable.

Implementations

impl OpenApiDiagnostic

pub fn from_pointer( kind: DiagnosticKind, pointer: impl Into<String>, source_preview: Option<String>, line: Option<usize>, ) -> Self

pub fn from_named_context( kind: DiagnosticKind, context: impl Into<String>, ) -> Self

pub fn simple(kind: DiagnosticKind) -> Self

pub fn note(&self) -> Option<&str>

Returns the human-readable note text for this diagnostic, if any.

pub fn classify(&self) -> (&'static str, String)

Returns the corpus (kind, feature) classification for this diagnostic.

This is the canonical mapping from DiagnosticKind to the string identifiers used in corpus reports. Keeping it here means adding a new variant produces a compile error at the definition site.

pub fn unsupported_kind_for_pointer( pointer: Option<&str>, feature: &str, ) -> &'static str

Trait Implementations

impl Clone for OpenApiDiagnostic

fn clone(&self) -> OpenApiDiagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiDiagnostic

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

Formats the value using the given formatter.

impl Display for OpenApiDiagnostic

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

Formats the value using the given formatter.

impl Error for OpenApiDiagnostic

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.