Enum ParseError 

#[non_exhaustive]
pub enum ParseError {
    MalformedXml {
        message: String,
        source_code: NamedSource<String>,
        span: Option<SourceSpan>,
    },
    Missing {
        what: String,
        source_code: NamedSource<String>,
        span: Option<SourceSpan>,
    },
    Invalid {
        what: String,
        value: String,
        source_code: NamedSource<String>,
        span: Option<SourceSpan>,
    },
    Resolve {
        source_code: NamedSource<String>,
        span: Option<SourceSpan>,
        second_label: Option<SourceSpan>,
        error: Box<ResolveError>,
    },
    Io {
        path: PathBuf,
        source: Error,
    },
    Include {
        href: String,
        attempted: Vec<PathBuf>,
        cause: IncludeCause,
        source_code: NamedSource<String>,
        span: Option<SourceSpan>,
    },
}

Errors raised while parsing an SBE schema. Carries a miette source span so the offending XML element is highlighted in the rendered diagnostic.

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.

MalformedXml

The XML document itself was malformed.

Fields

message: String

What went wrong.

source_code: NamedSource<String>

The source document, for span rendering.

span: Option<SourceSpan>

The offending location, when available.

Missing

A required attribute or element was missing.

Fields

what: String

What was missing (element/attribute context).

source_code: NamedSource<String>

The source document, for span rendering.

span: Option<SourceSpan>

The offending location, when a node was available.

Invalid

An attribute value was invalid.

Fields

what: String

What was invalid.

value: String

The offending value.

source_code: NamedSource<String>

The source document, for span rendering.

span: Option<SourceSpan>

The offending location.

Resolve

A schema resolution or validation error occurred.

Fields

source_code: NamedSource<String>

The source document, for span rendering.

span: Option<SourceSpan>

The primary offending location.

second_label: Option<SourceSpan>

Secondary label (e.g. for duplicate definitions).

error: Box<ResolveError>

The underlying resolution error.

Io

Root schema file could not be read.

Fields

path: PathBuf

Path that failed to read.

source: Error

Underlying I/O error.

Include

An include (xi:include) resolution error occurred.

Fields

href: String

The href attribute from the include element.

attempted: Vec<PathBuf>

Candidate paths that were tried, in order.

cause: IncludeCause

Machine-readable failure kind.

source_code: NamedSource<String>

The source document, for span rendering.

span: Option<SourceSpan>

The offending include element, when available.

Trait Implementations

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Diagnostic for ParseError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Error for ParseError

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 From<ParseError> for BuildError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<ResolveError> for ParseError

fn from(e: ResolveError) -> Self

Converts to this type from the input type.