Struct RecurringTimeWindow

#[non_exhaustive]
pub struct RecurringTimeWindow {
    pub window: Option<TimeWindow>,
    pub recurrence: String,
}

Represents an arbitrary window of time that recurs.

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.

window: Option<TimeWindow>

The window of the first recurrence.

recurrence: String

An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time.

For example, to have something repeat every weekday, you’d use: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

To repeat some window daily (equivalent to the DailyMaintenanceWindow): FREQ=DAILY

For the first weekend of every month: FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU

This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you’d use something like:

start time = 2019-01-01T09:00:00-0400
end time = 2019-01-01T17:00:00-0400
recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR

Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC:

start time = 2019-01-05T00:00:00Z
end time = 2019-01-07T23:59:00Z
recurrence = FREQ=WEEKLY;BYDAY=SA

Note the start and end time’s specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Implementations

impl RecurringTimeWindow

pub fn set_window<T: Into<Option<TimeWindow>>>(self, v: T) -> Self

Sets the value of window.

pub fn set_recurrence<T: Into<String>>(self, v: T) -> Self

Sets the value of recurrence.

Trait Implementations

impl Clone for RecurringTimeWindow

fn clone(&self) -> RecurringTimeWindow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RecurringTimeWindow

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

Formats the value using the given formatter.

impl Default for RecurringTimeWindow

fn default() -> RecurringTimeWindow

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RecurringTimeWindow

where RecurringTimeWindow: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for RecurringTimeWindow

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RecurringTimeWindow

fn eq(&self, other: &RecurringTimeWindow) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RecurringTimeWindow

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RecurringTimeWindow