Struct rrule::RRule

pub struct RRule {
    pub options: ParsedOptions,
}

Fields

options: ParsedOptions

Implementations

impl RRule

pub fn new(options: ParsedOptions) -> Self

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

Returns all the recurrences of the rrule

pub fn before(&self, dt: DateTime<Tz>, inc: bool) -> Option<DateTime<Tz>>

Returns the last recurrence before the given datetime instance. The inc keyword defines what happens if dt is an recurrence. With inc == true, if dt itself is an recurrence, it will be returned.

pub fn after(&self, dt: DateTime<Tz>, inc: bool) -> Option<DateTime<Tz>>

Returns the last recurrence after the given datetime instance. The inc keyword defines what happens if dt is an recurrence. With inc == true, if dt itself is an recurrence, it will be returned.

pub fn between(
    &self,
    after: DateTime<Tz>,
    before: DateTime<Tz>,
    inc: bool
) -> Vec<DateTime<Tz>>

Returns all the recurrences of the rrule between after and before. The inc keyword defines what happens if after and/or before are themselves recurrences. With inc == true, they will be included in the list, if they are found in the recurrence set.

Trait Implementations

impl Clone for RRule

fn clone(&self) -> RRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RRule

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

Formats the value using the given formatter.

impl FromStr for RRule

type Err = RRuleParseError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl<'a> IntoIterator for &'a RRule

type Item = DateTime<Tz>

The type of the elements being iterated over.

type IntoIter = RRuleIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.