automata - v0.10.0

automata/ical/validator

Types

Alarm

opaque </> 
pub opaque type Alarm

Calendar

opaque </> 
pub opaque type Calendar

Event

opaque </> 
pub opaque type Event

FreeBusy

opaque </> 
pub opaque type FreeBusy

Journal

opaque </> 
pub opaque type Journal

Timezone

opaque </> 
pub opaque type Timezone

TimezoneRule

</> 
pub type TimezoneRule {
  TimezoneRule(
    dtstart: ast.DateTime,
    tzoffsetfrom: String,
    tzoffsetto: String,
    rrule: option.Option(ast.RawRRule),
    tzname: option.Option(String),
  )
}

Constructors

Todo

opaque </> 
pub opaque type Todo

UnknownComponent

</> 
pub type UnknownComponent {
  UnknownComponent(
    kind: String,
    properties: List(ast.RawProperty),
    children: List(ast.RawComponent),
  )
}

Constructors

ValidationError

</> 
pub type ValidationError {
  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)
}

Constructors 

  • 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)

Values

add_alarm

</> 
pub fn add_alarm(event: Event, alarm: Alarm) -> Event

add_alarm_attendee

</> 
pub fn add_alarm_attendee(alarm: Alarm, value: String) -> Alarm

add_attendee

</> 
pub fn add_attendee(event: Event, value: String) -> Event

add_category

</> 
pub fn add_category(event: Event, value: String) -> Event

add_event

</> 
pub fn add_event(cal: Calendar, event: Event) -> Calendar

add_exdate

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

add_freebusy

</> 
pub fn add_freebusy(cal: Calendar, fb: FreeBusy) -> Calendar

add_freebusy_attendee

</> 
pub fn add_freebusy_attendee(
  fb: FreeBusy,
  value: String,
) -> FreeBusy

add_freebusy_period

</> 
pub fn add_freebusy_period(
  fb: FreeBusy,
  value: String,
) -> FreeBusy

add_journal

</> 
pub fn add_journal(cal: Calendar, j: Journal) -> Calendar

add_journal_category

</> 
pub fn add_journal_category(j: Journal, value: String) -> Journal

add_rdate

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

add_timezone

</> 
pub fn add_timezone(cal: Calendar, tz: Timezone) -> Calendar

add_timezone_daylight

</> 
pub fn add_timezone_daylight(
  tz: Timezone,
  rule: TimezoneRule,
) -> Timezone

add_timezone_standard

</> 
pub fn add_timezone_standard(
  tz: Timezone,
  rule: TimezoneRule,
) -> Timezone

add_todo

</> 
pub fn add_todo(cal: Calendar, t: Todo) -> Calendar

add_todo_alarm

</> 
pub fn add_todo_alarm(t: Todo, alarm: Alarm) -> Todo

add_todo_category

</> 
pub fn add_todo_category(t: Todo, value: String) -> Todo

add_todo_exdate

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

add_todo_rdate

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

add_unknown_component

</> 
pub fn add_unknown_component(
  cal: Calendar,
  component: UnknownComponent,
) -> Calendar

alarm_action

</> 
pub fn alarm_action(a: Alarm) -> String

alarm_attendees

</> 
pub fn alarm_attendees(a: Alarm) -> List(String)

alarm_description

</> 
pub fn alarm_description(a: Alarm) -> option.Option(String)

alarm_duration

</> 
pub fn alarm_duration(a: Alarm) -> option.Option(String)

alarm_repeat

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

alarm_summary

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

alarm_trigger

</> 
pub fn alarm_trigger(a: Alarm) -> String

alarm_x_properties

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

calendar_x_properties

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

calscale

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

event_alarms

</> 
pub fn event_alarms(event: Event) -> List(Alarm)

event_attendees

</> 
pub fn event_attendees(event: Event) -> List(String)

event_categories

</> 
pub fn event_categories(event: Event) -> List(String)

event_created

</> 
pub fn event_created(event: Event) -> option.Option(ast.DateTime)

event_description

</> 
pub fn event_description(event: Event) -> option.Option(String)

event_dtend

</> 
pub fn event_dtend(event: Event) -> option.Option(ast.DateTime)

event_dtend_tzid

</> 
pub fn event_dtend_tzid(event: Event) -> option.Option(String)

event_dtstamp

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

event_dtstart

</> 
pub fn event_dtstart(event: Event) -> option.Option(ast.DateTime)

event_dtstart_tzid

</> 
pub fn event_dtstart_tzid(event: Event) -> option.Option(String)

