View Source Magical behaviour (Magical v1.0.0)

Documentation for Magical.

Summary

Callbacks

Parse an iCalendar string and return the result as a Magical.Calendar struct

Parse an iCalendar string and return the result as a Magical.Calendar struct. This function will throw an ArgumentError if the input is invalid

Callbacks

@callback from_ics(String.t()) :: {:ok, Magical.Calendar.t()} | {:error, :invalid}

Parse an iCalendar string and return the result as a Magical.Calendar struct

@callback from_ics!(String.t()) :: Magical.Calendar.t()

Parse an iCalendar string and return the result as a Magical.Calendar struct. This function will throw an ArgumentError if the input is invalid

Functions

@spec from_ics(String.t()) :: {:ok, Magical.Calendar.t()} | {:error, :invalid}
@spec from_ics!(String.t()) :: Magical.Calendar.t()
@spec to_ics(Magical.Calendar.t()) :: String.t()