package yocaml

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Types
1. Aliases
API

package yocaml

yocaml
- Yocaml
  - Build
    
    Infix
  - Date
  - Deps
    
    Monoid
    
    Infix
    
    Writer
    
    Infix
    
    Monad
    
    Infix
    
    Syntax
    
    Syntax
  - Effect
    
    Applicative
    
    Infix
    
    Syntax
    
    Freer
    
    Applicative
    
    Infix
    
    Syntax
    
    Functor
    
    Infix
    
    Infix
    
    Monad
    
    Infix
    
    Syntax
    
    Selective
    
    Infix
    
    Syntax
    
    Syntax
    
    To_monad
    
    Monad
    
    Functor
    
    Infix
    
    Infix
    
    Monad
    
    Infix
    
    Syntax
    
    Selective
    
    Infix
    
    Syntax
    
    Syntax
    
    To_monad
    
    Monad
    
    Traverse
  - Error
  - Filepath
  - Key_value
    
    DESCRIBABLE
    
    Jsonm_descriptor
    
    Jsonm_object
    
    Jsonm_validator
    
    Make_validator
    
    KV
    
    VALIDABLE
    
    VALIDATOR
  - Languages
    
    ISO639
  - Lexicon
  - Log
  - Metadata
    
    Article
    
    Articles
    
    Date
    
    INJECTABLE
    
    Page
    
    READABLE
    
    RENDERABLE
    
    VALIDABLE
  - Mime
  - Rss
    
    Category
    
    Channel
    
    Cloud
    
    Enclosure
    
    Guid
    
    Image
    
    Item
    
    Source
  - Runtime
    
    Make
    
    R
    
    RUNTIME
  - Try
    
    Applicative
    
    Infix
    
    Syntax
    
    Traversable
    
    A
    
    Infix
    
    Syntax
    
    Functor
    
    Infix
    
    Infix
    
    Monad
    
    Infix
    
    Syntax
    
    Traversable
    
    M
    
    Infix
    
    Syntax
    
    Syntax
  - Util
  - Validate
    
    Alt
    
    Infix
    
    Applicative
    
    Infix
    
    Syntax
    
    Traversable
    
    A
    
    Infix
    
    Syntax
    
    Functor
    
    Infix
    
    Infix
    
    Monad
    
    Infix
    
    Syntax
    
    Traversable
    
    M
    
    Infix
    
    Syntax
    
    Selective
    
    Infix
    
    Syntax
    
    Syntax

Legend:
Library
Module
Module type
Parameter
Class
Class type

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

Types

type t

Describes a complete date.

type month =

| Jan
| Feb
| Mar
| Apr
| May
| Jun
| Jul
| Aug
| Sep
| Oct
| Nov
| Dec

Months.

Aliases

Useful aliases for making the doc readable.

type year = int

type day = int

type hour = int

type min = int

type sec = int

type day_of_week =

| Mon
| Tue
| Wed
| Thu
| Fri
| Sat
| Sun

Day of Week

API

val 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.

val from_string : string -> t Validate.t

Comparison and equality

val equal : t -> t -> bool

val compare : t -> t -> int

Pretty Printing

val pp : Stdlib.Format.formatter -> t -> unit

val to_string : t -> string

val pp_rfc822 : 
  ?default_time:(hour * min * sec) ->
  Stdlib.Format.formatter ->
  t ->
  unit

Retreive information

val to_pair : t -> (year * month * day) * (hour * min * sec) option

val month_to_int : month -> int

Starts at 1.

val month_to_string : month -> string

Date.month_to_string Dec is equal to "Dec".

val day_of_week : t -> day_of_week

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

val day_of_week_to_string : day_of_week -> string