event_duration

</> 
pub fn event_duration(event: Event) -> option.Option(String)

event_exdates

</> 
pub fn event_exdates(event: Event) -> List(ast.DateTime)

event_last_modified

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

event_location

</> 
pub fn event_location(event: Event) -> option.Option(String)

event_organizer

</> 
pub fn event_organizer(event: Event) -> option.Option(String)

event_rdates

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

event_rrule

</> 
pub fn event_rrule(event: Event) -> option.Option(ast.RawRRule)

event_sequence

</> 
pub fn event_sequence(event: Event) -> Int

event_status

</> 
pub fn event_status(event: Event) -> option.Option(String)

event_summary

</> 
pub fn event_summary(event: Event) -> option.Option(String)

event_transparency

</> 
pub fn event_transparency(event: Event) -> option.Option(String)

event_uid

</> 
pub fn event_uid(event: Event) -> String

event_url

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

event_x_properties

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

events

</> 
pub fn events(cal: Calendar) -> List(Event)

freebusy

</> 
pub fn freebusy(cal: Calendar) -> List(FreeBusy)

freebusy_attendees

</> 
pub fn freebusy_attendees(fb: FreeBusy) -> List(String)

freebusy_dtend

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

freebusy_dtstamp

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

freebusy_dtstart

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

freebusy_organizer

</> 
pub fn freebusy_organizer(fb: FreeBusy) -> option.Option(String)

freebusy_periods

</> 
pub fn freebusy_periods(fb: FreeBusy) -> List(String)

freebusy_uid

</> 
pub fn freebusy_uid(fb: FreeBusy) -> String

freebusy_x_properties

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

journal_categories

</> 
pub fn journal_categories(j: Journal) -> List(String)

journal_description

</> 
pub fn journal_description(j: Journal) -> option.Option(String)

journal_dtstamp

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

journal_dtstart

</> 
pub fn journal_dtstart(j: Journal) -> option.Option(ast.DateTime)

journal_status

</> 
pub fn journal_status(j: Journal) -> option.Option(String)

journal_summary

</> 
pub fn journal_summary(j: Journal) -> option.Option(String)

journal_uid

</> 
pub fn journal_uid(j: Journal) -> String

journal_x_properties

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

journals

</> 
pub fn journals(cal: Calendar) -> List(Journal)

method

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

new_alarm

</> 
pub fn new_alarm(
  action action: String,
  trigger trigger: String,
) -> Alarm

new_calendar

</> 
pub fn new_calendar(
  version version: String,
  prod_id prod_id: String,
) -> Calendar

new_event

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

new_freebusy

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

new_journal

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

new_timezone

</> 
pub fn new_timezone(tzid tzid: String) -> Timezone

new_timezone_rule

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

new_todo

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

product_id

</> 
pub fn product_id(cal: Calendar) -> String

timezone_daylight

</> 
pub fn timezone_daylight(tz: Timezone) -> List(TimezoneRule)

timezone_last_modified

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

timezone_standard

</> 
pub fn timezone_standard(tz: Timezone) -> List(TimezoneRule)

timezone_tzid

</> 
pub fn timezone_tzid(tz: Timezone) -> String

timezone_tzurl

</> 
pub fn timezone_tzurl(tz: Timezone) -> option.Option(String)

timezone_x_properties

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

timezones

</> 
pub fn timezones(cal: Calendar) -> List(Timezone)

todo_alarms

</> 
pub fn todo_alarms(t: Todo) -> List(Alarm)

todo_categories

</> 
pub fn todo_categories(t: Todo) -> List(String)

todo_completed

</> 
pub fn todo_completed(t: Todo) -> option.Option(ast.DateTime)

todo_description

</> 
pub fn todo_description(t: Todo) -> option.Option(String)

todo_dtstamp

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

todo_dtstart

</> 
pub fn todo_dtstart(t: Todo) -> option.Option(ast.DateTime)

todo_due

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

todo_exdates

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

todo_percent_complete

</> 
pub fn todo_percent_complete(t: Todo) -> option.Option(Int)

todo_priority

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

todo_rdates

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

todo_rrule

</> 
pub fn todo_rrule(t: Todo) -> option.Option(ast.RawRRule)

todo_status

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

todo_summary

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

todo_uid

</> 
pub fn todo_uid(t: Todo) -> String

todo_x_properties

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

todos

</> 
pub fn todos(cal: Calendar) -> List(Todo)

unknown_components

