Skip to main content

Schema

Struct Schema 

Source
pub struct Schema { /* private fields */ }
Expand description

An IFC schema: the entity and type tables, queryable.

Every lookup folds ASCII case: Part 21 spells IFCWALL, the schema IfcWall, and either may be passed.

Implementations§

Source§

impl Schema

Source

pub fn new( name: impl Into<String>, entities: Vec<EntityDef>, types: Vec<TypeDef>, ) -> Self

Assembles a schema from declarations in source order.

A name declared more than once keeps its first position and its last declaration, so counts are of distinct names.

Source

pub fn from_express(source: &str) -> Self

Parses EXPRESS source into a schema.

Requires the express feature, which links the openbim-step EXPRESS extractor. Its result is converted into this crate’s own types; explicit attribute redeclarations are not recorded.

Source

pub fn from_express_bytes(bytes: &[u8]) -> Self

Parses EXPRESS source that is not valid UTF-8.

The normative IFC4.exp is Latin-1: it contains ° and similar in comments. Decoding byte-per-char is correct for the ASCII structure this parser reads and cannot fail. Requires the express feature.

Source

pub fn name(&self) -> &str

The declared schema name, e.g. IFC4.

Source

pub fn version(&self) -> Option<SchemaVersion>

The IFC schema version this table describes, when recognized.

This is the one genuinely IFC-specific query on this type: it maps a declared schema name onto the versions this crate knows about.

Source

pub fn entity_count(&self) -> usize

How many entity declarations the schema holds.

Source

pub fn type_count(&self) -> usize

How many type declarations the schema holds.

Source

pub fn entity(&self, name: &str) -> Option<&EntityDef>

The entity declaration for name, if the schema declares one.

Source

pub fn type_def(&self, name: &str) -> Option<&TypeDef>

The type declaration for name, if the schema declares one.

Source

pub fn entities(&self) -> impl Iterator<Item = &EntityDef>

Every entity declaration, in source order.

Source

pub fn types(&self) -> impl Iterator<Item = &TypeDef>

Every type declaration, in source order.

Source

pub fn entity_names(&self) -> impl Iterator<Item = &str>

Every entity name the schema declares.

Source order today; callers needing a particular order must sort.

Source

pub fn accepts_type(&self, declared: &str, candidate: &str) -> bool

Whether a candidate entity or defined type satisfies a declared type.

This walks entity inheritance, defined-type aliases, and nested SELECTs. Unknown declarations and cyclic aliases fail closed.

Source

pub fn is_a(&self, name: &str, ancestor: &str) -> bool

Whether name is ancestor, or inherits from it.

Reflexive for declared entities. An entity the schema never declares is not a subtype of anything, including itself – otherwise a typo would silently satisfy every check made against it.

Source

pub fn supertypes(&self, name: &str) -> Vec<&str>

The supertype chain above name, nearest parent first.

Depth-first in SUBTYPE OF order, each ancestor once, excluding name. A supertype the schema names but never declares is reported but cannot be walked past. Terminates on a malformed cyclic schema.

Source

pub fn direct_subtypes(&self, name: &str) -> Vec<&str>

Entities declaring SUBTYPE OF (name) directly, sorted by name.

Source

pub fn subtypes(&self, name: &str) -> Vec<&str>

Every entity inheriting from name at any depth, excluding name.

Sorted depth-first pre-order. The inverse of Self::is_a.

Source

pub fn attributes(&self, name: &str) -> Vec<&Attribute>

Every attribute slot in Part 21 positional order, inherited first.

ISO 10303-21:2016 §12.2.5.2: each supertype is laid out in SUBTYPE OF order, its own supertypes first, and a supertype reached a second time contributes nothing more. Derived redeclarations are included (they keep their slot and are written *); use EntityDef::is_derived on the owning entity to tell them apart.

Source

pub fn attribute_count(&self, name: &str) -> usize

How many positional slots Self::attributes lists for name; 0 for an entity the schema does not declare.

Read from the precomputed layout, without allocating.

Source

pub fn attribute_at(&self, name: &str, slot: usize) -> Option<&Attribute>

The attribute at positional slot of name, as attributes(name).get(slot) answers, without allocating.

Source

pub fn attribute_names(&self, name: &str) -> Vec<&str>

Attribute names in positional order.

Source

pub fn resolve_defined(&self, name: &str) -> String

Resolves a defined type to the base it ultimately aliases.

IfcPositiveLengthMeasure -> IfcLengthMeasure -> REAL. Returns the final right-hand side verbatim (including any aggregate syntax); for a declaration that is not an alias, the type’s own name. Bounded so a cyclic alias cannot hang.

Trait Implementations§

Source§

impl Clone for Schema

Source§

fn clone(&self) -> Schema

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 Schema

Source§

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

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

impl Eq for Schema

Source§

impl PartialEq for Schema

Equal when the name and the declarations, in order, are equal.

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

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<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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.