Repository files navigation

A pure and efficient Rust implementation of recurrence rules as defined in the iCalendar RFC.

This crate follows theiCalendar (RFC-5545) specification for the "Recurrence Rule".The Recurrence Rule spec corresponds to theRRule object in this crate.In addition, it allows for adding the"DTSTART" property separated by a newline.

The crate allows for a "BYEASTER" filter. But this is opt-in with the feature flag"by-easter".

RRuleSet allows for a combination forRRules and some other properties.

• List ofRRules:Allows multiple RRules to be combined. (Union,A ∪ B)
• List ofRDates:A list of datetime combinations to always include. (Union,A ∪ B)
• List ofExRule (see note below):Allows of RRules that are removed from the results. (ComplementA \ B orA - B)
• List ofExDate:A list of datetime combinations to always exclude. (ComplementA \ B orA - B)

Note: "EXRULE" was originally part ofRFC 2445,RFC 5545 obsoletes this specification.But "EXRULE" works exactly the same als "RRULE" except that it excludes dates. You can enable "EXRULE" by enabling the "exrule" feature flag which is disabled by default.

If you notice that the implementation differs from the specifications above, please open an issue.

use rrule::RRuleSet;// RRule that starts 2012.02.01 and occurs daily for 3 days.let rrule:RRuleSet ="DTSTART:20120201T093000Z\nRRULE:FREQ=DAILY;COUNT=3".parse().unwrap();// Set hard limit in case of infinitely recurring rules.let limit =100;// Get all recurrences of the rrulelet result = rrule.all(limit);assert_eq!(result.dates.len(),3);

See more examples atdocs.rs

Install the command line tool with:

cargo install rrule --features="cli-tool"

Then run it with:

rrule"DTSTART:20120201T093000Z\nRRULE:FREQ=DAILY;COUNT=3"

You should read thesecurity docs if you use arbitrary inputs from users for constructing the recurrence rules.

All dates are limited to the range or years +/-262_000¹ because ofChrono limits.SeeChrono's limits for more info.

Supported timezones are limited to by the timezones thatChrono-Tz supports.This is equivalent to the IANA database.SeeChrono-Tz's limits for more info.

Because the specifications do give a lot of flexibilities this can beabused very easily.In order to prevent most of the abuse we've imposed arbitrary limitation when on theRRuleSet::allmethod. The validation limits aren't enforced for theRRuleSet::all_unchecked method or whenusing theIterator api directly.

Limitations:

By default, the "Arbitrary Limit" is used. If you instead want to use the "Crate Limit".Make sure youunderstand the risks that come with this.

• python-dateutil library
• rrule.js

The code in this project is licensed under theMIT orApache 2.0 license.

All contributions to this project will be similarly licensed.