View Source API Reference ex_cycle v0.7.2
Modules
This is mainly to create a struct introduces in Elixir v1.17.0 https://github.com/elixir-lang/elixir/blob/main/lib/elixir/lib/calendar/duration.ex
Representation of a RRule following RFC 5455 (not fully compatible for the moment).
Span
is used to generate datetime with a Rule that contain a Duration
.
When a duration
is specified, we must have a from
and a to
for every generated datetimes.
The ExCycle.State
represents the state of the next generated datetime.
Every Rules applies a list of validation to defined the next datetime.
DateExclusion defines a list of date or datetime to exclude from generated datetimes.
Days defines a list of day (day in the week, like monday, tuesday ...) to use in the generated time.
DaysOfMonth defines a list of day (number of the day in the month) to use in the generated datetime.
HourOfDay defines a list of specific hours to use in the generated datetime.
Interval is the base of RRule. Every Rule could be
The Lock
validation is used to lock a specific item like :day
.
So the generated datetime MUST have the valid datetime that match this restriction.
MinuteOfHour defines a list of specific minutes to use in the generated datetime.