Skip to main content

Crate openbim_icdd

Crate openbim_icdd 

Source
Expand description

openbim-icdd — ISO 21597 Information Container for linked Document Delivery.

ICDD is a ZIP container holding opaque payload documents plus RDF/XML that describes those documents and the links between their elements. This crate owns that container boundary; it deliberately does not parse IFC, PDF, or any other payload format.

ZIP and RDF/XML are handled directly by maintained upstream crates (zip, oxrdfxml, and oxrdf). OpenBIM.rs does not wrap those general formats in home-grown XML or ZIP codec packages.

§Implemented

  • deterministic ZIP reading and writing;
  • neutral Index.rdf and linkset views;
  • lazy, bounded payload access, streaming copies, and safe extraction;
  • raw RDF graph parse/serialize APIs that preserve unknown RDF semantics;
  • conformance diagnostics for the mandatory Part 1 layout.

Re-exports§

pub use rdf::parse_rdf_xml;
pub use rdf::serialize_rdf_xml;
pub use rdf::RdfXmlOptions;
pub use read::IcddContainer;
pub use schema::*;

Modules§

rdf
RDF/XML parsing and serialization backed by Oxigraph’s maintained crates.
read
ICDD container reader — open + decode Index.rdf and the linksets.
schema
The neutral in-memory IR for an ICDD container. Format-agnostic: no RDF terms leak up (they’re resolved in index.rs/linkset.rs), and no IFC coupling leaks in (payload IFCs are yielded as bytes/paths for callers to pass into an IFC pipeline). It follows the same codec/model boundary as CSET and SMC.
vocab
IRI constants for the two ISO 21597-1 ontologies plus the annotation vocabularies (Dublin Core, FOAF) that conformant containers use for provenance. Namespaces verified against the authoritative ontologies at https://standards.iso.org/iso/21597/-1/ed-1/en/Container.rdf and .../Linkset.rdf, and against the official AnnexA reference containers.

Structs§

IcddArchiveBuilder
Builds a deterministic ISO 21597-1 ZIP container.
PoingFederationManifest
Portable federation metadata stored by the Poing ICDD extension.
PoingFederationMember
One member in PoingFederationManifest.

Enums§

FederationIcddPayload
One source-model document bound to a federation member.
IcddError
Errors that can occur opening or parsing an ISO 21597-1 container.

Constants§

INDEX_PATH
Conventional path of the container index inside an ICDD archive.
ONTOLOGY_RESOURCES_DIR
Conventional directory holding ontology resources.
PAYLOAD_DOCUMENTS_DIR
Conventional directory holding payload documents.
PAYLOAD_TRIPLES_DIR
Conventional directory holding linkset RDF graphs.

Functions§

parse_poing_federation_icdd
Parse the portable Poing federation extension from an ICDD container.
write_poing_federation_icdd
Emit a deterministic ISO 21597-1 container plus a Poing federation graph.