icalendar 0.1.1 · OCaml Package

type timestamp_utc = Ptime.t

val equal_timestamp_utc : 
  timestamp_utc ->
  timestamp_utc ->
  Ppx_deriving_runtime.bool

val pp_timestamp_utc : 
  Ppx_deriving_runtime.Format.formatter ->
  timestamp_utc ->
  Ppx_deriving_runtime.unit

val show_timestamp_utc : timestamp_utc -> Ppx_deriving_runtime.string

type timestamp_local = Ptime.t

val equal_timestamp_local : 
  timestamp_local ->
  timestamp_local ->
  Ppx_deriving_runtime.bool

val pp_timestamp_local : 
  Ppx_deriving_runtime.Format.formatter ->
  timestamp_local ->
  Ppx_deriving_runtime.unit

val show_timestamp_local : timestamp_local -> Ppx_deriving_runtime.string

type utc_or_timestamp_local = [

| `Utc of timestamp_utc
| `Local of timestamp_local

]

val equal_utc_or_timestamp_local : 
  utc_or_timestamp_local ->
  utc_or_timestamp_local ->
  Ppx_deriving_runtime.bool

val pp_utc_or_timestamp_local : 
  Ppx_deriving_runtime.Format.formatter ->
  utc_or_timestamp_local ->
  Ppx_deriving_runtime.unit

val show_utc_or_timestamp_local : 
  utc_or_timestamp_local ->
  Ppx_deriving_runtime.string

type timestamp = [

| utc_or_timestamp_local
| `With_tzid of timestamp_local * (bool * string)

]

val equal_timestamp : timestamp -> timestamp -> Ppx_deriving_runtime.bool

val pp_timestamp : 
  Ppx_deriving_runtime.Format.formatter ->
  timestamp ->
  Ppx_deriving_runtime.unit

val show_timestamp : timestamp -> Ppx_deriving_runtime.string

type date_or_datetime = [

| `Datetime of timestamp
| `Date of Ptime.date

]

type weekday = [

| `Friday
| `Monday
| `Saturday
| `Sunday
| `Thursday
| `Tuesday
| `Wednesday

]

val equal_weekday : weekday -> weekday -> Ppx_deriving_runtime.bool

val pp_weekday : 
  Ppx_deriving_runtime.Format.formatter ->
  weekday ->
  Ppx_deriving_runtime.unit

val show_weekday : weekday -> Ppx_deriving_runtime.string

type recur = [

| `Byminute of int list
| `Byday of (int * weekday) list
| `Byhour of int list
| `Bymonth of int list
| `Bymonthday of int list
| `Bysecond of int list
| `Bysetposday of int list
| `Byweek of int list
| `Byyearday of int list
| `Weekday of weekday

]

val equal_recur : recur -> recur -> Ppx_deriving_runtime.bool

val pp_recur : 
  Ppx_deriving_runtime.Format.formatter ->
  recur ->
  Ppx_deriving_runtime.unit

val show_recur : recur -> Ppx_deriving_runtime.string

type freq = [

| `Daily
| `Hourly
| `Minutely
| `Monthly
| `Secondly
| `Weekly
| `Yearly

]

val equal_freq : freq -> freq -> Ppx_deriving_runtime.bool

val pp_freq : 
  Ppx_deriving_runtime.Format.formatter ->
  freq ->
  Ppx_deriving_runtime.unit

val show_freq : freq -> Ppx_deriving_runtime.string

type count_or_until = [

| `Count of int
| `Until of utc_or_timestamp_local

]

val equal_count_or_until : 
  count_or_until ->
  count_or_until ->
  Ppx_deriving_runtime.bool

val pp_count_or_until : 
  Ppx_deriving_runtime.Format.formatter ->
  count_or_until ->
  Ppx_deriving_runtime.unit

val show_count_or_until : count_or_until -> Ppx_deriving_runtime.string

type interval = int

type recurrence = freq * count_or_until option * interval option * recur list

val equal_recurrence : recurrence -> recurrence -> Ppx_deriving_runtime.bool

val pp_recurrence : 
  Ppx_deriving_runtime.Format.formatter ->
  recurrence ->
  Ppx_deriving_runtime.unit

val show_recurrence : recurrence -> Ppx_deriving_runtime.string

type valuetype = [

| `Binary
| `Boolean
| `Caladdress
| `Date
| `Datetime
| `Duration
| `Float
| `Integer
| `Period
| `Recur
| `Text
| `Time
| `Uri
| `Utcoffset
| `Xname of string * string
| `Ianatoken of string

]

type cutype = [

| `Group
| `Individual
| `Resource
| `Room
| `Unknown
| `Ianatoken of string
| `Xname of string * string

]

