Skip to main content

StepCodec

Struct StepCodec 

Source
pub struct StepCodec;
Expand description

The STEP physical file codec (.ifc). The STEP physical file codec.

Strict: a record this codec cannot read is an error, because an authoring tool that silently drops entities corrupts the file it edits.

A consumer that would rather load a damaged export uses StepCodec::lenient and reads Model::diagnostics to see what was dropped.

use ifc_model::Codec;
use ifc_step::StepCodec;

// A damaged export: strict reading refuses it.
assert!(StepCodec.read_bytes(bytes).is_err());

// A viewer opts into recovery and reports what was lost.
let model = StepCodec::lenient().read_bytes(bytes)?;
assert_eq!(model.len(), 1);
assert_eq!(model.diagnostics().len(), 1);

Implementations§

Source§

impl StepCodec

Source

pub const fn lenient() -> StepReader

A reader that skips unreadable data records and reports each one as a Model diagnostic.

Header structure and the physical-file marker remain fatal: a file whose identity cannot be established is not partially readable.

Source

pub const fn with_options(options: ParseOptions) -> StepReader

A reader with an explicit malformed-record policy.

Trait Implementations§

Source§

impl Clone for StepCodec

Source§

fn clone(&self) -> StepCodec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Codec for StepCodec

Source§

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

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

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

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

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

Does this look like a file this codec can read? Read more
Source§

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

Parse a model from bytes. Read more
Source§

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

Parse a model from a buffer the model may keep. Read more
Source§

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

Serialize a model.
Source§

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

Parse a file from disk. Read more
Source§

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

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

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

Serialize to a file on disk.
Source§

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

Serialize to a byte vector.
Source§

impl Copy for StepCodec

Source§

impl Debug for StepCodec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StepCodec

Source§

fn default() -> StepCodec

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.