Struct RecurrenceRule 

pub struct RecurrenceRule {
    pub frequency: Frequency,
    pub interval: u32,
    pub weekdays: [bool; 7],
    pub end: RecurrenceEnd,
}

A repeating schedule, starting from a date given when asking for its days. A date past the end of a shorter month falls on that month’s last day and returns to its own day after: the 31st is February 28, then March 31.

use ravenrs_widgets::{Date, Frequency, RecurrenceEnd, RecurrenceRule};

let start = Date::new(2026, 1, 31).unwrap();
let rule = RecurrenceRule::new(Frequency::Monthly).end(RecurrenceEnd::After(3));
let days = rule.occurrences(start, start, start.add_months(12));
assert_eq!(days, [start, Date::new(2026, 2, 28).unwrap(), Date::new(2026, 3, 31).unwrap()]);

// It can be stored as text, in the format of iCalendar.
assert_eq!(rule.to_text(), "FREQ=MONTHLY;COUNT=3");
assert_eq!(RecurrenceRule::parse(&rule.to_text()), Some(rule));

Fields

frequency: Frequency

How often.

interval: u32

Every how many days, weeks, months or years; at least 1.

weekdays: [bool; 7]

For weekly rules, the weekdays from Sunday to Saturday. With none chosen, the first day’s weekday.

end: RecurrenceEnd

When it stops.

Implementations

impl RecurrenceRule

pub fn new(frequency: Frequency) -> Self

A rule at this frequency, every time, with no end.

pub fn every(self, interval: u32) -> Self

Sets the interval; below 1 counts as 1.

pub fn on_weekdays(self, days: impl IntoIterator<Item = u8>) -> Self

Sets the weekdays of a weekly rule, 0 = Sunday … 6 = Saturday.

pub fn end(self, end: RecurrenceEnd) -> Self

Sets when it stops.

pub fn days_from(&self, start: Date) -> impl Iterator<Item = Date> + use<>

The days from start on, in order. It never ends by itself when the rule does not, so limit it, as Self::occurrences does.

pub fn occurrences(&self, start: Date, from: Date, to: Date) -> Vec<Date>

The days of a rule starting at start that fall in from..=to, in order.

pub fn to_text(&self) -> String

The rule as text, the part of iCalendar’s RRULE it covers.

pub fn parse(text: &str) -> Option<Self>

Reads what Self::to_text writes; None when it is not a rule.

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 Copy for RecurrenceRule

impl Debug for RecurrenceRule

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

Formats the value using the given formatter.

impl Default for RecurrenceRule

fn default() -> Self

Returns the “default value” for a type.

impl Display for RecurrenceRule

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

Formats the value using the given formatter.

impl Eq for RecurrenceRule

impl Hash for RecurrenceRule

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RecurrenceRule

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RecurrenceRule