automata/ical

RFC 5545 iCalendar parser and emitter built on top of automata/rrule. Handles the VCALENDAR envelope — VEVENT / VTODO / VJOURNAL / VFREEBUSY / VTIMEZONE / VALARM blocks, §3.1 line folding (CRLF/LF tolerant input, CRLF output, 75-octet UTF-8 boundary on emit), §3.2 quoted parameter values, §3.3.11 TEXT escaping (\\, \,, \;, \n/\N), and §3.4 content-line layout.

RRULE values are preserved as automata/rrule.RawRRule so callers can pipe them through rrule.validate — InvalidRRule wraps the syntactic rrule/parser.ParseError. Unknown component kinds round-trip through UnknownComponent rather than being dropped.

Types

Alarm

</>

pub type Alarm =
  validator.Alarm

Calendar

</>

pub type Calendar =
  validator.Calendar

Event

</>

pub type Event =
  validator.Event

FreeBusy

</>

pub type FreeBusy =
  validator.FreeBusy

IcalError

</>

pub type IcalError {
  UnexpectedEnd(line: Int)
  MismatchedBlock(begin: String, end: String, line: Int)
  MalformedProperty(line: Int, raw: String)
  MalformedParameter(line: Int, raw: String)
  MissingVersion
  MissingProductId
  MissingComponentProperty(component: String, name: String)
  InvalidDateTime(name: String, raw: String)
  InvalidEscape(raw: String)
  InvalidInteger(name: String, raw: String)
  InvalidRRule(raw: String, error: parser.ParseError)
  DuplicateRRule(component_uid: String)
  EmptyInputError
}

Constructors

```
UnexpectedEnd(line: Int)
```

MismatchedBlock(begin: String, end: String, line: Int)

MalformedProperty(line: Int, raw: String)

MalformedParameter(line: Int, raw: String)

```
MissingVersion
```
```
MissingProductId
```

MissingComponentProperty(component: String, name: String)

InvalidDateTime(name: String, raw: String)

```
InvalidEscape(raw: String)
```

InvalidInteger(name: String, raw: String)

InvalidRRule(raw: String, error: parser.ParseError)

```
DuplicateRRule(component_uid: String)
```
```
EmptyInputError
```

Journal

</>

pub type Journal =
  validator.Journal

Timezone

</>

pub type Timezone =
  validator.Timezone

TimezoneRule

</>

pub type TimezoneRule =
  validator.TimezoneRule

Todo

</>

pub type Todo =
  validator.Todo

UnknownComponent

</>

pub type UnknownComponent =
  validator.UnknownComponent

Values

add_alarm

</>

pub fn add_alarm(
  event: validator.Event,
  alarm: validator.Alarm,
) -> validator.Event

add_alarm_attendee

</>

pub fn add_alarm_attendee(
  alarm: validator.Alarm,
  value: String,
) -> validator.Alarm

add_attendee

</>

pub fn add_attendee(
  event: validator.Event,
  value: String,
) -> validator.Event

add_category

</>

pub fn add_category(
  event: validator.Event,
  value: String,
) -> validator.Event

add_event

</>

pub fn add_event(
  cal: validator.Calendar,
  event: validator.Event,
) -> validator.Calendar

add_exdate

</>

pub fn add_exdate(
  event: validator.Event,
  dt: ast.DateTime,
) -> validator.Event

add_freebusy

</>

pub fn add_freebusy(
  cal: validator.Calendar,
  fb: validator.FreeBusy,
) -> validator.Calendar

add_freebusy_attendee

</>

pub fn add_freebusy_attendee(
  fb: validator.FreeBusy,
  value: String,
) -> validator.FreeBusy

add_freebusy_period

</>

pub fn add_freebusy_period(
  fb: validator.FreeBusy,
  value: String,
) -> validator.FreeBusy

add_journal

</>

pub fn add_journal(
  cal: validator.Calendar,
  j: validator.Journal,
) -> validator.Calendar

add_journal_category

</>

pub fn add_journal_category(
  j: validator.Journal,
  value: String,
) -> validator.Journal

add_rdate

</>

pub fn add_rdate(
  event: validator.Event,
  dt: ast.DateTime,
) -> validator.Event

add_timezone

</>

pub fn add_timezone(
  cal: validator.Calendar,
  tz: validator.Timezone,
) -> validator.Calendar

add_timezone_daylight

</>

pub fn add_timezone_daylight(
  tz: validator.Timezone,
  rule: validator.TimezoneRule,
) -> validator.Timezone

add_timezone_standard

</>

pub fn add_timezone_standard(
  tz: validator.Timezone,
  rule: validator.TimezoneRule,
) -> validator.Timezone

add_todo

</>

pub fn add_todo(
  cal: validator.Calendar,
  t: validator.Todo,
) -> validator.Calendar

add_todo_alarm

</>

pub fn add_todo_alarm(
  t: validator.Todo,
  alarm: validator.Alarm,
) -> validator.Todo

add_todo_category

</>

pub fn add_todo_category(
  t: validator.Todo,
  value: String,
) -> validator.Todo

add_todo_exdate

</>

pub fn add_todo_exdate(
  t: validator.Todo,
  dt: ast.DateTime,
) -> validator.Todo

add_todo_rdate

</>

pub fn add_todo_rdate(
  t: validator.Todo,
  dt: ast.DateTime,
) -> validator.Todo

add_unknown_component

</>

pub fn add_unknown_component(
  cal: validator.Calendar,
  component: validator.UnknownComponent,
) -> validator.Calendar

alarm_action

</>

pub fn alarm_action(a: validator.Alarm) -> String

alarm_attendees

</>

pub fn alarm_attendees(a: validator.Alarm) -> List(String)

alarm_description

</>

pub fn alarm_description(
  a: validator.Alarm,
) -> option.Option(String)

alarm_duration

</>

pub fn alarm_duration(
  a: validator.Alarm,
) -> option.Option(String)

alarm_repeat

</>

pub fn alarm_repeat(a: validator.Alarm) -> option.Option(Int)

alarm_summary

</>

pub fn alarm_summary(a: validator.Alarm) -> option.Option(String)

alarm_trigger

</>

pub fn alarm_trigger(a: validator.Alarm) -> String

alarm_x_properties

</>

pub fn alarm_x_properties(
  a: validator.Alarm,
) -> dict.Dict(String, String)

calendar_x_properties

</>

pub fn calendar_x_properties(
  cal: validator.Calendar,
) -> dict.Dict(String, String)

calscale

</>

pub fn calscale(cal: validator.Calendar) -> option.Option(String)

encode

</>

pub fn encode(cal: validator.Calendar) -> String

Render a Calendar back to the RFC 5545 wire format. Output uses CRLF line terminators and folds at 75 UTF-8 octets.

event_alarms

</>

pub fn event_alarms(
  event: validator.Event,
) -> List(validator.Alarm)

event_attendees

</>

pub fn event_attendees(event: validator.Event) -> List(String)

event_categories

</>

pub fn event_categories(event: validator.Event) -> List(String)

event_created

</>

pub fn event_created(
  event: validator.Event,
) -> option.Option(ast.DateTime)

event_description

</>

pub fn event_description(
  event: validator.Event,
) -> option.Option(String)

event_dtend

</>

pub fn event_dtend(
  event: validator.Event,
) -> option.Option(ast.DateTime)

event_dtend_tzid

</>

pub fn event_dtend_tzid(
  event: validator.Event,
) -> option.Option(String)

event_dtstamp

</>

pub fn event_dtstamp(event: validator.Event) -> ast.DateTime

event_dtstart

</>

pub fn event_dtstart(
  event: validator.Event,
) -> option.Option(ast.DateTime)

event_dtstart_tzid

</>

pub fn event_dtstart_tzid(
  event: validator.Event,
) -> option.Option(String)

event_duration

</>

pub fn event_duration(
  event: validator.Event,
) -> option.Option(String)

event_exdates

</>

pub fn event_exdates(
  event: validator.Event,
) -> List(ast.DateTime)

event_last_modified

</>

pub fn event_last_modified(
  event: validator.Event,
) -> option.Option(ast.DateTime)

event_location

</>

pub fn event_location(
  event: validator.Event,
) -> option.Option(String)

event_organizer

</>

pub fn event_organizer(
  event: validator.Event,
) -> option.Option(String)

event_rdates

</>

pub fn event_rdates(event: validator.Event) -> List(ast.DateTime)

event_rrule

</>

pub fn event_rrule(
  event: validator.Event,
) -> option.Option(ast.RawRRule)

event_sequence

</>

pub fn event_sequence(event: validator.Event) -> Int

event_status

</>

pub fn event_status(
  event: validator.Event,
) -> option.Option(String)

event_summary

</>

pub fn event_summary(
  event: validator.Event,
) -> option.Option(String)

event_transparency

</>

pub fn event_transparency(
  event: validator.Event,
) -> option.Option(String)

event_uid

</>

pub fn event_uid(event: validator.Event) -> String

