Crate icalendar

Expand description

§iCalendar in Rust

maintenance

A builder and parser for 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.

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:

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 Components. These may be either Events, Todos, or Venues. Components in turn have Propertys, which may have Parameters.

§License

icalendar-rs is licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

§Contribution

Any help in form of descriptive and friendly 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.

Modules§

parser: Parsing iCalendar document parser

Structs§

Alarm: VALARM (RFC 5545, Section 3.6.6 )
Calendar: Represents a calendar
Event: VEVENT (RFC 5545, Section 3.6.1 )
Parameter: key-value pairs inside of Propertys
Property: key-value pairs inside of Components
Todo: VTODO (RFC 5545, Section 3.6.2 )
Venue: VVENUE (ical-venue)

Enums§

CalendarComponent: Wrapper for Todo, Event or Venue
CalendarDateTime: Representation of various forms of DATE-TIME per RFC 5545, Section 3.3.5
Class: This property defines the access classification for a calendar component. RFC 5545, Section 3.8.1.3
DatePerhapsTime: Either a DATE-TIME or a DATE.
EventStatus: Encodes the status of an Event RFC 5545, Section 3.8.1.11
Related: Alarm Trigger Relationship RFC 5545, Section 3.2.14
TodoStatus: Encodes the status of a Todo RFC 5545, Section 3.8.1.11
Trigger: Describes when an alarm is supposed to occure.
ValueType: see 8.3.4. Value Data Types Registry

Traits§

Component: Implemented by everything that goes into a Calendar
EventLike: Common trait of Event and Todo

Functions§

ymd_hm_tzid: will return None if date is not valid

Crate icalendarCopy item path