Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoodie/icalendar-rs
📆 icalendar library, in Rust of course - for fun
https://github.com/hoodie/icalendar-rs
calendar icalendar library rust
Last synced: 1 day ago
JSON representation
📆 icalendar library, in Rust of course - for fun
- Host: GitHub
- URL: https://github.com/hoodie/icalendar-rs
- Owner: hoodie
- License: apache-2.0
- Created: 2016-05-09T17:49:49.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-06T14:35:29.000Z (3 months ago)
- Last Synced: 2024-10-09T07:12:01.128Z (3 months ago)
- Topics: calendar, icalendar, library, rust
- Language: Rust
- Homepage:
- Size: 427 KB
- Stars: 122
- Watchers: 3
- Forks: 32
- Open Issues: 6
-
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-rs/actions?query=workflow%3A"Continuous+Integration")
[](https://crates.io/crates/icalendar)
[](https://github.com/hoodie/icalendar-rs/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.
## Examples
Below are two 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")
.done(),
)
.done(),
)
.push(
// add a todo
Todo::new()
.summary("groceries")
.description("Buy some milk")
.done(),
)
.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")
.done(),
)
.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(),
)
.done();
println!("{}", my_calendar);
```
### 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 component in &parsed_calendar.components {
if let CalendarComponent::Event(event) = component {
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.
## License
icalendar-rs is licensed under either of
* Apache License, Version 2.0, (LICENSE-APACHE or )
* MIT license (LICENSE-MIT or )
at your option.
## Contribution
Any help in form of descriptive and friendly [issues](https://github.com/hoodie/icalendar-rs/issues) or comprehensive pull requests are welcome!
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in icalendar-rs by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.