cadmpeg-ir 0.1.0

Provenance-rich intermediate representation and codec contract for the cadmpeg CAD transcoder.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

// SPDX-License-Identifier: Apache-2.0
//! # cadmpeg-ir
//!
//! The provenance-rich intermediate representation (IR) and codec contract at
//! the heart of the cadmpeg CAD transcoder.
//!
//! ## What the IR is
//!
//! A decoded CAD document is a [`CadIr`]: units, tolerances, and an exact B-rep
//! stored as flat, id-referenced arenas following the ACIS/ASM topology
//! hierarchy `body → region → shell → face → loop → coedge → edge → vertex`, with
//! geometry attached by reference (surfaces, curves, pcurves, points). In v1,
//! entity provenance and exactness are stored in the sparse document-wide
//! [`Annotations`] tables, keyed by globally unique entity id. Records the
//! decoder recognized but could not interpret are preserved as
//! [`UnknownRecord`]s rather than dropped.
//!
//! ## What is deliberately reserved
//!
//! Feature history is represented as ordered, source-provenanced operations.
//! Assembly structure remains reserved. See `docs/cad-ir.md`.
//!
//! ## The codec contract
//!
//! Format plugins implement [`Codec`]: [`Codec::detect`], [`Codec::inspect`]
//! (container enumeration), and [`Codec::decode`] (into a [`DecodeResult`] with
//! an honest [`DecodeReport`]). [`validate`] checks a document with in-IR
//! arithmetic only.

pub mod annotations;
pub mod appearance;
pub mod attributes;
pub mod bytes;
pub mod codec;
pub mod design;
pub mod diff;
pub mod document;
pub mod examples;
pub mod features;
pub mod geometry;
pub mod history;
pub mod ids;
pub mod math;
pub mod native;
mod provenance;
pub mod report;
pub mod reserved;
pub mod tessellation;
pub mod topology;
pub mod transform;
pub mod units;
pub mod validate;

pub use annotations::{AnnotationBuilder, Annotations, ExactnessNote, Provenance};
pub use codec::{
    Codec, CodecError, Confidence, ContainerEntry, ContainerSummary, DecodeOptions, DecodeResult,
    Encoder, ReadSeek,
};
pub use diff::{diff, ArenaDiff, IrDiff, ModifiedEntity};
pub use document::{CadIr, SourceMeta, IR_VERSION};
pub use features::{Feature, FeatureDefinition, FeatureId};
pub use native::{F3dNative, LossCount, Native, SldprtNative};
pub use provenance::Exactness;
pub use report::{
    Check, DecodeReport, Finding, LossCategory, LossNote, Severity, ValidationReport,
};
pub use unknown::UnknownRecord;
pub use validate::validate;

pub mod unknown;

/// Generate the JSON Schema for [`CadIr`] via `schemars`. Used by tooling and
/// documentation to publish the IR contract.
pub fn cadir_json_schema() -> schemars::Schema {
    schemars::schema_for!(CadIr)
}

#[cfg(test)]
mod tests;