</> 
pub fn unknown_components(
  cal: Calendar,
) -> List(UnknownComponent)

validate

</> 
pub fn validate(
  raw: ast.RawCalendar,
) -> Result(Calendar, ValidationError)

version

</> 
pub fn version(cal: Calendar) -> String

with_alarm_description

</> 
pub fn with_alarm_description(
  alarm: Alarm,
  value: String,
) -> Alarm

with_alarm_duration

</> 
pub fn with_alarm_duration(alarm: Alarm, value: String) -> Alarm

with_alarm_repeat

</> 
pub fn with_alarm_repeat(alarm: Alarm, value: Int) -> Alarm

with_alarm_summary

</> 
pub fn with_alarm_summary(alarm: Alarm, value: String) -> Alarm

with_alarm_x_property

</> 
pub fn with_alarm_x_property(
  alarm: Alarm,
  name: String,
  value: String,
) -> Alarm

with_calendar_x_property

</> 
pub fn with_calendar_x_property(
  cal: Calendar,
  name: String,
  value: String,
) -> Calendar

with_calscale

</> 
pub fn with_calscale(cal: Calendar, scale: String) -> Calendar

with_created

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

with_description

</> 
pub fn with_description(event: Event, value: String) -> Event

with_dtend

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

with_dtend_tzid

</> 
pub fn with_dtend_tzid(event: Event, tzid: String) -> Event

with_dtstart

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

with_dtstart_tzid

</> 
pub fn with_dtstart_tzid(event: Event, tzid: String) -> Event

with_duration

</> 
pub fn with_duration(event: Event, value: String) -> Event

with_event_x_property

</> 
pub fn with_event_x_property(
  event: Event,
  name: String,
  value: String,
) -> Event

with_freebusy_dtend

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

with_freebusy_dtstart

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

with_freebusy_organizer

</> 
pub fn with_freebusy_organizer(
  fb: FreeBusy,
  value: String,
) -> FreeBusy

with_freebusy_x_property

</> 
pub fn with_freebusy_x_property(
  fb: FreeBusy,
  name: String,
  value: String,
) -> FreeBusy

with_journal_description

</> 
pub fn with_journal_description(
  j: Journal,
  value: String,
) -> Journal

with_journal_dtstart

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

with_journal_status

</> 
pub fn with_journal_status(j: Journal, value: String) -> Journal

with_journal_summary

</> 
pub fn with_journal_summary(j: Journal, value: String) -> Journal

with_journal_x_property

</> 
pub fn with_journal_x_property(
  j: Journal,
  name: String,
  value: String,
) -> Journal

with_last_modified

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

with_location

</> 
pub fn with_location(event: Event, value: String) -> Event

with_method

</> 
pub fn with_method(cal: Calendar, method: String) -> Calendar

with_organizer

</> 
pub fn with_organizer(event: Event, value: String) -> Event

with_rrule

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

with_sequence

</> 
pub fn with_sequence(event: Event, value: Int) -> Event

with_status

</> 
pub fn with_status(event: Event, value: String) -> Event

with_summary

</> 
pub fn with_summary(event: Event, value: String) -> Event

with_timezone_last_modified

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

with_timezone_rule_name

</> 
pub fn with_timezone_rule_name(
  rule: TimezoneRule,
  value: String,
) -> TimezoneRule

with_timezone_rule_rrule

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

with_timezone_url

</> 
pub fn with_timezone_url(tz: Timezone, value: String) -> Timezone

with_timezone_x_property

</> 
pub fn with_timezone_x_property(
  tz: Timezone,
  name: String,
  value: String,
) -> Timezone

with_todo_completed

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

with_todo_description

</> 
pub fn with_todo_description(t: Todo, value: String) -> Todo

with_todo_dtstart

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

with_todo_due

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

with_todo_percent_complete

</> 
pub fn with_todo_percent_complete(t: Todo, value: Int) -> Todo

with_todo_priority

</> 
pub fn with_todo_priority(t: Todo, value: Int) -> Todo

with_todo_rrule

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

with_todo_status

</> 
pub fn with_todo_status(t: Todo, value: String) -> Todo

with_todo_summary

</> 
pub fn with_todo_summary(t: Todo, value: String) -> Todo

with_todo_x_property

</> 
pub fn with_todo_x_property(
  t: Todo,
  name: String,
  value: String,
) -> Todo

with_transparency

</> 
pub fn with_transparency(event: Event, value: String) -> Event

with_url

</> 
pub fn with_url(event: Event, value: String) -> Event
✨ Search Document