package yocaml

  1. Overview
  2. Docs

Module Yocaml.DateSource

Describes date (supposing naively that everything is in UTC).

Types

Sourcetype t

Describes a complete date.

Sourcetype month =
  1. | Jan
  2. | Feb
  3. | Mar
  4. | Apr
  5. | May
  6. | Jun
  7. | Jul
  8. | Aug
  9. | Sep
  10. | Oct
  11. | Nov
  12. | Dec

Months.

Aliases

Useful aliases for making the doc readable.

Sourcetype year = int
Sourcetype day = int
Sourcetype hour = int
Sourcetype min = int
Sourcetype sec = int
Sourcetype day_of_week =
  1. | Mon
  2. | Tue
  3. | Wed
  4. | Thu
  5. | Fri
  6. | Sat
  7. | Sun

Day of Week

API

Sourceval make : ?time:(hour * min * sec) -> year -> month -> day -> t Validate.t

Date.make ~time:(hour, min, sec) year month day tries to create a Date.t.

Sourceval from_string : string -> t Validate.t

Comparison and equality

Sourceval equal : t -> t -> bool
Sourceval compare : t -> t -> int

Pretty Printing

Sourceval pp : Format.formatter -> t -> unit
Sourceval to_string : t -> string
Sourceval pp_rfc822 : ?default_time:(hour * min * sec) -> Format.formatter -> t -> unit

Retreive information

Sourceval to_pair : t -> (year * month * day) * (hour * min * sec) option
Sourceval month_to_int : month -> int

Starts at 1.

Sourceval month_to_string : month -> string

Date.month_to_string Dec is equal to "Dec".

Sourceval day_of_week : t -> day_of_week

A Fragile function which seems works at least for 1600 and to 3000 :)

Sourceval day_of_week_to_string : day_of_week -> string