event_url

</>

pub fn event_url(event: validator.Event) -> option.Option(String)

event_x_properties

</>

pub fn event_x_properties(
  event: validator.Event,
) -> dict.Dict(String, String)

events

</>

pub fn events(cal: validator.Calendar) -> List(validator.Event)

freebusy

</>

pub fn freebusy(
  cal: validator.Calendar,
) -> List(validator.FreeBusy)

freebusy_attendees

</>

pub fn freebusy_attendees(fb: validator.FreeBusy) -> List(String)

freebusy_dtend

</>

pub fn freebusy_dtend(
  fb: validator.FreeBusy,
) -> option.Option(ast.DateTime)

freebusy_dtstamp

</>

pub fn freebusy_dtstamp(fb: validator.FreeBusy) -> ast.DateTime

freebusy_dtstart

</>

pub fn freebusy_dtstart(
  fb: validator.FreeBusy,
) -> option.Option(ast.DateTime)

freebusy_organizer

</>

pub fn freebusy_organizer(
  fb: validator.FreeBusy,
) -> option.Option(String)

freebusy_periods

</>

pub fn freebusy_periods(fb: validator.FreeBusy) -> List(String)

freebusy_uid

</>

pub fn freebusy_uid(fb: validator.FreeBusy) -> String

freebusy_x_properties

</>

pub fn freebusy_x_properties(
  fb: validator.FreeBusy,
) -> dict.Dict(String, String)

journal_categories

</>

pub fn journal_categories(j: validator.Journal) -> List(String)

journal_description

</>

pub fn journal_description(
  j: validator.Journal,
) -> option.Option(String)

journal_dtstamp

</>

pub fn journal_dtstamp(j: validator.Journal) -> ast.DateTime

journal_dtstart

</>

pub fn journal_dtstart(
  j: validator.Journal,
) -> option.Option(ast.DateTime)

journal_status

</>

pub fn journal_status(
  j: validator.Journal,
) -> option.Option(String)

journal_summary

</>

pub fn journal_summary(
  j: validator.Journal,
) -> option.Option(String)

journal_uid

</>

pub fn journal_uid(j: validator.Journal) -> String

journal_x_properties

</>

pub fn journal_x_properties(
  j: validator.Journal,
) -> dict.Dict(String, String)

journals

</>

pub fn journals(
  cal: validator.Calendar,
) -> List(validator.Journal)

method

</>

pub fn method(cal: validator.Calendar) -> option.Option(String)

new_alarm

</>

pub fn new_alarm(
  action action: String,
  trigger trigger: String,
) -> validator.Alarm

new_calendar

</>

pub fn new_calendar(
  version version: String,
  prod_id prod_id: String,
) -> validator.Calendar

new_event

</>

pub fn new_event(
  uid uid: String,
  dtstamp dtstamp: ast.DateTime,
) -> validator.Event

new_freebusy

</>

pub fn new_freebusy(
  uid uid: String,
  dtstamp dtstamp: ast.DateTime,
) -> validator.FreeBusy

new_journal

</>

pub fn new_journal(
  uid uid: String,
  dtstamp dtstamp: ast.DateTime,
) -> validator.Journal

new_timezone

</>

pub fn new_timezone(tzid tzid: String) -> validator.Timezone

new_timezone_rule

</>

pub fn new_timezone_rule(
  dtstart dtstart: ast.DateTime,
  offset_from offset_from: String,
  offset_to offset_to: String,
) -> validator.TimezoneRule

new_todo

</>

pub fn new_todo(
  uid uid: String,
  dtstamp dtstamp: ast.DateTime,
) -> validator.Todo

parse

</>

pub fn parse(
  input: String,
) -> Result(validator.Calendar, IcalError)

Parse an iCalendar document into a validated Calendar. Errors from the lexer, parser, and validator are mapped into the unified IcalError type so callers only need one pattern-match.

product_id

</>

pub fn product_id(cal: validator.Calendar) -> String

timezone_daylight

</>

pub fn timezone_daylight(
  tz: validator.Timezone,
) -> List(validator.TimezoneRule)

timezone_last_modified

</>

pub fn timezone_last_modified(
  tz: validator.Timezone,
) -> option.Option(ast.DateTime)

timezone_standard

</>

pub fn timezone_standard(
  tz: validator.Timezone,
) -> List(validator.TimezoneRule)

timezone_tzid

</>

pub fn timezone_tzid(tz: validator.Timezone) -> String

timezone_tzurl

</>

pub fn timezone_tzurl(
  tz: validator.Timezone,
) -> option.Option(String)

timezone_x_properties

</>

pub fn timezone_x_properties(
  tz: validator.Timezone,
) -> dict.Dict(String, String)

timezones

</>

pub fn timezones(
  cal: validator.Calendar,
) -> List(validator.Timezone)

todo_alarms

</>

pub fn todo_alarms(t: validator.Todo) -> List(validator.Alarm)

todo_categories

</>

pub fn todo_categories(t: validator.Todo) -> List(String)

todo_completed

</>

pub fn todo_completed(
  t: validator.Todo,
) -> option.Option(ast.DateTime)

todo_description

</>

pub fn todo_description(
  t: validator.Todo,
) -> option.Option(String)

todo_dtstamp

</>

pub fn todo_dtstamp(t: validator.Todo) -> ast.DateTime

todo_dtstart

</>

pub fn todo_dtstart(
  t: validator.Todo,
) -> option.Option(ast.DateTime)

todo_due

</>

pub fn todo_due(t: validator.Todo) -> option.Option(ast.DateTime)

todo_exdates

</>

pub fn todo_exdates(t: validator.Todo) -> List(ast.DateTime)

todo_percent_complete

</>

pub fn todo_percent_complete(
  t: validator.Todo,
) -> option.Option(Int)

todo_priority

</>

pub fn todo_priority(t: validator.Todo) -> option.Option(Int)

todo_rdates

</>

pub fn todo_rdates(t: validator.Todo) -> List(ast.DateTime)

todo_rrule

</>

pub fn todo_rrule(
  t: validator.Todo,
) -> option.Option(ast.RawRRule)

todo_status

</>

pub fn todo_status(t: validator.Todo) -> option.Option(String)

todo_summary

</>

pub fn todo_summary(t: validator.Todo) -> option.Option(String)

todo_uid

</>

pub fn todo_uid(t: validator.Todo) -> String

todo_x_properties

</>

pub fn todo_x_properties(
  t: validator.Todo,
) -> dict.Dict(String, String)

todos

</>

pub fn todos(cal: validator.Calendar) -> List(validator.Todo)

unknown_components

</>

pub fn unknown_components(
  cal: validator.Calendar,
) -> List(validator.UnknownComponent)

version

</>

pub fn version(cal: validator.Calendar) -> String

with_alarm_description

</>

pub fn with_alarm_description(
  alarm: validator.Alarm,
  value: String,
) -> validator.Alarm

with_alarm_duration

</>

pub fn with_alarm_duration(
  alarm: validator.Alarm,
  value: String,
) -> validator.Alarm

with_alarm_repeat

</>

pub fn with_alarm_repeat(
  alarm: validator.Alarm,
  value: Int,
) -> validator.Alarm

with_alarm_summary

</>

pub fn with_alarm_summary(
  alarm: validator.Alarm,
  value: String,
) -> validator.Alarm

with_alarm_x_property

</>

pub fn with_alarm_x_property(
  alarm: validator.Alarm,
  name: String,
  value: String,
) -> validator.Alarm

with_calendar_x_property

</>

pub fn with_calendar_x_property(
  cal: validator.Calendar,
  name: String,
  value: String,
) -> validator.Calendar

with_calscale

</>

pub fn with_calscale(
  cal: validator.Calendar,
  scale: String,
) -> validator.Calendar

with_created

</>

pub fn with_created(
  event: validator.Event,
  dt: ast.DateTime,
) -> validator.Event

with_description

</>

pub fn with_description(
  event: validator.Event,
  value: String,
) -> validator.Event

with_dtend

</>

pub fn with_dtend(
  event: validator.Event,
  dt: ast.DateTime,
) -> validator.Event

with_dtend_tzid

</>

pub fn with_dtend_tzid(
  event: validator.Event,
  tzid: String,
) -> validator.Event

with_dtstart

</>

pub fn with_dtstart(
  event: validator.Event,
  dt: ast.DateTime,
) -> validator.Event

with_dtstart_tzid

</>

pub fn with_dtstart_tzid(
  event: validator.Event,
  tzid: String,
) -> validator.Event

with_duration

</>

pub fn with_duration(
  event: validator.Event,
  value: String,
) -> validator.Event

with_event_x_property

</>

pub fn with_event_x_property(
  event: validator.Event,
  name: String,
  value: String,
) -> validator.Event

with_freebusy_dtend

</>

pub fn with_freebusy_dtend(
  fb: validator.FreeBusy,
  dt: ast.DateTime,
) -> validator.FreeBusy

with_freebusy_dtstart

