Struct DocumentDraft 

#[non_exhaustive]
pub struct DocumentDraft<'a> {

    pub identification: &'a str,
    pub name: &'a str,
    pub description: Option<&'a str>,
    pub location: Option<&'a str>,
    pub purpose: Option<&'a str>,
    pub intended_use: Option<&'a str>,
    pub scope: Option<&'a str>,
    pub revision: Option<&'a str>,
    pub document_owner: Option<EntityId>,
    pub editors: Option<&'a [EntityId]>,
    pub creation_time: Option<&'a str>,
    pub last_revision_time: Option<&'a str>,
    pub electronic_format: Option<&'a str>,
    pub valid_from: Option<&'a str>,
    pub valid_until: Option<&'a str>,
    pub confidentiality: Option<&'a str>,
    pub status: Option<&'a str>,
}

Draft for one IfcDocumentInformation.

Fields (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.

identification: &'a str

Required Identification code of the document (DocumentId in IFC2X3).

name: &'a str

Required Name of the document.

description: Option<&'a str>

Description of the document, when stated.

location: Option<&'a str>

Location (URI) of the document, when stated. IFC4 onwards.

purpose: Option<&'a str>

Purpose of the document, when stated.

intended_use: Option<&'a str>

IntendedUse of the document, when stated.

scope: Option<&'a str>

Scope of the document, when stated.

revision: Option<&'a str>

Revision identifier, when stated.

document_owner: Option<EntityId>

DocumentOwner: an IfcActorSelect, when stated.

editors: Option<&'a [EntityId]>

Editors: non-empty unique set of IfcActorSelect ids, when stated.

creation_time: Option<&'a str>

CreationTime (IFC date-time string), when stated. IFC2X3 types it as an IfcDateAndTime record, so text is refused there.

last_revision_time: Option<&'a str>

LastRevisionTime (IFC date-time string), when stated. A record in IFC2X3, as creation_time.

electronic_format: Option<&'a str>

ElectronicFormat, when stated. IFC2X3 types it as an IfcDocumentElectronicFormat record, so text is refused there.

valid_from: Option<&'a str>

ValidFrom (IFC date string), when stated. An IfcCalendarDate record in IFC2X3.

valid_until: Option<&'a str>

ValidUntil (IFC date string), when stated. An IfcCalendarDate record in IFC2X3.

confidentiality: Option<&'a str>

Confidentiality enumerator; must be one of the release’s IfcDocumentConfidentialityEnum values.

status: Option<&'a str>

Status enumerator; must be one of the release’s IfcDocumentStatusEnum values.

Implementations

impl<'a> DocumentDraft<'a>

pub fn new(identification: &'a str, name: &'a str) -> Self

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

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

Sets description: Description of the document, when stated.

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

Sets location: Location (URI) of the document, when stated. IFC4 onwards.

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

Sets purpose: Purpose of the document, when stated.

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

Sets intended_use: IntendedUse of the document, when stated.

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

Sets scope: Scope of the document, when stated.

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

Sets revision: Revision identifier, when stated.

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

Sets document_owner: DocumentOwner: an IfcActorSelect, when stated.

pub fn editors(self, value: &'a [EntityId]) -> Self

Sets editors: Editors: non-empty unique set of IfcActorSelect ids, when stated.

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

Sets creation_time: CreationTime (IFC date-time string), when stated. IFC2X3 types it as an IfcDateAndTime record, so text is refused there.

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

Sets last_revision_time: LastRevisionTime (IFC date-time string), when stated. A record in IFC2X3, as creation_time.

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

Sets electronic_format: ElectronicFormat, when stated. IFC2X3 types it as an IfcDocumentElectronicFormat record, so text is refused there.

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

Sets valid_from: ValidFrom (IFC date string), when stated. An IfcCalendarDate record in IFC2X3.

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

Sets valid_until: ValidUntil (IFC date string), when stated. An IfcCalendarDate record in IFC2X3.

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

Sets confidentiality: Confidentiality enumerator; must be one of the release’s IfcDocumentConfidentialityEnum values.

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

Sets status: Status enumerator; must be one of the release’s IfcDocumentStatusEnum values.

Trait Implementations

impl<'a> Clone for DocumentDraft<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for DocumentDraft<'a>

impl<'a> Debug for DocumentDraft<'a>

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

Formats the value using the given formatter.