type partstat = [

| `Accepted
| `Completed
| `Declined
| `Delegated
| `In_process
| `Needs_action
| `Tentative
| `Ianatoken of string
| `Xname of string * string

]

type role = [

| `Chair
| `Nonparticipant
| `Optparticipant
| `Reqparticipant
| `Ianatoken of string
| `Xname of string * string

]

type relationship = [

| `Parent
| `Child
| `Sibling
| `Ianatoken of string
| `Xname of string * string

]

type fbtype = [

| `Free
| `Busy
| `Busy_Unavailable
| `Busy_Tentative
| `Ianatoken of string
| `Xname of string * string

]

val equal_fbtype : fbtype -> fbtype -> Ppx_deriving_runtime.bool

val pp_fbtype : 
  Ppx_deriving_runtime.Format.formatter ->
  fbtype ->
  Ppx_deriving_runtime.unit

val show_fbtype : fbtype -> Ppx_deriving_runtime.string

type param_value = [

| `Quoted of string
| `String of string

]

type _ icalparameter =

| Altrep : Uri.t icalparameter
| Cn : param_value icalparameter
| Cutype : cutype icalparameter
| Delegated_from : Uri.t list icalparameter
| Delegated_to : Uri.t list icalparameter
| Dir : Uri.t icalparameter
| Encoding : [ `Base64 ] icalparameter
| Media_type : (string * string) icalparameter
| Fbtype : fbtype icalparameter
| Language : string icalparameter
| Member : Uri.t list icalparameter
| Partstat : partstat icalparameter
| Range : [ `Thisandfuture ] icalparameter
| Related : [ `Start | `End ] icalparameter
| Reltype : relationship icalparameter
| Role : role icalparameter
| Rsvp : bool icalparameter
| Sentby : Uri.t icalparameter
| Tzid : (bool * string) icalparameter
| Valuetype : valuetype icalparameter
| Iana_param : (string * param_value list) icalparameter
| Xparam : ((string * string) * param_value list) icalparameter

module Params : sig ... end

type params = Params.t

type other_prop = [

| `Iana_prop of string * params * string
| `Xprop of (string * string) * params * string

]

val equal_other_prop : other_prop -> other_prop -> Ppx_deriving_runtime.bool

val pp_other_prop : 
  Ppx_deriving_runtime.Format.formatter ->
  other_prop ->
  Ppx_deriving_runtime.unit

val show_other_prop : other_prop -> Ppx_deriving_runtime.string

type cal_prop = [

| `Prodid of params * string
| `Version of params * string
| `Calscale of params * string
| `Method of params * string
| other_prop

]

type class_ = [

| `Public
| `Private
| `Confidential
| `Ianatoken of string
| `Xname of string * string

]

type status = [

| `Draft
| `Final
| `Cancelled
| `Needs_action
| `Completed
| `In_process
| `Tentative
| `Confirmed

]

type period = timestamp * Ptime.Span.t * bool

type period_utc = timestamp_utc * Ptime.Span.t * bool

type dates_or_datetimes = [

| `Datetimes of timestamp list
| `Dates of Ptime.date list

]

type dates_or_datetimes_or_periods = [

| dates_or_datetimes
| `Periods of period list

]

type general_prop = [

| `Dtstamp of params * timestamp_utc
| `Uid of params * string
| `Dtstart of params * date_or_datetime
| `Class of params * class_
| `Created of params * timestamp_utc
| `Description of params * string
| `Geo of params * (float * float)
| `Lastmod of params * timestamp_utc
| `Location of params * string
| `Organizer of params * Uri.t
| `Priority of params * int
| `Seq of params * int
| `Status of params * status
| `Summary of params * string
| `Url of params * Uri.t
| `Recur_id of params * date_or_datetime
| `Rrule of params * recurrence
| `Duration of params * Ptime.Span.t
| `Attach of params * [ `Uri of Uri.t | `Binary of string ]
| `Attendee of params * Uri.t
| `Categories of params * string list
| `Comment of params * string
| `Contact of params * string
| `Exdate of params * dates_or_datetimes
| `Rstatus of params * ((int * int * int option) * string * string option)
| `Related of params * string
| `Resource of params * string list
| `Rdate of params * dates_or_datetimes_or_periods

]

