Deprecated version of Schedule, which defines a type for schedules like "every 5 min after the hour" or "every weekday at 3pm."
Overview
This version of Schedule has been superceded by V5. In normal circumstances this would just be a version bump to the Stable type, but the newer version of Schedule has more expressive power and there are schedules that can't be expressed or serialized using the V4 serializer available in this deprecated module. Programs are encouraged to upgrade as quickly as reasonably possible.
A Schedule.t describes a (potentially repeating) schedule by selecting a subset of all seconds using the set operations in t. For example:
9:30 am on weekends, and 5 am on weekdays
Or
[ And
[ Weekdays [ Sat; Sun ]
; At [ Time.Ofday.create ~hr:9 ~min:30 () ] ]
; And
[ Weekdays [ Mon; Tue; Wed; Thu; Fri ]
; At [ Time.Ofday.create ~hr:5 () ] ]
]
On top of this selection language there are two labeling branches of the variant that are important.
In_zone (zone, t) expresses that all of t should be evaluated relative to the time zone given.
Tag (tag, t) tags anything matching t with tag.
Combining these we can express something complex like the on-call groups across three offices:
let weekdays = Weekdays Day_of_week.weekdays in
let working_hours = Between Time.Ofday.((create ~hr:8 (), create ~hr:18 ())) in
let working_schedule = And [ weekdays; working_hours ] in
let offices =
let (!!) = Time.Zone.find_exn in
Location.Abbrev.([
tot, !!"America/New_York"
; hkg, !!"Asia/Hong_Kong"
; ldn, !!"Europe/London" ])
in
List.map offices ~f:(fun (office, zone) ->
In_zone (zone, Tag (office, working_schedule)))
after which we can use the tags function to extract the groups on call at any moment.
Daylight Savings Time
Schedules are expressed in terms of wall clock time, and as such have interesting behavior around daylight savings time boundaries. There are two circumstances that might affect a schedule. The first is a repeated time, which occurs when time jumps back (e.g. 2:30 may happen twice in one day). The second is a skipped time, which occurs when time jumps forward by an hour.
In both cases Schedule does the naive thing. If the time happens twice and is included in the schedule it is included twice. If it never happens Schedule makes no special attempt to artificially include it.
Interface
these phantom types are concrete and exposed to help the compiler understand that zoned and unzoned cannot be the same type (which it could not know if they were abstract), which helps it infer the injectivity of the type t below.
'a indicates whether the schedule currently has an established zone.
'b is the type of the tag used in this schedule. In many cases it can be unspecified. See tags for more.
Between (a, b) is the empty set if a > b.
Items that take int lists silently ignore ints outside of the viable range. E.g. Days [32] will never occur.
type ('a, 'b) t = | Tag : 'b * ('a, 'b) t -> ('a, 'b) t| And : ('a, 'b) t list -> ('a, 'b) t| Or : ('a, 'b) t list -> ('a, 'b) t| Not : ('a, 'b) t -> ('a, 'b) t| If_then_else : (('a, 'b) t * ('a, 'b) t * ('a, 'b) t) -> ('a, 'b) t| Shift : Core_kernel.Core_kernel_private.Time_float0.Span.t
* ('a, 'b) t -> ('a, 'b) t| Between : (Inclusive_exclusive.t
* Core_kernel.Core_kernel_private.Time_float0.underlying)
* (Inclusive_exclusive.t
* Core_kernel.Core_kernel_private.Time_float0.underlying) -> (unzoned, 'b)
t| At : Core_kernel.Core_kernel_private.Time_float0.underlying list -> (unzoned,
'b)
t| Secs : int list -> (unzoned, 'b) t| Mins : int list -> (unzoned, 'b) t| Hours : int list -> (unzoned, 'b) t| Weekdays : Core_kernel.Day_of_week.t list -> (unzoned, 'b) t| Days : int list -> (unzoned, 'b) t| Weeks : int list -> (unzoned, 'b) t| Months : Core_kernel.Month.t list -> (unzoned, 'b) t| Always : ('a, 'b) t| Never : ('a, 'b) t
val compare :
('a -> 'a -> int) ->
('b -> 'b -> int) ->
('a, 'b) t ->
('a, 'b) t ->
inttype 'b zoned_t = (zoned, 'b) tval sexp_of_zoned_t :
('b -> Ppx_sexp_conv_lib.Sexp.t) ->
'b zoned_t ->
Ppx_sexp_conv_lib.Sexp.tval to_string_zoned : (zoned, 'b) t -> string_of_tag:('b -> string) -> stringReturn a string suitable for debugging purposes.
includes t time is true if the second represented by time falls within the schedule t.
tags t time = `Not_included iff not (includes t time). Otherwise, tags t time
= `Included lst , where lst includes all tags of a schedule such that includes t'
time is true where t' is a tagged branch of the schedule. E.g. for some t equal to Tag some_tag t', tags t time will return some_tag if and only if includes t'
time returns true. For a more interesting use case, consider the per-office on-call schedule example given in the beginning of this module. Note that a schdeule may have no tags, and therefore, lst can be empty.
fold_tags t ~init ~f time is nearly behaviorally equivalent to (but more efficient than) List.fold ~init ~f (tags t time), with the exception that it returns None if includes t time is false. It is important that f be pure, as its results may be discarded.
Return a sequence of schedule changes over time that will never end.
If your schedules ends, you will continue to receive `No_change_until_at_least with increasing times forever.
The return type indicates whether includes t start_time is true and delivers a sequence of subsequent changes over time.
The times returned by the sequence are strictly increasing and never less than start_time. That is, `No_change_until_at_least x can never be followed by `Enter x, only by (at least) `Enter (x + 1s).
if emit is set to Transitions_and_tag_changes then all changes in tags will be present in the resulting sequence. Otherwise only the tags in effect when a schedule is entered are available.
The `In_range | `Out_of_range flag in `No_change_until_at_least indicates whether the covered range is entirely within, or outside of the time covered by the schedule and is only there to help with bookkeeping for the caller. `In_range | `Out_of_range will never disagree with what could be inferred from the `Enter and `Leave events.
The sequence takes care to do only a small amount of work between each element, so that pulling the next element of the sequence is always cheap. This is the primary motivation behind including `No_change_until_at_least.
The Time.t returned by `No_change_until_at_least is guaranteed to be a reasonable amount of time in the future (at least 1 hour).
module Event : sig ... endin Transitions_and_tag_changes equality for the tag type must be given
next_enter_between t start end The given start end range is inclusive on both ends. This function is useful for one-off events during the run of a program. If you want to track changes to a schedule over time it is better to call to_endless_sequence
as next_enter_between but for leave events