ModelOptions

Struct ModelOptions 

Source
#[non_exhaustive]
pub struct ModelOptions { pub placements: bool, pub inherit_type_properties: bool, pub attributes: bool, }
Expand description

What the export should resolve beyond the attributes it always reads.

let opts = ModelOptions::default().with_placements(true);

#[non_exhaustive] plus builders, rather than a plain struct: this will grow, and non_exhaustive forbids EVERY struct expression from outside this crate — including ..Default::default(), which is the one people reach for to survive new fields and which does not compile here. Builders are the shape that actually works for an external caller and keeps working when a field is added.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§placements: bool

Resolve each product’s ObjectPlacement into [EntityRow::placement].

Off by default because it is not free: the placement memo is ~128 B per distinct placement — one per product in most files, so O(products) on top of the entity index — and each product costs a few extra decodes of its own chain after the shared upper levels are memoized.

§inherit_type_properties: bool

Merge the property/quantity sets an occurrence inherits from its IfcTypeObject into EntityRow::property_sets and EntityRow::quantity_sets, per property, occurrence wins.

Off by default, which is NOT a claim that off is more correct. It is not: authoring tools put a great deal on types, a type carrying Pset_WallCommon yields no row of its own here (it only gets one when it also has orphan geometry), and the browser has resolved inheritance this way since #1913. Off is the default only because this changes what every existing CSV/JSON/IFCX/Parquet export contains, and that is a decision to take deliberately rather than as a side effect of adding the capability.

It costs one extra IfcRelDefinesByType map in pass 1 (O(typed occurrences)) and one resolve per distinct type, memoized.

§attributes: bool

Render the attributes each entity’s own IFC class declares, into EntityRow::attributes.

Off by default for the same reason as the others: it adds columns to every flattened export. It is cheap when on, though, since the row’s entity is already decoded and this only formats fields already in hand.

Implementations§

Source§

impl ModelOptions

Source

pub fn with_placements(self, yes: bool) -> Self

Resolve each product’s ObjectPlacement. See ModelOptions::placements.

Source

pub fn with_inherit_type_properties(self, yes: bool) -> Self

Merge type-inherited property/quantity sets into each occurrence. See ModelOptions::inherit_type_properties.

Source

pub fn with_attributes(self, yes: bool) -> Self

Render each entity class’s declared attributes into every row. See ModelOptions::attributes.

Trait Implementations§

Source§

impl Clone for ModelOptions

Source§

fn clone(&self) -> ModelOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ModelOptions

Source§

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

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

impl Default for ModelOptions

Source§

fn default() -> ModelOptions

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
§

impl<U> As for U

§

fn as_<T>(self) -> T
where T: CastFrom<U>,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. 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<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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more