Struct XmlCodec 

pub struct XmlCodec { /* private fields */ }

The ifcXML codec.

Construct with XmlCodec::default for the lossless compatibility dialect, XmlCodec::strict for an exact namespace/release profile, XmlCodec::with_schema_and_profile for strict output with schema-correct attribute names, or XmlCodec::xsd to read and write the buildingSMART XSD configuration.

Implementations

impl XmlCodec

pub const fn strict(profile: XmlProfile) -> Self

A codec that enforces one exact ifcXML release namespace and schema token.

It writes and reads the native layout under that namespace. The output is well-formed and its root is the XSD’s ifcXML element, but it is not valid against the release XSD: see XmlProfile.

pub const fn profile(&self) -> Option<XmlProfile>

The strict release profile, or None for compatibility mode.

pub const fn layout(&self) -> XmlLayout

The XML layout this codec reads and writes.

pub const fn reading(&self) -> SchemaReading

How content the schema does not declare is treated. Applies to the native layout with a schema; the XSD layout is always strict.

pub const fn with_reading(self, reading: SchemaReading) -> Self

The same codec reading native documents with reading.

SchemaReading::Lenient restores the pre-0.4 schema-aware read. Has no effect on an XmlLayout::Xsd codec, which has no lenient mode.

pub fn with_schema(schema: Arc<Schema>) -> Self

A codec that emits schema-correct attribute names and reads strictly.

Reading types every value from its declaration and refuses names the schema does not declare (SchemaReading::Strict); chain Self::with_reading for the lenient read.

pub fn with_schema_and_profile(schema: Arc<Schema>, profile: XmlProfile) -> Self

A strict release-profile codec with schema-backed attribute names.

Reads strictly, as Self::with_schema does. Like Self::strict, it writes the native layout, not the XSD configuration.

pub fn xsd(schema: Arc<Schema>, profile: XmlProfile) -> Self

A reader and writer of the buildingSMART XSD configuration of profile’s release.

schema must be that release’s schema; a mismatch is refused when reading or writing. A document reads into the same Model as its STEP form. A model writes as a document that validates against the release XSD and reads back to the same model, its entities numbered in model order; what the configuration cannot carry exactly is refused with crate::XmlError::Unrepresentable or another typed error, never written differently. The model’s header must declare the profile’s schema token.

pub fn schema(&self) -> Option<&Schema>

The schema in use, if any.

Trait Implementations

impl Clone for XmlCodec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Codec for XmlCodec

fn name(&self) -> &'static str

Human-readable name for diagnostics, e.g. STEP.

fn extensions(&self) -> &'static [&'static str]

Conventional file extensions, lower-case, without the dot.

fn detect(&self, bytes: &[u8]) -> bool

Does this look like a file this codec can read?

fn read_bytes(&self, bytes: &[u8]) -> Result<Model, ModelError>

Parse a model from bytes.

fn write(&self, model: &Model, out: &mut dyn Write) -> Result<(), ModelError>

Serialize a model.

fn read_owned(&self, bytes: Vec<u8>) -> Result<Model, ModelError>

Parse a model from a buffer the model may keep.

fn read_from(&self, reader: &mut dyn Read) -> Result<Model, ModelError>

Parse from any reader. Override when the format can stream.

fn read_path(&self, path: &Path) -> Result<Model, ModelError>

Parse a file from disk.

fn write_path(&self, model: &Model, path: &Path) -> Result<(), ModelError>

Serialize to a file on disk.

fn write_bytes(&self, model: &Model) -> Result<Vec<u8>, ModelError>

Serialize to a byte vector.

impl Debug for XmlCodec

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

Formats the value using the given formatter.

impl Default for XmlCodec

fn default() -> Self

Returns the “default value” for a type.