https://github.com/hoodie/icalendar
📆 icalendar library, in Rust of course - for fun
https://github.com/hoodie/icalendar
calendar icalendar library rust
Last synced: 19 days ago
JSON representation
📆 icalendar library, in Rust of course - for fun
- Host: GitHub
- URL: https://github.com/hoodie/icalendar
- Owner: hoodie
- License: apache-2.0
- Created: 2016-05-09T17:49:49.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2026-04-04T19:14:30.000Z (3 months ago)
- Last Synced: 2026-04-08T07:04:56.353Z (2 months ago)
- Topics: calendar, icalendar, library, rust
- Language: Rust
- Homepage:
- Size: 743 KB
- Stars: 183
- Watchers: 1
- Forks: 45
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-Apache
Awesome Lists containing this project
README
# iCalendar in Rust
[](https://github.com/hoodie/icalendar/actions?query=workflow%3A"Continuous+Integration")
[](https://crates.io/crates/icalendar)
[](https://github.com/hoodie/icalendar/graphs/contributors)
[](https://crates.io/crates/icalendar/)
[](https://docs.rs/icalendar/)
[](https://crates.io/crates/icalendar/)
A builder and parser for [`rfc5545`](http://tools.ietf.org/html/rfc5545) iCalendar.
You want to help make this more mature? Please talk to me, Pull Requests and suggestions are very welcome.
## Usage & Documentation
Please see the [documentation](https://docs.rs/icalendar/) for current examples.
Below are a few examples of how to use this library. See the `examples` directory as well as the documentation for many more.
### Building a new Calendar
Use the builder-pattern to assemble the full calendar or event by event.
Display printing produces the rfc5545 format.
```rust
use icalendar::{Calendar, CalendarDateTime, Class, Component, Event, EventLike, Property, Todo};
use chrono::{Duration, NaiveDate, NaiveTime, Utc};
// let's create a calendar
let my_calendar = Calendar::new()
.name("example calendar")
.push(
// add an event
Event::new()
.summary("test event")
.description("here I have something really important to do")
.starts(Utc::now())
.class(Class::Confidential)
.ends(Utc::now() + Duration::days(1))
.append_property(
Property::new("TEST", "FOOBAR")
.add_parameter("IMPORTANCE", "very")
.add_parameter("DUE", "tomorrow")
)
)
.push(
// add a todo
Todo::new()
.summary("groceries")
.description("Buy some milk")
)
.push(
// add an all-day event
Event::new()
.all_day(NaiveDate::from_ymd_opt(2016, 3, 15).unwrap())
.summary("My Birthday")
.description("Hey, I'm gonna have a party\nBYOB: Bring your own beer.\nHendrik")
)
.push(
// event with utc timezone
Event::new()
.starts(CalendarDateTime::from(
NaiveDate::from_ymd_opt(2024, 10, 24).unwrap()
.and_time(NaiveTime::from_hms_opt(20, 10, 00).unwrap())
.and_utc()
))
.summary("Birthday Party")
.description("I'm gonna have a party\nBYOB: Bring your own beer.\nHendrik")
)
.done();
println!("{}", my_calendar);
```
### Removing Properties from Components
You can remove properties from components when you need to update their state:
```rust
use icalendar::{Calendar, Component, Event, EventStatus, Todo, TodoStatus};
use chrono::Utc;
// Create a completed todo
let mut todo = Todo::new();
todo
.summary("Buy milk")
.completed(Utc::now())
.percent_complete(100)
.status(TodoStatus::Completed);
// Later, mark it as uncompleted by removing completion properties
todo.mark_uncompleted();
// This removes COMPLETED, PERCENT-COMPLETE, and STATUS properties
// For events, you can remove specific properties
let mut event = Event::new();
event
.summary("Team Meeting")
.status(EventStatus::Cancelled);
// Remove the cancelled status
event.remove_status();
// You can also remove any property directly
event.remove_property("LOCATION");
```
### Parsing a Calendar
There is a feature called `"parser"` which allows you to read calendars again like this:
```rust
use std::fs::read_to_string;
use icalendar::{Calendar, CalendarComponent, Component};
let contents = read_to_string("fixtures/icalendar-rb/event.ics").unwrap();
let parsed_calendar: Calendar = contents.parse().unwrap();
for event in parsed_calendar.events() {
println!("Event: {}", event.get_summary().unwrap())
}
```
## Structure
A [`Calendar`] represents a full calendar, which contains multiple [`Component`]s. These may be either [`Event`]s, [`Todo`]s, or [`Venue`]s. Components in turn have [`Property`]s, which may have [`Parameter`]s.
## `RRule` Support
Thanks to the [`rrule`](https://crates.io/crates/rrule) crate and [friendly community contribution](https://github.com/hoodie/icalendar/pull/128), you can also add recurrence rules to your events and todos. See the documentation for `Event::recurrence` and `Todo::recurrence` for details.
We currently reexport a select subset of `rrule` types. Should you experience compatibility issues because the maintainer (me) has not yet updated `icalendar` to reexport the latest `rrule` version, please feel free to open a PR.
## Contributing
Any help in form of descriptive and friendly [issues](https://github.com/hoodie/icalendar/issues) or comprehensive pull requests are welcome!
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in icalendar by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
### Conventions
The Changelog of this library is generated from its commit log, there any commit message must conform with . For simplicity you could make your commits with [convco](https://crates.io/crates/convco).
### Recognition
Thanks goes to these wonderful people:
### License
`icalendar` (this crate) is licensed under either of Apache License, Version
2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.