package core

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Core.MonthSource

Provides a variant type for representing months (e.g., Jan, Feb, or Nov) and functions for converting them to other formats (like an int).

Sourcetype t =
  1. | Jan
  2. | Feb
  3. | Mar
  4. | Apr
  5. | May
  6. | Jun
  7. | Jul
  8. | Aug
  9. | Sep
  10. | Oct
  11. | Nov
  12. | Dec
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

Sourceval bin_shape_t : Bin_prot.Shape.t
include Ppx_hash_lib.Hashable.S with type t := t
include Ppx_compare_lib.Equal.S with type t := t
include Ppx_quickcheck_runtime.Quickcheckable.S with type t := t
Sourceval quickcheck_generator : t Base_quickcheck.Generator.t
Sourceval quickcheck_observer : t Base_quickcheck.Observer.t
Sourceval quickcheck_shrinker : t Base_quickcheck.Shrinker.t
include Sexplib0.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval jan : t
Sourceval feb : t
Sourceval mar : t
Sourceval apr : t
Sourceval may : t
Sourceval jun : t
Sourceval jul : t
Sourceval aug : t
Sourceval sep : t
Sourceval oct : t
Sourceval nov : t
Sourceval dec : t
Sourceval is_jan : t -> Base.Bool.t
Sourceval is_feb : t -> Base.Bool.t
Sourceval is_mar : t -> Base.Bool.t
Sourceval is_apr : t -> Base.Bool.t
Sourceval is_may : t -> Base.Bool.t
Sourceval is_jun : t -> Base.Bool.t
Sourceval is_jul : t -> Base.Bool.t
Sourceval is_aug : t -> Base.Bool.t
Sourceval is_sep : t -> Base.Bool.t
Sourceval is_oct : t -> Base.Bool.t
Sourceval is_nov : t -> Base.Bool.t
Sourceval is_dec : t -> Base.Bool.t
Sourcemodule Variants : sig ... end
include Comparable.S_binable with type t := t
include Base.Comparable.S with type t := t
include Base.Comparisons.S with type t := t
include Base.Comparisons.Infix with type t := t
Sourceval (>=) : t -> t -> bool
Sourceval (<=) : t -> t -> bool
Sourceval (=) : t -> t -> bool
Sourceval (>) : t -> t -> bool
Sourceval (<) : t -> t -> bool
Sourceval (<>) : t -> t -> bool
Sourceval equal : t -> t -> bool
Sourceval compare : t -> t -> int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

Sourceval min : t -> t -> t
Sourceval max : t -> t -> t
Sourceval 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 ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

Sourceval descending : t -> t -> int
Sourceval between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

Sourceval 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).

Sourceval clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t
type comparator_witness
Sourceval validate_lbound : min:t Maybe_bound.t -> t Validate.check
Sourceval validate_ubound : max:t Maybe_bound.t -> t Validate.check
Sourceval validate_bound : min:t Maybe_bound.t -> max:t Maybe_bound.t -> t Validate.check
include Hashable.S_binable with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
Sourceval hashable : t Base.Hashable.t
Sourcemodule Table : Hashtbl.S_binable with type key = t
Sourcemodule Hash_set : Hash_set.S_binable with type elt = t
Sourcemodule Hash_queue : Hash_queue.S with type key = t

of_string s accepts three-character abbreviations with three capitalizations (e.g. Jan, JAN, and jan).

include Base.Stringable.S with type t := t
Sourceval of_string : string -> t
Sourceval to_string : t -> string

of_int i returns the ith month if i is in 1, 2, ... , 12. Otherwise it returns None.

Sourceval of_int_exn : Base.Int.t -> t
Sourceval to_int : t -> Base.Int.t

to_int t returns an int in 1, 2, ... 12.

Sourceval shift : t -> Base.Int.t -> t

shift t i goes forward (or backward) the specified number of months.

Sourcemodule Export : sig ... end
Sourcemodule Stable : sig ... end
OCaml

Innovation. Community. Security.