Enum SchemaVersion 

#[non_exhaustive]
pub enum SchemaVersion {
    Ifc2x3,
    Ifc4,
    Ifc4x1,
    Ifc4x2,
    Ifc4x3,
}

Which IFC schema version a table describes.

#[non_exhaustive]: a release added later is a new variant, and a consumer’s match must say what it does with a release it has not proven – refuse it, never alias it to a neighbour.

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.

Ifc2x3

IFC2x3 TC1 — 653 entities. Still the most common in the wild.

Ifc4

IFC4 ADD2 TC1 — 776 entities. The ISO-standard release.

Ifc4x1

IFC4x1 FINAL — 801 entities. Adds alignment (IfcAlignment and its curves) to IFC4.

Ifc4x2

IFC4x2 FINAL — 816 entities. Adds bridges (IfcBridge, IfcFacility) to IFC4x1.

Ifc4x3

IFC4x3 ADD2 — 876 entities. Adds alignment and civil infrastructure.

Implementations

impl SchemaVersion

pub const ALL: [Self; 5]

Every version this crate knows, oldest first.

Which of them have bundled tables in a given build is a separate question; see for_version.

pub const fn release_id(self) -> &'static str

Exact published release identifier for the bundled structural table.

Examples found in repository

examples/export_structural_catalog.rs (line 59)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let requested = env::args().nth(1).ok_or_else(|| {
        io::Error::new(
            io::ErrorKind::InvalidInput,
            "usage: cargo run -p ifc-schema --example export_structural_catalog -- <ifc2x3|ifc4|ifc4x1|ifc4x2|ifc4x3> [--direct]",
        )
    })?;
    let version = match requested.to_ascii_lowercase().as_str() {
        "ifc2x3" | "ifc2x3_tc1" => SchemaVersion::Ifc2x3,
        "ifc4" | "ifc4_add2_tc1" => SchemaVersion::Ifc4,
        "ifc4x1" | "ifc4x1_final" => SchemaVersion::Ifc4x1,
        "ifc4x2" | "ifc4x2_final" => SchemaVersion::Ifc4x2,
        "ifc4x3" | "ifc4x3_add2" => SchemaVersion::Ifc4x3,
        _ => {
            return Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                format!("unsupported bundled IFC release: {requested}"),
            )
            .into());
        }
    };

    let direct = match env::args().nth(2).as_deref() {
        None => false,
        Some("--direct") => true,
        Some(value) => {
            return Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                format!("unsupported export option: {value}"),
            )
            .into());
        }
    };
    if env::args().nth(3).is_some() {
        return Err(io::Error::new(io::ErrorKind::InvalidInput, "too many arguments").into());
    }

    let stdout = io::stdout();
    let mut output = BufWriter::new(stdout.lock());
    let summary = if direct {
        write_direct_structural_catalog(version, &mut output)?
    } else {
        write_structural_catalog(version, &mut output)?
    };
    output.flush()?;
    eprintln!(
        "exported {} entities and {} types for {}",
        summary.entity_rows,
        summary.type_count,
        version.release_id()
    );
    Ok(())
}

pub const fn expected_entity_count(self) -> usize

Entity count asserted when the bundled artifact is generated.

pub const fn expected_type_count(self) -> usize

Defined-type count asserted when the bundled artifact is generated.

pub const fn header_tokens(self) -> &'static [&'static str]

Header tokens accepted for this release, excluding case-only variants.

pub const fn feature_name(self) -> &'static str

The ifc-schema cargo feature that bundles this release’s table.

pub const fn is_bundled(self) -> bool

Whether this build bundles this release’s table, i.e. whether for_version(self) succeeds.

pub fn from_header_token(token: &str) -> Option<Self>

Parse the token found in a STEP file’s FILE_SCHEMA header entry.

Trait Implementations

impl Clone for SchemaVersion

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SchemaVersion

impl Debug for SchemaVersion

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

Formats the value using the given formatter.

impl Eq for SchemaVersion

impl Hash for SchemaVersion

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SchemaVersion

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SchemaVersion