Up

Module Day_of_week

For representing a day of the week.

Signature

type t =
| Sun
| Mon
| Tue
| Wed
| Thu
| Fri
| Sat
val t_of_sexp : Sexplib.Sexp.t -> t
val sexp_of_t : t -> Sexplib.Sexp.t
val compare : t -> t -> int
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot.Read.reader
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_writer_t : t Bin_prot.Type_class.writer
include Comparable.S_binable with type t := t
include Comparable_intf.S_common
include Comparable_intf.Polymorphic_compare
include Polymorphic_compare_intf.Infix
type t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~cmp:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

val clamp : t -> min:t -> max:t -> t Or_error.t
include Comparator.S with type t := t
type t
type comparator_witness
include Comparable_intf.Validate with type t := t
type t
val validate_lbound : min:t Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Maybe_bound.t -> t Validate.check
val validate_bound : min:t Maybe_bound.t -> max:t Maybe_bound.t -> t Validate.check
include Comparable_intf.Map_and_set_binable with type t := t with type comparator_witness := comparator_witness
type t
include Comparator.S with type t := t
type t
type comparator_witness
include Hashable.S_binable with type t := t
type t
val hash : t -> int
module Table : Hashable.Hashtbl.S_binable with type key = t
module Hash_set : Hash_set.S_binable with type elt = t
module Hash_queue : Hash_queue.S with type Key.t = t
include Stringable.S with type t := t
type t
val of_string : string -> t
val to_string : t -> string
val to_string_long : t -> string

Capitalized full day names rather than all-caps 3-letter abbreviations

val of_int_exn : int -> t

These use the same mapping as Unix.tm_wday: 0 <-> Sun, ... 6 <-> Sat

val of_int : int -> t option
val to_int : t -> int
val iso_8601_weekday_number : t -> int

As per ISO 8601, Mon->1, Tue->2, ... Sun->7

val shift : t -> int -> t

This goes forward (or backward) the specified number of weekdays

val num_days : from:t -> to_:t -> int

num_days ~from ~to_ gives the number of days that must elapse from a from to get to a to_, i.e. the smallest non-negative number i such that shift from i = to_.

val is_sun_or_sat : t -> bool
val all : t list
val weekdays : t list

Mon; Tue; Wed; Thu; Fri

val weekends : t list

Mon; Tue; Wed; Thu; Fri

Sat; Sun

module Stable : sig .. end