summaryrefslogtreecommitdiff
path: root/stdlib/unit.mli
blob: e71f279a0a92348fce747309a92fc7040f445a6a (plain)
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
(**************************************************************************)
(*                                                                        *)
(*                                 OCaml                                  *)
(*                                                                        *)
(*                         The OCaml programmers                          *)
(*                                                                        *)
(*   Copyright 2018 Institut National de Recherche en Informatique et     *)
(*     en Automatique.                                                    *)
(*                                                                        *)
(*   All rights reserved.  This file is distributed under the terms of    *)
(*   the GNU Lesser General Public License version 2.1, with the          *)
(*   special exception on linking described in the file LICENSE.          *)
(*                                                                        *)
(**************************************************************************)

(** Unit values.

    @since 4.08 *)

(** {1:unit The unit type} *)

type t = unit = () (**)
(** The unit type.

    The constructor [()] is included here so that it has a path,
    but it is not intended to be used in user-defined data types.
 *)

val equal : t -> t -> bool
(** [equal u1 u2] is [true]. *)

val compare : t -> t -> int
(** [compare u1 u2] is [0]. *)

val to_string : t -> string
(** [to_string b] is ["()"]. *)