Struct IcalRecurSet 

pub struct IcalRecurSet {
    pub start: Option<IcalRecurDateTime>,
    pub rules: Vec<IcalRecurRule>,
    pub dates: Vec<IcalRecurDateTime>,
    pub exrules: Vec<IcalRecurRule>,
    pub exdates: Vec<IcalRecurDateTime>,
    pub overrides: Vec<IcalRecurOverride>,
}

The recurrence set of one component: what adds, subtracts and overrides.

Build one from a decoded component with of_component, or by hand, and walk it with expand.

Fields

start: Option<IcalRecurDateTime>

The DTSTART, always the first instance of the set (RFC 5545 3.8.2.4).

rules: Vec<IcalRecurRule>

Every RRULE.

dates: Vec<IcalRecurDateTime>

Every date named by an RDATE, in order. A period item contributes its start.

exrules: Vec<IcalRecurRule>

Every EXRULE, deprecated by RFC 5545 but still on the wire.

exdates: Vec<IcalRecurDateTime>

Every date named by an EXDATE, in order.

overrides: Vec<IcalRecurOverride>

The overrides that replace instances, in order of identity.

Implementations

impl IcalRecurSet

pub fn of_component(component: &IcalComponent<'_>) -> Self

Read the set a decoded component denotes, its overrides aside.

A component with no DTSTART and no RDATE denotes nothing and comes back empty rather than as an error: this is the liberal side of the crate. A malformed date or rule is skipped for the same reason.

pub fn with_override(&mut self, component: &IcalComponent<'_>) -> &mut Self

Add the override a sibling component carrying a RECURRENCE-ID states.

A component with no RECURRENCE-ID, or with no DTSTART to move the instance to, is not an override and is ignored.

pub fn of_uid(components: &[IcalComponent<'_>], uid: &str) -> Self

The set a whole calendar denotes for one UID: the series component, plus every sibling that overrides an instance of it.

The series is the component carrying that UID with no RECURRENCE-ID; every other one carrying it is an override.

pub fn expand(&self) -> IcalRecurSetExpand<'_>

Walk the set, lazily, in identity order.

pub fn expand_in_zone(&self, zone: &IcalTz) -> IcalRecurSetExpand<'_>

Walk the set against a time zone, dropping the instances its rules generate at local times the zone jumps over (RFC 5545 3.3.10).

The filter sits on the rule streams alone. An RDATE does not generate an instance, it names one, so a date written into one is as deliberate as a lone DTSTART and is kept whatever the zone says of it.

Trait Implementations

impl Clone for IcalRecurSet

fn clone(&self) -> IcalRecurSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IcalRecurSet

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

Formats the value using the given formatter.

impl Default for IcalRecurSet

fn default() -> IcalRecurSet

Returns the “default value” for a type.

impl Eq for IcalRecurSet

impl PartialEq for IcalRecurSet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IcalRecurSet