Struct StepReader 

pub struct StepReader { /* private fields */ }

A STEP codec carrying an explicit parse policy.

Implementations

impl StepReader

pub const fn new(options: ParseOptions) -> Self

A reader applying options.

pub const fn eager(self) -> Self

Decodes every entity during the read, as before lazy loading.

For a consumer that will touch nearly every entity anyway and wants the source released after the read. Recovery and reference-check options always read eagerly.

pub unsafe fn read_path_mapped(&self, path: &Path) -> Result<Model, ModelError>

Reads a memory-mapped file.

Avoids copying the file: pages are loaded from the page cache as they are touched and are not part of the process’s own heap. A lazily loaded model keeps the mapping and decodes from it for as long as it lives.

Safety

The file must not be modified or truncated while the returned model – or any clone of it – is alive. Truncation can end the process with SIGBUS when an entity is decoded; a rewrite makes decoding panic or, if the new bytes still parse, read other content. Prefer Codec::read_path, which owns its copy, unless the file is known to stay put.

Errors

As Codec::read_path.

pub const fn on_malformed_record(self, policy: OnMalformed) -> Self

Sets the malformed-record policy.

pub const fn options(&self) -> ParseOptions

The policy this reader applies.

Trait Implementations

impl Clone for StepReader

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 StepReader

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

Reads the file into a buffer the model owns.

Not memory-mapped: a lazily loaded model decodes from its source for as long as it lives, and a mapping of a file that another process changes in that time is undefined behaviour. The mapped read is StepReader::read_path_mapped, an unsafe opt-in.

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 read_owned(&self, bytes: Vec<u8>) -> Result<Model, ModelError>

Parse a model from a buffer the model may keep.

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

Serialize a model.

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

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

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 Copy for StepReader

impl Debug for StepReader

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

Formats the value using the given formatter.

impl Default for StepReader

fn default() -> Self

Returns the “default value” for a type.