Skip to main content

AnnotationDraft

Struct AnnotationDraft 

Source
#[non_exhaustive]
pub struct AnnotationDraft<'a> { pub global_id: &'a str, pub owner_history: Option<EntityId>, pub name: Option<&'a str>, pub description: Option<&'a str>, pub object_type: Option<&'a str>, pub object_placement: Option<EntityId>, pub representation: Option<EntityId>, pub predefined_type: Option<AnnotationType>, }
Expand description

Draft input for create_annotation: the writable attributes of a new IfcAnnotation.

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.
§global_id: &'a str

The GlobalId (IFC GUID); must parse as a valid base64-like GUID.

§owner_history: Option<EntityId>

The OwnerHistory reference, when supplied.

§name: Option<&'a str>

The Name attribute, when supplied.

§description: Option<&'a str>

The Description attribute, when supplied.

§object_type: Option<&'a str>

The ObjectType attribute. Required (non-empty) when predefined_type is AnnotationType::UserDefined.

§object_placement: Option<EntityId>

The ObjectPlacement reference, when supplied.

§representation: Option<EntityId>

The Representation reference, when supplied.

§predefined_type: Option<AnnotationType>

The IFC4X3 PredefinedType, when supplied.

Implementations§

Source§

impl<'a> AnnotationDraft<'a>

Source

pub fn new(global_id: &'a str) -> Self

Starts a draft from its required global_id; every other field is unset.

Source

pub fn owner_history(self, value: EntityId) -> Self

Sets owner_history.

The OwnerHistory reference, when supplied.

Source

pub fn name(self, value: &'a str) -> Self

Sets name.

The Name attribute, when supplied.

Source

pub fn description(self, value: &'a str) -> Self

Sets description.

The Description attribute, when supplied.

Source

pub fn object_type(self, value: &'a str) -> Self

Sets object_type.

The ObjectType attribute. Required (non-empty) when predefined_type is AnnotationType::UserDefined.

Source

pub fn object_placement(self, value: EntityId) -> Self

Sets object_placement.

The ObjectPlacement reference, when supplied.

Source

pub fn representation(self, value: EntityId) -> Self

Sets representation.

The Representation reference, when supplied.

Source

pub fn predefined_type(self, value: AnnotationType) -> Self

Sets predefined_type.

The IFC4X3 PredefinedType, when supplied.

Trait Implementations§

Source§

impl<'a> Clone for AnnotationDraft<'a>

Source§

fn clone(&self) -> AnnotationDraft<'a>

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<'a> Debug for AnnotationDraft<'a>

Source§

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

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

impl<'a> Default for AnnotationDraft<'a>

Source§

fn default() -> AnnotationDraft<'a>

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

Auto Trait Implementations§

§

impl<'a> Freeze for AnnotationDraft<'a>

§

impl<'a> RefUnwindSafe for AnnotationDraft<'a>

§

impl<'a> Send for AnnotationDraft<'a>

§

impl<'a> Sync for AnnotationDraft<'a>

§

impl<'a> Unpin for AnnotationDraft<'a>

§

impl<'a> UnsafeUnpin for AnnotationDraft<'a>

§

impl<'a> UnwindSafe for AnnotationDraft<'a>

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
§

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

§

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.

§

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