type event_prop = [

| general_prop
| `Transparency of params * [ `Transparent | `Opaque ]
| `Dtend of params * date_or_datetime
| other_prop

]

type 'a alarm_struct = {

trigger : params * [ `Duration of Ptime.Span.t | `Datetime of timestamp_utc ];
duration_repeat : ((params * Ptime.Span.t) * (params * int)) option;
other : other_prop list;
special : 'a;

}

type audio_struct = {

attach : (params * [ `Uri of Uri.t | `Binary of string ]) option;

}

type display_struct = {

description : params * string;

}

type email_struct = {

description : params * string;
summary : params * string;
attendees : (params * Uri.t) list;
attach : (params * [ `Uri of Uri.t | `Binary of string ]) option;

}

type alarm = [

| `Audio of audio_struct alarm_struct
| `Display of display_struct alarm_struct
| `Email of email_struct alarm_struct
| `None of unit alarm_struct

]

type tz_prop = [

| `Dtstart_local of params * timestamp_local
| `Tzoffset_to of params * Ptime.Span.t
| `Tzoffset_from of params * Ptime.Span.t
| `Rrule of params * recurrence
| `Comment of params * string
| `Rdate of params * dates_or_datetimes_or_periods
| `Tzname of params * string
| other_prop

]

type timezone_prop = [

| `Timezone_id of params * (bool * string)
| `Lastmod of params * timestamp_utc
| `Tzurl of params * Uri.t
| `Standard of tz_prop list
| `Daylight of tz_prop list
| other_prop

]

type todo_prop = [

| general_prop
| `Completed of params * timestamp_utc
| `Percent of params * int
| `Due of params * date_or_datetime
| other_prop

]

type freebusy_prop = [

| `Dtstamp of params * timestamp_utc
| `Uid of params * string
| `Contact of params * string
| `Dtstart_utc of params * timestamp_utc
| `Dtend_utc of params * timestamp_utc
| `Organizer of params * Uri.t
| `Url of params * Uri.t
| `Attendee of params * Uri.t
| `Comment of params * string
| `Freebusy of params * period_utc list
| `Rstatus of params * ((int * int * int option) * string * string option)
| other_prop

]

type event = {

dtstamp : params * timestamp_utc;
uid : params * string;
dtstart : params * date_or_datetime;
dtend_or_duration : [ `Duration of params * Ptime.Span.t | `Dtend of params * date_or_datetime ] option;
rrule : (params * recurrence) option;
props : event_prop list;
alarms : alarm list;

}

type timezone = timezone_prop list

type component = [

| `Event of event
| `Todo of todo_prop list * alarm list
| `Freebusy of freebusy_prop list
| `Timezone of timezone

]

val pp_component : 
  Ppx_deriving_runtime.Format.formatter ->
  component ->
  Ppx_deriving_runtime.unit

val show_component : component -> Ppx_deriving_runtime.string

val component_to_ics_key : component -> string

type calendar = cal_prop list * component list

val parse_datetime : string -> (timestamp, string) result

val parse : string -> (calendar, string) result

val pp : calendar Fmt.t

type comp = [

| `Allcomp
| `Comp of component_transform list

]

and prop = [

| `Allprop
| `Prop of (string * bool) list

]

and component_transform = string * prop * comp

val pp_comp : 
  Ppx_deriving_runtime.Format.formatter ->
  comp ->
  Ppx_deriving_runtime.unit

val show_comp : comp -> Ppx_deriving_runtime.string

val pp_prop : 
  Ppx_deriving_runtime.Format.formatter ->
  prop ->
  Ppx_deriving_runtime.unit

val show_prop : prop -> Ppx_deriving_runtime.string

val pp_component_transform : 
  Ppx_deriving_runtime.Format.formatter ->
  component_transform ->
  Ppx_deriving_runtime.unit

val show_component_transform : 
  component_transform ->
  Ppx_deriving_runtime.string

val equal_comp : comp -> comp -> Ppx_deriving_runtime.bool

val equal_prop : prop -> prop -> Ppx_deriving_runtime.bool

val equal_component_transform : 
  component_transform ->
  component_transform ->
  Ppx_deriving_runtime.bool

val to_ics : 
  ?cr:bool ->
  ?filter:component_transform option ->
  calendar ->
  string

module Writer : sig ... end

val recur_dates : Ptime.t -> recurrence -> unit -> Ptime.t option

val recur_events : event -> unit -> event option

val normalize_timezone : 
  Ptime.t ->
  (bool * String.t) ->
  timezone_prop list list ->
  Ptime.t option

package icalendar