package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type

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

type 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
val bin_size_t : t Bin_prot__.Size.sizer
val bin_write_t : t Bin_prot__.Write.writer
val bin_read_t : t Bin_prot__.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot__.Read.reader
val bin_shape_t : Bin_prot__.Shape.t
val bin_writer_t : t Bin_prot__.Type_class.writer
val bin_reader_t : t Bin_prot__.Type_class.reader
val bin_t : t Bin_prot__.Type_class.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
val quickcheck_generator : t Base_quickcheck.Generator.t
val quickcheck_observer : t Base_quickcheck.Observer.t
val quickcheck_shrinker : t Base_quickcheck.Shrinker.t
include Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0__.Sexp.t -> t
val sexp_of_t : t -> Sexplib0__.Sexp.t
val t_sexp_grammar : t Sexplib0.Sexp_grammar.t
val jan : t
val feb : t
val mar : t
val apr : t
val may : t
val jun : t
val jul : t
val aug : t
val sep : t
val oct : t
val nov : t
val dec : t
val is_jan : t -> Base.Bool.t
val is_feb : t -> Base.Bool.t
val is_mar : t -> Base.Bool.t
val is_apr : t -> Base.Bool.t
val is_may : t -> Base.Bool.t
val is_jun : t -> Base.Bool.t
val is_jul : t -> Base.Bool.t
val is_aug : t -> Base.Bool.t
val is_sep : t -> Base.Bool.t
val is_oct : t -> Base.Bool.t
val is_nov : t -> Base.Bool.t
val is_dec : t -> Base.Bool.t
val jan_val : t -> Base.Unit.t Base.Option.t
val feb_val : t -> Base.Unit.t Base.Option.t
val mar_val : t -> Base.Unit.t Base.Option.t
val apr_val : t -> Base.Unit.t Base.Option.t
val may_val : t -> Base.Unit.t Base.Option.t
val jun_val : t -> Base.Unit.t Base.Option.t
val jul_val : t -> Base.Unit.t Base.Option.t
val aug_val : t -> Base.Unit.t Base.Option.t
val sep_val : t -> Base.Unit.t Base.Option.t
val oct_val : t -> Base.Unit.t Base.Option.t
val nov_val : t -> Base.Unit.t Base.Option.t
val dec_val : t -> Base.Unit.t Base.Option.t
module Variants : sig ... end
include Comparable.S_binable with type t := t
include Base.Comparable.S with type t := 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
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
type comparator_witness
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
module Replace_polymorphic_compare : sig ... end
include Comparator.S with type t := t with type comparator_witness := comparator_witness
include Hashable.S_binable with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
val hash_fold_t : t Base__Ppx_hash_lib.hash_fold
val hash : t -> Base__Ppx_hash_lib.Std.Hash.hash_value
val hashable : t Core__.Hashtbl.Hashable.t
module Table : 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

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

val of_string : string -> t
val to_string : t -> string
val all : t Base.List.t
val of_int : Base.Int.t -> t Base.Option.t

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

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

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

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

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

module Export : sig ... end
module Stable : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct