File: date.mli

package info (click to toggle)
xen-api-libs 0.5.2-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,940 kB
  • sloc: ml: 13,925; sh: 2,930; ansic: 1,699; makefile: 1,240; python: 83
file content (49 lines) | stat: -rw-r--r-- 1,719 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
(*
 * Copyright (C) 2006-2009 Citrix Systems Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; version 2.1 only. with the special
 * exception on linking described in file LICENSE.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *)
(** Additional types and functions for dates *)

(** {2 ISO 8601 Dates} *)

(** An ISO-8601 date/time type. *)
type iso8601

(** Convert calendar time [x] (as returned by e.g. Unix.time), to time in UTC. *)
val of_float : float -> iso8601

(** Convert date/time to a float value: the number of seconds since 00:00:00 UTC, 1 Jan 1970. *)
val to_float : iso8601 -> float

(** Convert date/time to an ISO 8601 formatted string. *)
val to_string : iso8601 -> string

(** Convert ISO 8601 formatted string to a date/time value. *)
val of_string : string -> iso8601

(** Raises an Invalid_argument exception if the given date is not a UTC date.
 *  A UTC date is an ISO 8601 strings that ends with the character 'Z'. *)
val assert_utc : iso8601 -> unit

(** Representation of the concept "never" (actually 00:00:00 UTC, 1 Jan 1970). *)
val never: iso8601

(** {2 RFC 822 Dates} *)

(** An RFC 822 date/time type. *)
type rfc822

(** Convert calendar time [x] (as returned by e.g. Unix.time), to RFC 822. *)
val rfc822_of_float : float -> rfc822

(** Convert RFC 822 date/time to a formatted string. *)
val rfc822_to_string : rfc822 -> string