Skip to main content

RecurrenceDraft

Struct RecurrenceDraft 

Source
#[non_exhaustive]
pub struct RecurrenceDraft<'a> { pub recurrence_type: &'a str, pub days: Vec<i64>, pub weekdays: Vec<i64>, pub months: Vec<i64>, pub position: Option<i64>, pub interval: Option<i64>, pub occurrences: Option<i64>, pub time_periods: Vec<EntityId>, }
Expand description

Authored fields for IfcRecurrencePattern.

Weekday and month components are 1-based in the schema: 1 = Monday through 7 = Sunday, and 1 = January through 12 = December. Out-of-range values are refused rather than written, because a reader has no way to tell a 0-based authoring mistake from a deliberate value.

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

RecurrenceType. Required by the schema.

§days: Vec<i64>

DayComponent: days of the month, 1..=31.

§weekdays: Vec<i64>

WeekdayComponent: 1 = Monday through 7 = Sunday.

§months: Vec<i64>

MonthComponent: 1 = January through 12 = December.

§position: Option<i64>

Position, for positional patterns. Negative counts from the end.

§interval: Option<i64>

Interval: repeat every n periods. Must be positive.

§occurrences: Option<i64>

Occurrences: how many times it repeats. Must be positive.

§time_periods: Vec<EntityId>

TimePeriods: the IfcTimePeriod records (from create_time_period) each occurrence spans, in authored order. Empty writes $ (#233).

Implementations§

Source§

impl<'a> RecurrenceDraft<'a>

Source

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

Starts a draft for an IfcRecurrencePattern with its required RecurrenceType and every component unset.

Source

pub fn days(self, value: Vec<i64>) -> Self

Sets DayComponent, days of the month in 1..=31.

Source

pub fn weekdays(self, value: Vec<i64>) -> Self

Sets WeekdayComponent, 1 = Monday through 7 = Sunday.

Source

pub fn months(self, value: Vec<i64>) -> Self

Sets MonthComponent, 1 = January through 12 = December.

Source

pub fn position(self, value: i64) -> Self

Sets Position.

Source

pub fn interval(self, value: i64) -> Self

Sets Interval, a positive count.

Source

pub fn occurrences(self, value: i64) -> Self

Sets Occurrences, a positive count.

Source

pub fn time_periods(self, value: Vec<EntityId>) -> Self

Sets TimePeriods, the IfcTimePeriod records the pattern’s occurrences span, in authored order (#233).

Trait Implementations§

Source§

impl<'a> Clone for RecurrenceDraft<'a>

Source§

fn clone(&self) -> Self

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 RecurrenceDraft<'a>

Source§

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

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

impl<'a> Default for RecurrenceDraft<'a>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<'a> Freeze for RecurrenceDraft<'a>

§

impl<'a> RefUnwindSafe for RecurrenceDraft<'a>

§

impl<'a> Send for RecurrenceDraft<'a>

§

impl<'a> Sync for RecurrenceDraft<'a>

§

impl<'a> Unpin for RecurrenceDraft<'a>

§

impl<'a> UnsafeUnpin for RecurrenceDraft<'a>

§

impl<'a> UnwindSafe for RecurrenceDraft<'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
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.