Enum XmlError 

#[non_exhaustive]
pub enum XmlError {
    Malformed(String),
    BadId(String),
    InvalidScalar {
        kind: String,
        value: String,
    },
    UnknownKind(String),
    DuplicateSlot {
        name: String,
        slot: usize,
    },
    MissingSlot {
        name: String,
        slot: usize,
        missing: usize,
    },
    Namespace {
        element: String,
        expected: &'static str,
        found: Option<String>,
    },
    Profile {
        expected: &'static str,
        found: Option<String>,
    },
    Root {
        found: Option<String>,
    },
    At {
        path: XmlPath,
        source: Box<XmlError>,
    },
    Write(String),
    UnknownEntity {
        name: String,
    },
    AbstractEntity {
        name: String,
    },
    UnknownAttribute {
        entity: String,
        element: String,
        attribute: String,
    },
    TypeMismatch {
        declared: String,
        found: String,
    },
    WrongForm {
        attribute: String,
        expected: &'static str,
        found: &'static str,
    },
    UnresolvedReference {
        id: String,
    },
    DuplicateId {
        id: String,
    },
    InverseConflict {
        inverse: String,
        relationship: String,
        attribute: String,
        detail: String,
    },
    SchemaMismatch {
        profile: &'static str,
        schema: String,
    },
    Unrepresentable {
        construct: String,
    },
    Unsupported {
        construct: String,
    },
}

Failures specific to reading or writing ifcXML.

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.

Malformed(String)

The document is not well-formed XML.

BadId(String)

An id attribute was not in the expected i<number> form.

InvalidScalar

A typed scalar did not contain a value of its declared kind.

Fields

kind: String

Declared scalar kind.

value: String

Invalid lexical value.

UnknownKind(String)

A non-empty explicit kind is not part of this lossless dialect.

DuplicateSlot

Two attributes or child elements of one entity name the same slot.

Fields

name: String

The second name resolving to the slot.

slot: usize

The zero-based positional slot.

MissingSlot

A positional name skips slots that no schema declares as omittable.

Fields

name: String

The name that skipped ahead.

slot: usize

The zero-based slot it names.

missing: usize

The first slot left without a value.

Namespace

An element resolved outside the selected release namespace.

Fields

element: String

Element local name.

expected: &'static str

Required namespace URI.

found: Option<String>

Resolved namespace URI, if any.

Profile

Root schema metadata disagrees with the selected release profile.

Fields

expected: &'static str

Required schema token.

found: Option<String>

Declared root schema token, if any.

Root

A strict document did not have the required root element.

Fields

found: Option<String>

First element local name, if any.

At

A parsing error with its entity/value location retained.

Fields

path: XmlPath

XPath-like parser location.

source: Box<XmlError>

Underlying typed parse error.

Write(String)

Writing to the output buffer failed.

UnknownEntity

An element names an entity type the schema does not declare.

Fields

name: String

The element or type name as written.

AbstractEntity

An abstract entity was instantiated.

Fields

name: String

The declared entity name.

UnknownAttribute

An XML attribute or child element that no attribute of the entity declares. Never placed into a free slot.

Fields

entity: String

The entity type, as the schema declares it.

element: String

The XML element carrying it: the entity’s own element, which is an attribute name when the entity is defined in place.

attribute: String

The XML attribute or child element name.

TypeMismatch

A value whose kind the declared type does not admit: an integer in a label, a reference where a measure is declared, an entity or typed value outside its SELECT.

Fields

declared: String

The declared type, in EXPRESS terms.

found: String

What the document holds, in words.

WrongForm

An attribute written in a form its declared type does not take in this layout: a simple value as a child element, or an entity reference as an XML attribute.

Fields

attribute: String

The attribute name.

expected: &'static str

The form the layout requires.

found: &'static str

The form the document used.

UnresolvedReference

A reference to an id no element of the document defines.

Fields

id: String

The referenced id as written.

DuplicateId

Two elements define the same id.

Fields

id: String

The repeated id.

InverseConflict

An inverse attribute implies a value its relationship contradicts.

Fields

inverse: String

The inverse attribute’s name.

relationship: String

The relationship entity’s type.

attribute: String

The relationship’s explicit attribute the inverse inverts.

detail: String

Why the implied value cannot be placed.

SchemaMismatch

The schema given does not describe the selected release profile.

Fields

profile: &'static str

The profile’s schema token.

schema: String

The given schema’s name.

Unrepresentable

Model content the buildingSMART XSD configuration cannot carry exactly: a value a reader would read back differently, or that the release XSD would refuse. The XSD writer refuses it rather than write a different model or an invalid document.

Fields

construct: String

What cannot be written, in words.

Unsupported

Valid content this reader or writer does not implement. Refused, never approximated.

Fields

construct: String

What was met, in words.

Implementations

impl XmlError

pub fn path(&self) -> Option<&XmlPath>

Location retained by the reader, when the failure occurred in document content.

pub fn root_cause(&self) -> &Self

Innermost codec error, without discarding the inspectable path.

Trait Implementations

impl Clone for XmlError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmlError

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

Formats the value using the given formatter.

impl Display for XmlError

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

Formats the value using the given formatter.

impl Error for XmlError

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<Error> for XmlError

fn from(error: Error) -> Self

Converts to this type from the input type.