Struct rrule::RRuleSet

pub struct RRuleSet { /* private fields */ }

A validated Recurrence Rule that can be used to create an iterator.

Implementations

impl RRuleSet

pub fn new(dt_start: DateTime<Tz>) -> Self

Creates an empty RRuleSet, starting from ds_start.

pub fn limit(self) -> Self

Enable validation limits.

This is only needed if you are going to use the Iterator api directly.

pub fn before(self, dt: DateTime<Tz>) -> Self

Only return recurrences that comes before this DateTime.

This value will not be used if you use the Iterator API directly.

pub fn after(self, dt: DateTime<Tz>) -> Self

Only return recurrences that comes after this DateTime.

This value will not be used if you use the Iterator API directly.

pub fn rrule(self, rrule: RRule) -> Self

Adds a new rrule to the set.

pub fn rdate(self, rdate: DateTime<Tz>) -> Self

Adds a new rdate to the set.

pub fn exdate(self, exdate: DateTime<Tz>) -> Self

Adds a new exdate to the set.

pub fn set_rrules(self, rrules: Vec<RRule>) -> Self

Sets the rrules of the set.

pub fn set_rdates(self, rdates: Vec<DateTime<Tz>>) -> Self

Sets the rdates of the set.

pub fn set_exdates(self, exdates: Vec<DateTime<Tz>>) -> Self

Set the exdates of the set.

pub fn get_rrule(&self) -> &Vec<RRule>

Returns the rrules of the set.

pub fn get_exrule(&self) -> &Vec<RRule>

Returns the exrules of the set.

pub fn get_rdate(&self) -> &Vec<DateTime<Tz>>

Returns the rdates of the set.

pub fn get_exdate(&self) -> &Vec<DateTime<Tz>>

Returns the exdates of the set.

pub fn get_dt_start(&self) -> &DateTime<Tz>

Returns the start datetime of the recurring event.

pub fn all(self, limit: u16) -> RRuleResult

Returns all the recurrences of the rrule.

Limit must be set in order to prevent infinite loops. The max limit is 65535. If you need more please use into_iter directly.

Usage

use rrule::RRuleSet;

let rrule_set: RRuleSet = "DTSTART:20210101T090000Z\nRRULE:FREQ=DAILY".parse().unwrap();

// Limit the results to 2 recurrences
let result = rrule_set.all(2);
assert_eq!(result.dates.len(), 2);
assert_eq!(result.limited, true);

pub fn all_unchecked(self) -> Vec<DateTime<Tz>>

Returns all the recurrences of the rrule.

Note

This method does not enforce any validation limits and might lead to very long iteration times. Please read the SECURITY.md for more information.

pub fn set_from_string(self, s: &str) -> Result<Self, RRuleError>

Set the RRuleSet properties from a string. If a DTSTART is found, it will be used as the start datetime.

Trait Implementations

impl Clone for RRuleSet

fn clone(&self) -> RRuleSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RRuleSet

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

Formats the value using the given formatter.

impl Display for RRuleSet

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

Prints a valid set of iCalendar properties which can be used to create a new RRuleSet later. You may use the generated string to create a new iCalendar component, like VEVENT.

impl FromStr for RRuleSet

fn from_str(s: &str) -> Result<Self, Self::Err>

Creates an RRuleSet from a string if input is valid.

Errors

Returns RRuleError, if iCalendar string contains invalid parts.

type Err = RRuleError

The associated error which can be returned from parsing.

impl<'a> IntoIterator for &'a RRuleSet

type Item = DateTime<Tz>

The type of the elements being iterated over.

type IntoIter = RRuleSetIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for RRuleSet

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for RRuleSet

impl StructuralPartialEq for RRuleSet