excal

v0.3.2

excal v0.3.2 Excal.Recurrence.Stream View Source

Generates Elixir streams from iCalendar recurrence rules (RRULE).

This is the most idiomatic way of interacting with iCalendar recurrence rules in Elixir. The streams created here act like any other Elixir stream would act.

Link to this section Summary

Types

option()

Valid options for new/3.

Functions

new(rrule, dtstart, opts \\ [])

Creates a stream of date or datetime instances from the given recurrence rule string and schedule start time.

Link to this section Types

Link to this type

option() View Source 
option() ::
  {:from, Excal.date_or_datetime()} | {:until, Excal.date_or_datetime()}

Valid options for new/3.

Link to this section Functions

Link to this function

new(rrule, dtstart, opts \\ []) View Source 
new(String.t(), Excal.date_or_datetime(), [option()]) ::
  {:ok, Enumerable.t()}
  | {:error,
     Excal.Recurrence.Iterator.initialization_error()
     | Excal.Recurrence.Iterator.iterator_start_error()}

Creates a stream of date or datetime instances from the given recurrence rule string and schedule start time.

It's also possible to set the start and end time of the stream using the :from and :until options.

Options

  • :from - specifies the start date or datetime of the stream.
  • :until - specifies the end date or datetime of the stream.

Examples

An infinite stream of Date structs for every Monday, Wednesday and Friday:

  iex> {:ok, stream} = Stream.new("FREQ=WEEKLY;BYDAY=MO,WE,FR", ~D[2019-01-01])
  ...> Enum.take(stream, 5)
  [
    ~D[2019-01-02],
    ~D[2019-01-04],
    ~D[2019-01-07],
    ~D[2019-01-09],
    ~D[2019-01-11]
  ]

A finite stream of NaiveDateTime using the :from and :until options:

  iex> opts = [from: ~N[2020-01-01 10:00:00], until: ~N[2020-06-01 10:00:00]]
  ...> {:ok, stream} = Stream.new("FREQ=MONTHLY;BYMONTHDAY=1", ~N[2019-01-01 10:00:00], opts)
  ...> Enum.to_list(stream)
  [
    ~N[2020-01-01 10:00:00],
    ~N[2020-02-01 10:00:00],
    ~N[2020-03-01 10:00:00],
    ~N[2020-04-01 10:00:00],
    ~N[2020-05-01 10:00:00]
  ]