</>

pub fn with_freebusy_dtstart(
  fb: validator.FreeBusy,
  dt: ast.DateTime,
) -> validator.FreeBusy

with_freebusy_organizer

</>

pub fn with_freebusy_organizer(
  fb: validator.FreeBusy,
  value: String,
) -> validator.FreeBusy

with_freebusy_x_property

</>

pub fn with_freebusy_x_property(
  fb: validator.FreeBusy,
  name: String,
  value: String,
) -> validator.FreeBusy

with_journal_description

</>

pub fn with_journal_description(
  j: validator.Journal,
  value: String,
) -> validator.Journal

with_journal_dtstart

</>

pub fn with_journal_dtstart(
  j: validator.Journal,
  dt: ast.DateTime,
) -> validator.Journal

with_journal_status

</>

pub fn with_journal_status(
  j: validator.Journal,
  value: String,
) -> validator.Journal

with_journal_summary

</>

pub fn with_journal_summary(
  j: validator.Journal,
  value: String,
) -> validator.Journal

with_journal_x_property

</>

pub fn with_journal_x_property(
  j: validator.Journal,
  name: String,
  value: String,
) -> validator.Journal

with_last_modified

</>

pub fn with_last_modified(
  event: validator.Event,
  dt: ast.DateTime,
) -> validator.Event

with_location

</>

pub fn with_location(
  event: validator.Event,
  value: String,
) -> validator.Event

with_method

</>

pub fn with_method(
  cal: validator.Calendar,
  method: String,
) -> validator.Calendar

with_organizer

</>

pub fn with_organizer(
  event: validator.Event,
  value: String,
) -> validator.Event

with_rrule

</>

pub fn with_rrule(
  event: validator.Event,
  rule: ast.RawRRule,
) -> validator.Event

with_sequence

</>

pub fn with_sequence(
  event: validator.Event,
  value: Int,
) -> validator.Event

with_status

</>

pub fn with_status(
  event: validator.Event,
  value: String,
) -> validator.Event

with_summary

</>

pub fn with_summary(
  event: validator.Event,
  value: String,
) -> validator.Event

with_timezone_last_modified

</>

pub fn with_timezone_last_modified(
  tz: validator.Timezone,
  dt: ast.DateTime,
) -> validator.Timezone

with_timezone_rule_name

</>

pub fn with_timezone_rule_name(
  rule: validator.TimezoneRule,
  value: String,
) -> validator.TimezoneRule

with_timezone_rule_rrule

</>

pub fn with_timezone_rule_rrule(
  rule: validator.TimezoneRule,
  value: ast.RawRRule,
) -> validator.TimezoneRule

with_timezone_url

</>

pub fn with_timezone_url(
  tz: validator.Timezone,
  value: String,
) -> validator.Timezone

with_timezone_x_property

</>

pub fn with_timezone_x_property(
  tz: validator.Timezone,
  name: String,
  value: String,
) -> validator.Timezone

with_todo_completed

</>

pub fn with_todo_completed(
  t: validator.Todo,
  dt: ast.DateTime,
) -> validator.Todo

with_todo_description

</>

pub fn with_todo_description(
  t: validator.Todo,
  value: String,
) -> validator.Todo

with_todo_dtstart

</>

pub fn with_todo_dtstart(
  t: validator.Todo,
  dt: ast.DateTime,
) -> validator.Todo

with_todo_due

</>

pub fn with_todo_due(
  t: validator.Todo,
  dt: ast.DateTime,
) -> validator.Todo

with_todo_percent_complete

</>

pub fn with_todo_percent_complete(
  t: validator.Todo,
  value: Int,
) -> validator.Todo

with_todo_priority

</>

pub fn with_todo_priority(
  t: validator.Todo,
  value: Int,
) -> validator.Todo

with_todo_rrule

</>

pub fn with_todo_rrule(
  t: validator.Todo,
  rule: ast.RawRRule,
) -> validator.Todo

with_todo_status

</>

pub fn with_todo_status(
  t: validator.Todo,
  value: String,
) -> validator.Todo

with_todo_summary

</>

pub fn with_todo_summary(
  t: validator.Todo,
  value: String,
) -> validator.Todo

with_todo_x_property

</>

pub fn with_todo_x_property(
  t: validator.Todo,
  name: String,
  value: String,
) -> validator.Todo

with_transparency

</>

pub fn with_transparency(
  event: validator.Event,
  value: String,
) -> validator.Event

with_url

</>

pub fn with_url(
  event: validator.Event,
  value: String,
) -> validator.Event