Module icalendar::parser

Parsing iCalendar document parser

I would have loved to provide a zero-copy parser here however the Internet Calendaring and Scheduling Core Object Specification (iCalendar) allows, nay demands special line folding:

Lines of text SHOULD NOT be longer than 75 octets, excluding the line break. Long content lines SHOULD be split into a multiple line representations using a line “folding” technique. – rfc5545 3.1

For this reason parsing iCal is a bit indirect. In this module you find the following functions to parser iCalendar document. unfold() will unfold the iCal content and turn it into the nice machine-readable format it ought to be. read_calendar_simple() returns a Vector of Components read_calendar() does the same thing but produces nicer parsing errors with line numbers (referencing the normalized content).

You don’t have to use normalize() on your document if your calendar does not obey the folding rules specified in rfc5545 3.1. If it unexpectedly does, the errors might be a tad confusing.

A Calendar is always a tree of Components. It may contain multiple root elements so we have a Vec<Component> and each Component may more child Components. Each Component has properties, so a Vec of Property and those have of Parameters.

Structs

• Calendar
  Helper-type for reserialization
• Component
  The parsing equivalent of crate::components::Component
• Parameter
  Zero-copy version of crate::properties::Parameter
• ParseString
  A zero-copy string parsed from an iCal input.
• Property
  Zero-copy version of crate::properties::Property

Functions

• read_calendar
  Parse iCalendar file content into an array of Components
• read_calendar_simple
  Parse iCalendar file content into an array of Components
• read_components
  Parse iCalendar file content into an array of Components
• unfold
  Normalize content lines.