/usr/lib/ocaml/uuidm/uuidm.mli is in libuuidm-ocaml-dev 0.9.3-3build5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | (*----------------------------------------------------------------------------
Copyright (c) 2008, Daniel C. Bünzli. All rights reserved.
Distributed under a BSD license, see license at the end of the file.
Uuidm version 0.9.3
----------------------------------------------------------------------------*)
(** Universally unique identifiers.
Uuidm implements 128 bits universally unique identifiers version
3, 5 (name based with MD5, SHA-1 hashing) and 4 (random based)
according to {{:http://www.ietf.org/rfc/rfc4122.txt}RFC 4122}.
Random numbers are generated using OCaml's [Random] module with a
private state initialized by [Random.State.make_self_init].
{e Version 0.9.3 - daniel.buenzl i\@erratique.ch }
{b References}
P. Leach et al.
{e {{:http://www.ietf.org/rfc/rfc4122.txt}A universally unique identifier
(UUID) URN Namespace}}, 2005.
{1:top }
*)
type t
(** The type for UUIDs. *)
type version = [
| `V3 of t * string (** Name based with MD5 hashing *)
| `V4 (** Random based. *)
| `V5 of t * string (** Name based with SHA-1 hasing. *) ]
(** The type for UUID versions and generation parameters. [`V3] and [`V5]
specify a namespace and a name for the generation. *)
val nil : t
(** [nil] is the nil UUID. *)
val ns_dns : t
(** [ns_dns] is the DNS namespace UUID. *)
val ns_url : t
(** [ns_url] is the URL namespace UUID. *)
val ns_oid : t
(** [ns_oid] is the ISO OID namespace UUID. *)
val ns_X500 : t
(** [ns_dn] is the X.500 DN namespace UUID. *)
val create : version -> t
(** [create version] is an UUID of the given [version]. *)
val compare : t -> t -> int
(** Total order on UUIDs. *)
val equal : t -> t -> bool
(** [equal u u'] is [true] iff [u] and [u'] are equal. *)
val of_bytes : ?pos:int -> string -> t option
(** [of_bytes pos s] is the UUID represented by the 16 bytes starting
at [pos] in [s] ([pos] defaults to [0]). Returns [None] if the
string is not long enough. *)
val to_bytes : t -> string
(** [to_bytes u] is [u] as a 16 bytes long string. *)
(**/**)
val unsafe_to_bytes : t -> string
(**/**)
val of_string : ?pos:int -> string -> t option
(** [of_string pos s] converts the substring of [s] starting at [pos]
(defaults to [0]) of the form ["XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"]
where X is a lower or upper case hexadecimal number to an
UUID. Returns [None] if a parse error occured. *)
val to_string : ?upper:bool -> t -> string
(** [to_string u] is [u] as a string of the form
["XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"] where X is
a lower case hexadecimal number (or upper if [upper] is
[true]). *)
val print : ?upper:bool -> Format.formatter -> t -> unit
(** See {!to_string}. *)
(*----------------------------------------------------------------------------
Copyright (c) 2008, Daniel C. Bünzli
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the
distribution.
3. Neither the name of the Daniel C. Bünzli nor the names of
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
----------------------------------------------------------------------------*)
|