Struct RecurrenceRule 

pub struct RecurrenceRule { /* private fields */ }

A recurrence rule

Implementations

impl RecurrenceRule

pub fn not_before(&self) -> &NaiveDate

This rule is not valid before the specified NaiveDate (inclusive)

pub fn not_after(&self) -> &Option<NaiveDate>

This rule is not valid after the specified NaiveDate

pub fn max_occurrences(&self) -> &Option<u64>

The maximum number of occurrences for this rule, or unlimited if None.

pub fn frequency(&self) -> &Frequency

At what frequency should this rule reoccur?

pub fn day_filter(&self) -> &DayFilter

A bitflag day filter, xMTWTFSS, 01111111 means this can be paid any day.

pub fn resolve(&self) -> &ResolveDirection

If the bitflag day filter cannot be met, should it be resolved into the future or the past?

impl RecurrenceRule

pub fn set_max_occurrences(&mut self, val: Option<u64>) -> &mut Self

The maximum number of occurrences for this rule, or unlimited if None.

pub fn set_frequency(&mut self, val: Frequency) -> &mut Self

At what frequency should this rule reoccur?

pub fn set_day_filter(&mut self, val: DayFilter) -> &mut Self

A bitflag day filter, xMTWTFSS, 01111111 means this can be paid any day.

pub fn set_resolve(&mut self, val: ResolveDirection) -> &mut Self

If the bitflag day filter cannot be met, should it be resolved into the future or the past?

impl RecurrenceRule

pub fn new(frequency: Frequency, not_before: NaiveDate) -> Self

Create a new recurrence rule.

pub fn set_not_before(&mut self, not_before: NaiveDate) -> bool

Set the date at which this rule is not valid before. Will return false if it wasn’t able to set due to the provided date being after the not_after date.

pub fn set_not_before_unchecked(&mut self, not_before: NaiveDate)

Set the date at which this rule is not valid before.

Preferably, you should use Self::set_not_before.

pub fn set_not_after(&mut self, not_after: Option<NaiveDate>) -> bool

Set the date at which this rule is not valid before. Will return false if it wasn’t able to set due to the provided date being after the not_after date.

pub fn set_not_after_unchecked(&mut self, not_after: Option<NaiveDate>)

Set the date at which this rule is not valid after.

Preferably, you should use Self::set_not_after.

pub fn iter_after(&self, start_point: &NaiveDate) -> Iter<'_>

Create an iterator for all occurrences, starting at the provided start_point (exclusive).

pub fn iter(&self) -> Iter<'_>

Create an iterator for all occurrences, starting at Self::not_before (inclusive).

Panics

This will panic if Self::not_before is the beginning of time.

Trait Implementations

impl Clone for RecurrenceRule

fn clone(&self) -> RecurrenceRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecurrenceRule

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a RecurrenceRule

type Item = Occurrence

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.