Expand description
Python-independent parsing core for Parasolid transmit data.
§parasolid-core
Python-independent Rust parser for Parasolid X_B and X_T transmit data, with
exact schema selection, bounded raw-node decoding, source byte ranges, and a
Parasolid-native B-Rep model. This crate is part of
parasolid-kit.
[dependencies]
parasolid-core = "=0.1.0"Inspect a header without claiming that the geometry is supported:
use parasolid_core::{InspectionLimits, inspect_xb};
let header = inspect_xb(bytes, InspectionLimits::default())?;
println!("{}: nodes start at {}", header.schema_key, header.header_range.end);For a supported key, select its compiled provider before parsing. An exact
profile is selected when one accepts the complete key; otherwise the provider
derived for the key’s schema family (the key without its modeller build) is
selected and the document reports family_inferred coverage:
use parasolid_core::{
BuiltinProfileRegistry, DocumentLimits, InspectionLimits, SchemaKey,
brep::map_xb_brep, inspect_xb, parse_xb,
};
let header = inspect_xb(bytes, InspectionLimits::default())?;
let key = SchemaKey::parse(&header.schema_key)?;
let registry = BuiltinProfileRegistry::compiled()?;
let provider = registry.provider_for_key(&key).ok_or("unsupported schema key")?;
let document = parse_xb(bytes, &provider, DocumentLimits::default())?;
let brep = map_xb_brep(&document)?;
println!("{} bodies; complete={}", brep.bodies.len(), brep.complete);The compiled profiles are listed in the
shared support matrix,
with exact keys, revisions, hashes, and separate raw/B-Rep/geometry evidence.
A supported header, schema key, or raw record does not imply complete
geometric support. An explicit
SchemaProvider can supply an exact external catalog. Within the built-in
registry, only the modeller build may differ from a reviewed key: another
schema revision or base is never substituted. SolidWorks containers and configuration selection belong
to the caller. SolidWorks deltas are unsupported even when their header uses
the same supported partition key; no final saved configuration is reconstructed.
BrepModel.complete describes source mapping for that document. It does not
certify interpreted attributes, numerical geometry evaluation, available curved
metrics, or optional conversion. iCAD container extraction and saved-state
selection belong to the caller; this crate consumes extracted streams.
The exact iCAD embedded and standard profiles also use BuiltinProfileRegistry::compiled().
Their extra base types are scoped to the exact keys in the support matrix; a
standard profile declares only the node types checked under its key.
SPUN_SURF (68) preserves raw parameters and yields an unsupported surface with
complete == false; BLEND_BOUND (59), its blend dependency, and SP_CURVE (137)
use the qualified source B-Rep mappings. This does not add OCCT conversion.
Lengths and identifiers retain their Parasolid source meaning. Byte ranges are
relative to the complete byte slice supplied to the parser. Embedding applications
must track container/decompression offsets and any unit or public-ID conversion.
write_xb returns the retained original bytes, not an encoder for edited values.
The parser requires Rust 1.88 or newer and has no runtime dependencies, Python, CAD installation, or network requirement. Built-in runtime, build and installation require no external catalog. Development-only catalog comparisons and type-204 membership evidence remain described in the profile provenance; no catalog field layouts are generated into the built-in definitions by those comparisons. OCCT, STEP export, and preview adapters are separate optional Python functionality in parasolid-kit. See the repository’s format support and profile provenance for the verified boundaries.
Real CAD fixtures and external schema catalogs are not included in this crate. See the license and partial-reader provenance below.
Maintainer sanitizer and measurement procedures, including the distinction between parser and caller resource bounds, are documented in resource validation.
§Rust API compatibility
Starting with the first stable 0.1.0 release, patch releases in the 0.1.x
series will preserve source compatibility for documented public Rust APIs,
including the public document/B-Rep models and partial reader types. Breaking
changes require a new minor series. Prereleases such as 0.1.0-dev6 remain
development releases; this policy does not retroactively make them stable.
Compatibility includes source units, IDs, byte-range origins and the distinction between strict document parsing and bounded partial recovery described above and in PARTIAL_READERS.md. Fixing acceptance of invalid input or incorrectly interpreted values is allowed; such changes must be documented and covered by regression tests. New profiles or recovered carriers may change results, diagnostics and coverage, so callers must inspect the reported support and completeness rather than assume a fixed count or treat partial recovery as full decoding. Human-readable diagnostic text is not a stable matching key.
§Releasing
The Rust crate is published independently of Python artifacts, using the same
verified candidate commit. Follow the
release verification procedure.
The manual Rust core release workflow requires a private verification receipt
and checks the candidate artifact hashes. Its default is a dry run; uploading
requires CARGO_REGISTRY_TOKEN in repository secrets. Python publication checks
the published Rust checksum and reuses the verified Python artifacts.
For existing embedded fragment integrations, parasolid_core::partial provides
bounded topology, analytic/NURBS, and procedural-carrier readers in source units.
It does not replace schema-aware parsing or establish complete delta semantics.
See the API boundary, provenance and licenses.
The original implementation is MIT licensed; adopted partial readers are
Apache-2.0 licensed. This crate declares MIT AND Apache-2.0 and distributes both
license texts.
Re-exports§
pub use schema::BuiltinProfileCoverage;pub use schema::BuiltinProfileMetadata;pub use schema::BuiltinProfileRegistry;pub use schema::BuiltinSchemaProfile;pub use schema::BuiltinSchemaProvider;pub use schema::EffectiveSchemaRegistry;pub use schema::FamilyMember;pub use schema::FieldDefinition;pub use schema::FieldType;pub use schema::InMemorySchemaProvider;pub use schema::ParsedSchemaCatalog;pub use schema::SchemaCatalogLimits;pub use schema::SchemaCoverageReport;pub use schema::SchemaEdit;pub use schema::SchemaKey;pub use schema::SchemaLimits;pub use schema::SchemaProvider;pub use schema::SchemaProviderProvenance;pub use schema::SchemaProviderResolution;pub use schema::SchemaResolution;pub use schema::SchemaSource;pub use schema::SchemaTypeLookup;pub use schema::TypeDefinition;pub use schema::decode_embedded_schema;pub use schema::parse_schema_catalog;
Modules§
- brep
- Parasolid-native B-Rep source model and raw-document mapping.
- partial
- Bounded readers for partial embedded transmit fragments. Partial record readers for embedded transmit fragments.
- schema
- Base, delta, and complete embedded schema resolution.
Structs§
- Binary
Reader - A non-owning reader that reports absolute offsets for every failure.
- Comparison
Difference - One normalized difference, independent of physical byte layout.
- Comparison
Options - Bounds and tolerances for one normalized document comparison.
- Document
Comparison - Staged L3 comparison report for two complete raw documents.
- Document
Limits - Resource bounds applied while framing a complete node stream.
- Inspection
Limits - Resource bounds needed before node-stream parsing begins.
- Parse
Error - A strict parse failure located in the original input.
- RawField
- One decoded effective field and its exact source range.
- RawNode
- One non-termination node in source order.
- XbDocument
- A complete neutral-binary raw document ending at a validated terminator.
- XbHeader
- Header fields confirmed without decoding a node body.
- XbTermination
- Validated end marker for a complete node stream.
- XtDocument
- A complete raw
X_Tdocument ending at a validated terminator. - XtHeader
- Fields confirmed before decoding an
X_Tnode body. - XtTermination
- Validated text termination marker.
Enums§
- Error
Details - Machine-readable values associated with one parser failure.
- Error
Kind - Stable categories used to map native failures to public diagnostics.
- Field
Value - One scalar or fixed composite decoded according to an effective schema field.
- XbBinary
Format - Physical binary representation selected by the
PSflag sequence.
Functions§
- compare_
xb_ documents - Compare two binary documents while ignoring byte ranges and source order.
- compare_
xb_ xt_ documents - Compare a binary document with a text document using normalized raw values.
- compare_
xt_ documents - Compare two text documents while ignoring wrapping, byte ranges, and source order.
- compare_
xt_ xb_ documents - Compare a text document with a binary document using normalized raw values.
- inspect_
xb - Inspect one raw
X_Bfamily payload without decoding its node stream. - inspect_
xt - Inspect one
X_Theader without decoding its node stream. - parse_
xb - Parse every node in one neutral
X_Bpayload using an explicit base-schema provider. - parse_
xt - Parse every node in one
X_Tstream using an explicit schema provider. - write_
xb - Reconstruct an unmodified parsed document byte-for-byte.