Skip to main content

ClassificationError

Enum ClassificationError 

Source
#[non_exhaustive]
pub enum ClassificationError { WrongEntityType { expected: &'static str, actual: String, }, MissingAttribute { entity: &'static str, id: EntityId, attribute: &'static str, }, InvalidValue { entity: &'static str, id: EntityId, attribute: &'static str, value: String, }, UnknownEntity { id: EntityId, }, DanglingReference { entity: &'static str, id: EntityId, attribute: &'static str, target: EntityId, }, ReferenceType { entity: &'static str, id: EntityId, attribute: &'static str, target: EntityId, expected: &'static str, actual: String, }, Cycle { path: Vec<EntityId>, }, BudgetExceeded { max_depth: usize, max_nodes: usize, }, AmbiguousType { object: EntityId, count: usize, }, AuthoringInvalid { entity: &'static str, attribute: &'static str, value: String, }, AuthoringReferenceType { target: EntityId, expected: &'static str, actual: String, }, }
Expand description

Failure decoding, cross-checking, or authoring classification/document/library records.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

WrongEntityType

Entity did not have the expected IFC type.

Fields

§expected: &'static str

IFC type name expected at this position.

§actual: String

IFC type name actually found.

§

MissingAttribute

A required attribute was unset ($ or *) or absent.

Fields

§entity: &'static str

IFC entity type of the offending instance.

§id: EntityId

Id of the offending instance.

§attribute: &'static str

Name of the missing attribute.

§

InvalidValue

An attribute was present but failed to decode as its expected shape.

Fields

§entity: &'static str

IFC entity type of the offending instance.

§id: EntityId

Id of the offending instance.

§attribute: &'static str

Name of the invalid attribute.

§value: String

Debug rendering of the offending value.

§

UnknownEntity

A referenced entity id does not exist in the model.

Fields

§id: EntityId

Id that could not be resolved.

§

DanglingReference

An attribute reference points at an id that is not present in the model.

Fields

§entity: &'static str

IFC entity type holding the dangling reference.

§id: EntityId

Id of the entity holding the dangling reference.

§attribute: &'static str

Name of the attribute holding the dangling reference.

§target: EntityId

Id that could not be resolved.

§

ReferenceType

An attribute reference resolves but the target entity has the wrong type for its select.

Fields

§entity: &'static str

IFC entity type holding the mistyped reference.

§id: EntityId

Id of the entity holding the mistyped reference.

§attribute: &'static str

Name of the attribute holding the mistyped reference.

§target: EntityId

Id of the mistyped target.

§expected: &'static str

Select or type name the target was expected to satisfy.

§actual: String

IFC type name the target actually has.

§

Cycle

Following ReferencedSource links revisited an already-seen entity.

Fields

§path: Vec<EntityId>

Entity ids on the cycle, in traversal order.

§

BudgetExceeded

Hierarchy traversal exceeded the caller-supplied node or depth budget.

Fields

§max_depth: usize

Maximum edge depth allowed.

§max_nodes: usize

Maximum number of nodes allowed.

§

AmbiguousType

An occurrence object is related to more than one IfcRelDefinesByType type.

Fields

§object: EntityId

The occurrence object with the ambiguous type assignment.

§count: usize

Number of types the object was found related to.

§

AuthoringInvalid

A draft value failed schema validation before staging.

Fields

§entity: &'static str

IFC entity type being authored.

§attribute: &'static str

Name of the offending attribute.

§value: String

Description of why the value is invalid.

§

AuthoringReferenceType

A draft reference resolves to a staged or committed entity of the wrong type.

Fields

§target: EntityId

Id of the mistyped reference target.

§expected: &'static str

Select or type name the target was expected to satisfy.

§actual: String

IFC type name the target actually has.

Trait Implementations§

Source§

impl Clone for ClassificationError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClassificationError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ClassificationError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for ClassificationError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl PartialEq for ClassificationError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ClassificationError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.