Crate icalendar

A library to generate and parse iCalendars.

Contributions are very welcome.

Structure

• Calendars consist of Components
• Components are e.g. Event or Todo
• Components consist of Propertys
• Propertys may have Parameters

let 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();

let bday = Event::new()
    .all_day(NaiveDate::from_ymd(2023, 3, 15))
    .summary("My Birthday")
    .description(
r#"Hey, I'm gonna have a party
BYOB: Bring your own beer.
Hendrik"#
)
    .done();

let todo = Todo::new().summary("Buy some milk").done();


let mut calendar = Calendar::new();
calendar.push(event);
calendar.push(todo);
calendar.push(bday);

Breaking API Changes in version 0.7.0

• Todo::due and Todo::completed now take their date-time argument by value rather than by reference
• Todo::completed now requires its chrono::DateTime argument to have exactly chrono::Utc specified as its time zone as mandated by the RFC.
• EventLike::starts, EventLike::ends and Todo::due now take newly introduced CalendarDateTime (through Into<CalendarDateTime> indirection). This allows callers to define time zone handling. Conversions from chrono::NaiveDateTime and chrono::DateTime<Utc> are provided for ergonomics, the latter also restoring API compatibility in case of UTC date-times.

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