Skip to content

Repository files navigation

OpenBIM.rs IDS

CI crates.io docs.rs MSRV

Pure-Rust infrastructure for the buildingSMART Information Delivery Specification (IDS): the machine-readable way to state what an IFC model must contain and audit whether it does.

This repository is the canonical home of the IDS family in OpenBIM.rs. The integration repository pins this repository under packages/ids.

Status

The published 0.1.0 release is a reserved scaffold, not an IDS parser or validator. It establishes stable crate ownership and the version/reporting contracts needed by the implementation.

Capability Status
Shared IDS XML namespace constant Implemented
Published-version model and approved-version test Implemented
IDS XML parsing Not implemented
IDS XML writing Not implemented
IFC applicability and requirement auditing Not implemented
buildingSMART pass/fail corpus conformance Not implemented

No parser, writer, or validation capability should be inferred from the crate existing on crates.io.

Crates

Crate Purpose
openbim-ids Canonical IDS types and, in future releases, parsing and auditing

Install

cargo add openbim-ids
use openbim_ids::{IdsVersion, NAMESPACE};

assert_eq!(NAMESPACE, "http://standards.buildingsmart.org/IDS");
assert!(IdsVersion::CURRENT.is_approved());

Version handling

Published IDS files share an XML namespace across multiple schema revisions. The namespace identifies IDS but does not prove a schema version. Future parsing must therefore return version evidence and surface disagreements rather than silently guessing.

Only IDS 1.0 is represented as the approved version for new documents. Older drafts remain relevant for reading existing files.

Architecture

IDS may consume shared openBIM and IFC contracts. IFC must never depend on IDS. That one-way dependency prevents the IFC layer from accumulating every standard that consumes IFC.

Standards material

No ISO, CEN, or other restricted schema artifact is vendored here. Source types may be implemented from legitimately accessed specifications, while conformance fixtures must have redistribution terms compatible with this repository.

Development

Requires Rust 1.85 or newer.

git clone https://github.com/openbimrs/ids.git
cd ids
./scripts/gate.sh

The gate checks formatting, build, tests, Clippy, rustdoc, and crates.io package verification using command exit codes.

Contributing

See CONTRIBUTING.md. Capability work must add executable conformance evidence and update the status table without overstating coverage.

License

AGPL-3.0-or-later — see LICENSE.

About

Pure-Rust buildingSMART IDS contracts; parser and IFC auditing roadmap for OpenBIM.rs.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages