diff --git a/ambient-context/Ambient_context_core/Ambient_context_hmap/Key/index.html b/ambient-context/Ambient_context_core/Ambient_context_hmap/Key/index.html deleted file mode 100644 index 56acbd35..00000000 --- a/ambient-context/Ambient_context_core/Ambient_context_hmap/Key/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Key (ambient-context.Ambient_context_core.Ambient_context_hmap.Key)

Module Ambient_context_hmap.Key

type 'a info = unit
val create : 'a info -> 'a key
val info : 'a key -> 'a info
type t
val hide_type : 'a key -> t
val equal : t -> t -> bool
val compare : t -> t -> int
diff --git a/ambient-context/Ambient_context_core/Ambient_context_hmap/Make/Key/index.html b/ambient-context/Ambient_context_core/Ambient_context_hmap/Make/Key/index.html deleted file mode 100644 index 10cfc28e..00000000 --- a/ambient-context/Ambient_context_core/Ambient_context_hmap/Make/Key/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Key (ambient-context.Ambient_context_core.Ambient_context_hmap.Make.Key)

Module Make.Key

type 'a info = 'a Key_info.t
val create : 'a info -> 'a key
val info : 'a key -> 'a info
type t
val hide_type : 'a key -> t
val equal : t -> t -> bool
val compare : t -> t -> int
diff --git a/ambient-context/Ambient_context_core/Ambient_context_hmap/Make/argument-1-Key_info/index.html b/ambient-context/Ambient_context_core/Ambient_context_hmap/Make/argument-1-Key_info/index.html deleted file mode 100644 index 1da3b853..00000000 --- a/ambient-context/Ambient_context_core/Ambient_context_hmap/Make/argument-1-Key_info/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Key_info (ambient-context.Ambient_context_core.Ambient_context_hmap.Make.Key_info)

Parameter Make.Key_info

type 'a t
diff --git a/ambient-context/Ambient_context_core/Ambient_context_hmap/Make/index.html b/ambient-context/Ambient_context_core/Ambient_context_hmap/Make/index.html deleted file mode 100644 index 048ce1da..00000000 --- a/ambient-context/Ambient_context_core/Ambient_context_hmap/Make/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Make (ambient-context.Ambient_context_core.Ambient_context_hmap.Make)

Module Ambient_context_hmap.Make

Parameters

Signature

type 'a key
module Key : sig ... end
type t
val empty : t
val is_empty : t -> bool
val mem : 'a key -> t -> bool
val add : 'a key -> 'a -> t -> t
val singleton : 'a key -> 'a -> t
val rem : 'a key -> t -> t
val find : 'a key -> t -> 'a option
val get : 'a key -> t -> 'a
type binding =
  1. | B : 'a key * 'a -> binding
val iter : (binding -> unit) -> t -> unit
val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (binding -> bool) -> t -> bool
val exists : (binding -> bool) -> t -> bool
val filter : (binding -> bool) -> t -> t
val cardinal : t -> int
val any_binding : t -> binding option
val get_any_binding : t -> binding
diff --git a/ambient-context/Ambient_context_core/Ambient_context_hmap/Tid/index.html b/ambient-context/Ambient_context_core/Ambient_context_hmap/Tid/index.html deleted file mode 100644 index 94b448aa..00000000 --- a/ambient-context/Ambient_context_core/Ambient_context_hmap/Tid/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Tid (ambient-context.Ambient_context_core.Ambient_context_hmap.Tid)

Module Ambient_context_hmap.Tid

type _ t = ..
diff --git a/ambient-context/Ambient_context_core/Ambient_context_hmap/index.html b/ambient-context/Ambient_context_core/Ambient_context_hmap/index.html index 24a817bf..0cf976d0 100644 --- a/ambient-context/Ambient_context_core/Ambient_context_hmap/index.html +++ b/ambient-context/Ambient_context_core/Ambient_context_hmap/index.html @@ -1,2 +1,2 @@ -Ambient_context_hmap (ambient-context.Ambient_context_core.Ambient_context_hmap)

Module Ambient_context_core.Ambient_context_hmap

module Tid : sig ... end
module type Tid = sig ... end
type 'a tid = (module Tid with type t = 'a)
val tid : unit -> (module Tid with type t = 's)
type ('a, 'b) teq =
  1. | Teq : ('a, 'a) teq
val eq : 'r 's. 'r tid -> 's tid -> ('r, 's) teq option
module type KEY_INFO = sig ... end
module type S = sig ... end
module Make (Key_info : KEY_INFO) : S with type 'a Key.info = 'a Key_info.t
include sig ... end
type 'a key
module Key : sig ... end
type t
val empty : t
val is_empty : t -> bool
val mem : 'a key -> t -> bool
val add : 'a key -> 'a -> t -> t
val singleton : 'a key -> 'a -> t
val rem : 'a key -> t -> t
val find : 'a key -> t -> 'a option
val get : 'a key -> t -> 'a
type binding =
  1. | B : 'a key * 'a0 -> binding
val iter : (binding -> unit) -> t -> unit
val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (binding -> bool) -> t -> bool
val exists : (binding -> bool) -> t -> bool
val filter : (binding -> bool) -> t -> t
val cardinal : t -> int
val any_binding : t -> binding option
val get_any_binding : t -> binding
+Ambient_context_hmap (ambient-context.Ambient_context_core.Ambient_context_hmap)

Module Ambient_context_core.Ambient_context_hmap

include module type of struct include Hmap end

Keys

type 'a key = 'a Hmap.key

The type for keys whose lookup value is of type 'a.

module Key = Hmap.Key

Keys.

Maps

type t = Hmap.t

The type for heterogeneous value maps.

val empty : t

empty is the empty map.

val is_empty : t -> bool

is_empty m is true iff m is empty.

val mem : 'a key -> t -> bool

mem k m is true iff k is bound in m.

val add : 'a key -> 'a -> t -> t

add k v m is m with k bound to v.

val singleton : 'a key -> 'a -> t

singleton k v is add k v empty.

val rem : 'a key -> t -> t

rem k m is m with k unbound.

val find : 'a key -> t -> 'a option

find k m is the value of k's binding in m, if any.

val get : 'a key -> t -> 'a

get k m is the value of k's binding in m.

  • raises Invalid_argument

    if k is not bound in m.

type binding = Hmap.binding =
  1. | B : 'a key * 'a -> binding

The type for bindings.

val iter : (binding -> unit) -> t -> unit

iter f m applies f to all bindings of m.

val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a

fold f m acc folds over the bindings of m with f, starting with acc

val for_all : (binding -> bool) -> t -> bool

for_all p m is true iff all bindings of m satisfy p.

val exists : (binding -> bool) -> t -> bool

exists p m is true iff there exists a bindings of m that satisfies p.

val filter : (binding -> bool) -> t -> t

filter p m are the bindings of m that satisfy p.

val cardinal : t -> int

cardinal m is the number of bindings in m.

val any_binding : t -> binding option

any_binding m is a binding of m (if not empty).

val get_any_binding : t -> binding

get_any_binding m is a binding of m.

  • raises Invalid_argument

    if m is empty.

Functorial interface

The functorial interface allows to associate more information to the keys. For example a key name or a key value pretty-printer.

module type KEY_INFO = Hmap.KEY_INFO

The type for key information.

module type S = Hmap.S

Output signature of the functor Make

module Make = Hmap.Make

Functor for heterogeneous maps whose keys hold information of type Key_info.t

diff --git a/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-KEY_INFO/index.html b/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-KEY_INFO/index.html deleted file mode 100644 index b8acb147..00000000 --- a/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-KEY_INFO/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -KEY_INFO (ambient-context.Ambient_context_core.Ambient_context_hmap.KEY_INFO)

Module type Ambient_context_hmap.KEY_INFO

type 'a t
diff --git a/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-S/Key/index.html b/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-S/Key/index.html deleted file mode 100644 index 8060be9a..00000000 --- a/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-S/Key/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Key (ambient-context.Ambient_context_core.Ambient_context_hmap.S.Key)

Module S.Key

type 'a info
val create : 'a info -> 'a key
val info : 'a key -> 'a info
type t
val hide_type : 'a key -> t
val equal : t -> t -> bool
val compare : t -> t -> int
diff --git a/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-S/index.html b/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-S/index.html deleted file mode 100644 index 9eab5208..00000000 --- a/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-S/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -S (ambient-context.Ambient_context_core.Ambient_context_hmap.S)

Module type Ambient_context_hmap.S

type 'a key
module Key : sig ... end
type t
val empty : t
val is_empty : t -> bool
val mem : 'a key -> t -> bool
val add : 'a key -> 'a -> t -> t
val singleton : 'a key -> 'a -> t
val rem : 'a key -> t -> t
val find : 'a key -> t -> 'a option
val get : 'a key -> t -> 'a
type binding =
  1. | B : 'a key * 'a -> binding
val iter : (binding -> unit) -> t -> unit
val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (binding -> bool) -> t -> bool
val exists : (binding -> bool) -> t -> bool
val filter : (binding -> bool) -> t -> t
val cardinal : t -> int
val any_binding : t -> binding option
val get_any_binding : t -> binding
diff --git a/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-Tid/index.html b/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-Tid/index.html deleted file mode 100644 index 2134f92f..00000000 --- a/ambient-context/Ambient_context_core/Ambient_context_hmap/module-type-Tid/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Tid (ambient-context.Ambient_context_core.Ambient_context_hmap.Tid)

Module type Ambient_context_hmap.Tid

type t
type Tid.t +=
  1. | Tid : t Tid.t
diff --git a/ambient-context/Ambient_context_tls/M/index.html b/ambient-context/Ambient_context_tls/M/index.html index bc1e329a..8aabfe56 100644 --- a/ambient-context/Ambient_context_tls/M/index.html +++ b/ambient-context/Ambient_context_tls/M/index.html @@ -1,4 +1,2 @@ -M (ambient-context.Ambient_context_tls.M)

Module Ambient_context_tls.M

val name : string
val get_map : unit -> Hmap.t option
val with_map : Hmap.t -> (unit -> 'a) -> 'b
val create_key : - 'a Hmap.Key.info -> - 'a Ambient_context_core__Ambient_context_hmap.key
val get : 'a Hmap.key -> 'b option
val with_binding : 'a Hmap.key -> 'b -> (unit -> 'c) -> 'd
val without_binding : 'a Hmap.key -> (unit -> 'b) -> 'c
+M (ambient-context.Ambient_context_tls.M)

Module Ambient_context_tls.M

val name : string
val get_map : unit -> Hmap.t option
val with_map : Hmap.t -> (unit -> 'a) -> 'b
val create_key : unit -> 'a Hmap.key
val get : 'a Hmap.key -> 'b option
val with_binding : 'a Hmap.key -> 'b -> (unit -> 'c) -> 'd
val without_binding : 'a Hmap.key -> (unit -> 'b) -> 'c
diff --git a/hmap/Hmap/Key/index.html b/hmap/Hmap/Key/index.html new file mode 100644 index 00000000..9a182a4d --- /dev/null +++ b/hmap/Hmap/Key/index.html @@ -0,0 +1,2 @@ + +Key (hmap.Hmap.Key)

Module Hmap.Key

Keys.

Keys

val create : unit -> 'a key

create () is a new key.

Existential keys

Exisential keys allows to compare keys. This can be useful for functions like filter.

type t

The type for existential keys.

val hide_type : 'a key -> t

hide_type k is an existential key for k.

val equal : t -> t -> bool

equal k k' is true iff k and k' are the same key.

val compare : t -> t -> int

compare k k' is a total order on keys compatible with equal.

diff --git a/hmap/Hmap/Make/Key/index.html b/hmap/Hmap/Make/Key/index.html new file mode 100644 index 00000000..44bfb6d7 --- /dev/null +++ b/hmap/Hmap/Make/Key/index.html @@ -0,0 +1,2 @@ + +Key (hmap.Hmap.Make.Key)

Module Make.Key

Keys.

Keys

type 'a info = 'a Key_info.t

The type for key information.

val create : 'a info -> 'a key

create i is a new key with information i.

val info : 'a key -> 'a info

info k is k's information.

Existential keys

Exisential keys allow to compare keys. This can be useful for functions like filter.

type t

The type for existential keys.

val hide_type : 'a key -> t

hide_type k is an existential key for k.

val equal : t -> t -> bool

equal k k' is true iff k and k' are the same key.

val compare : t -> t -> int

compare k k' is a total order on keys compatible with equal.

diff --git a/hmap/Hmap/Make/argument-1-Key_info/index.html b/hmap/Hmap/Make/argument-1-Key_info/index.html new file mode 100644 index 00000000..4a4e1de6 --- /dev/null +++ b/hmap/Hmap/Make/argument-1-Key_info/index.html @@ -0,0 +1,2 @@ + +Key_info (hmap.Hmap.Make.Key_info)

Parameter Make.Key_info

type 'a t

The type for key information.

diff --git a/hmap/Hmap/Make/index.html b/hmap/Hmap/Make/index.html new file mode 100644 index 00000000..9b512b43 --- /dev/null +++ b/hmap/Hmap/Make/index.html @@ -0,0 +1,2 @@ + +Make (hmap.Hmap.Make)

Module Hmap.Make

Functor for heterogeneous maps whose keys hold information of type Key_info.t

Parameters

Signature

Keys

type 'a key

The type for keys whose lookup value is of type 'a.

module Key : sig ... end

Keys.

Maps

type t

The type for heterogeneous value maps.

val empty : t

empty is the empty map.

val is_empty : t -> bool

is_empty m is true iff m is empty.

val mem : 'a key -> t -> bool

mem k m is true iff k is bound in m.

val add : 'a key -> 'a -> t -> t

add k v m is m with k bound to v.

val singleton : 'a key -> 'a -> t

singleton k v is add k v empty.

val rem : 'a key -> t -> t

rem k m is m with k unbound.

val find : 'a key -> t -> 'a option

find k m is the value of k's binding in m, if any.

val get : 'a key -> t -> 'a

get k m is the value of k's binding in m.

  • raises Invalid_argument

    if k is not bound in m.

type binding =
  1. | B : 'a key * 'a -> binding

The type for bindings.

val iter : (binding -> unit) -> t -> unit

iter f m applies f to all bindings of m.

val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a

fold f m acc folds over the bindings of m with f, starting with acc

val for_all : (binding -> bool) -> t -> bool

for_all p m is true iff all bindings of m satisfy p.

val exists : (binding -> bool) -> t -> bool

exists p m is true iff there exists a bindings of m that satisfies p.

val filter : (binding -> bool) -> t -> t

filter p m are the bindings of m that satisfy p.

val cardinal : t -> int

cardinal m is the number of bindings in m.

val any_binding : t -> binding option

any_binding m is a binding of m (if not empty).

val get_any_binding : t -> binding

get_any_binding m is a binding of m.

  • raises Invalid_argument

    if m is empty.

diff --git a/hmap/Hmap/index.html b/hmap/Hmap/index.html new file mode 100644 index 00000000..750002b7 --- /dev/null +++ b/hmap/Hmap/index.html @@ -0,0 +1,2 @@ + +Hmap (hmap.Hmap)

Module Hmap

Heterogeneous value maps.

v0.8.1 - homepage

Keys

type 'a key

The type for keys whose lookup value is of type 'a.

module Key : sig ... end

Keys.

Maps

type t

The type for heterogeneous value maps.

val empty : t

empty is the empty map.

val is_empty : t -> bool

is_empty m is true iff m is empty.

val mem : 'a key -> t -> bool

mem k m is true iff k is bound in m.

val add : 'a key -> 'a -> t -> t

add k v m is m with k bound to v.

val singleton : 'a key -> 'a -> t

singleton k v is add k v empty.

val rem : 'a key -> t -> t

rem k m is m with k unbound.

val find : 'a key -> t -> 'a option

find k m is the value of k's binding in m, if any.

val get : 'a key -> t -> 'a

get k m is the value of k's binding in m.

  • raises Invalid_argument

    if k is not bound in m.

type binding =
  1. | B : 'a key * 'a -> binding

The type for bindings.

val iter : (binding -> unit) -> t -> unit

iter f m applies f to all bindings of m.

val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a

fold f m acc folds over the bindings of m with f, starting with acc

val for_all : (binding -> bool) -> t -> bool

for_all p m is true iff all bindings of m satisfy p.

val exists : (binding -> bool) -> t -> bool

exists p m is true iff there exists a bindings of m that satisfies p.

val filter : (binding -> bool) -> t -> t

filter p m are the bindings of m that satisfy p.

val cardinal : t -> int

cardinal m is the number of bindings in m.

val any_binding : t -> binding option

any_binding m is a binding of m (if not empty).

val get_any_binding : t -> binding

get_any_binding m is a binding of m.

  • raises Invalid_argument

    if m is empty.

Functorial interface

The functorial interface allows to associate more information to the keys. For example a key name or a key value pretty-printer.

module type KEY_INFO = sig ... end

The type for key information.

module type S = sig ... end

Output signature of the functor Make

module Make (Key_info : KEY_INFO) : S with type 'a Key.info = 'a Key_info.t

Functor for heterogeneous maps whose keys hold information of type Key_info.t

diff --git a/hmap/Hmap/module-type-KEY_INFO/index.html b/hmap/Hmap/module-type-KEY_INFO/index.html new file mode 100644 index 00000000..1f77dada --- /dev/null +++ b/hmap/Hmap/module-type-KEY_INFO/index.html @@ -0,0 +1,2 @@ + +KEY_INFO (hmap.Hmap.KEY_INFO)

Module type Hmap.KEY_INFO

The type for key information.

type 'a t

The type for key information.

diff --git a/hmap/Hmap/module-type-S/Key/index.html b/hmap/Hmap/module-type-S/Key/index.html new file mode 100644 index 00000000..aee2182f --- /dev/null +++ b/hmap/Hmap/module-type-S/Key/index.html @@ -0,0 +1,2 @@ + +Key (hmap.Hmap.S.Key)

Module S.Key

Keys.

Keys

type 'a info

The type for key information.

val create : 'a info -> 'a key

create i is a new key with information i.

val info : 'a key -> 'a info

info k is k's information.

Existential keys

Exisential keys allow to compare keys. This can be useful for functions like filter.

type t

The type for existential keys.

val hide_type : 'a key -> t

hide_type k is an existential key for k.

val equal : t -> t -> bool

equal k k' is true iff k and k' are the same key.

val compare : t -> t -> int

compare k k' is a total order on keys compatible with equal.

diff --git a/hmap/Hmap/module-type-S/index.html b/hmap/Hmap/module-type-S/index.html new file mode 100644 index 00000000..38aefbd7 --- /dev/null +++ b/hmap/Hmap/module-type-S/index.html @@ -0,0 +1,2 @@ + +S (hmap.Hmap.S)

Module type Hmap.S

Output signature of the functor Make

Keys

type 'a key

The type for keys whose lookup value is of type 'a.

module Key : sig ... end

Keys.

Maps

type t

The type for heterogeneous value maps.

val empty : t

empty is the empty map.

val is_empty : t -> bool

is_empty m is true iff m is empty.

val mem : 'a key -> t -> bool

mem k m is true iff k is bound in m.

val add : 'a key -> 'a -> t -> t

add k v m is m with k bound to v.

val singleton : 'a key -> 'a -> t

singleton k v is add k v empty.

val rem : 'a key -> t -> t

rem k m is m with k unbound.

val find : 'a key -> t -> 'a option

find k m is the value of k's binding in m, if any.

val get : 'a key -> t -> 'a

get k m is the value of k's binding in m.

  • raises Invalid_argument

    if k is not bound in m.

type binding =
  1. | B : 'a key * 'a -> binding

The type for bindings.

val iter : (binding -> unit) -> t -> unit

iter f m applies f to all bindings of m.

val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a

fold f m acc folds over the bindings of m with f, starting with acc

val for_all : (binding -> bool) -> t -> bool

for_all p m is true iff all bindings of m satisfy p.

val exists : (binding -> bool) -> t -> bool

exists p m is true iff there exists a bindings of m that satisfies p.

val filter : (binding -> bool) -> t -> t

filter p m are the bindings of m that satisfy p.

val cardinal : t -> int

cardinal m is the number of bindings in m.

val any_binding : t -> binding option

any_binding m is a binding of m (if not empty).

val get_any_binding : t -> binding

get_any_binding m is a binding of m.

  • raises Invalid_argument

    if m is empty.

diff --git a/hmap/_doc-dir/CHANGES.md b/hmap/_doc-dir/CHANGES.md new file mode 100644 index 00000000..ac21d5bc --- /dev/null +++ b/hmap/_doc-dir/CHANGES.md @@ -0,0 +1,9 @@ +v0.8.1 2017-10-03 Zagreb +------------------------ + +* Build depend on topkg. + +v0.8.0 2016-03-08 La Forclaz (VS) +--------------------------------- + +First release. diff --git a/hmap/_doc-dir/LICENSE.md b/hmap/_doc-dir/LICENSE.md new file mode 100644 index 00000000..ca386f07 --- /dev/null +++ b/hmap/_doc-dir/LICENSE.md @@ -0,0 +1,13 @@ + Copyright (c) 2016 Daniel C. Bünzli + + Permission to use, copy, modify, and/or distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/hmap/_doc-dir/README.md b/hmap/_doc-dir/README.md new file mode 100644 index 00000000..3f4d1cad --- /dev/null +++ b/hmap/_doc-dir/README.md @@ -0,0 +1,43 @@ +Hmap — Heterogeneous value maps for OCaml +------------------------------------------------------------------------------- +v0.8.1 + +Hmap provides heterogeneous value maps for OCaml. These maps bind keys +to values with arbitrary types. Keys witness the type of the value +they are bound to which allows to add and lookup bindings in a type +safe manner. + +Hmap has no dependency and is distributed under the ISC license. + +Home page: http://erratique.ch/software/hmap +Contact: Daniel Bünzli `` + +## Installation + +Hmap can be installed with `opam`: + + opam install hmap + +If you don't use `opam` consult the [`opam`](opam) file for build +instructions. + +## Documentation + +The documentation and API reference is automatically generated by +`ocamldoc` from the interfaces. It can be consulted [online][doc] +and there is a generated version in the `doc` directory of the +distribution. + +[doc]: http://erratique.ch/software/hmap/doc + +## Sample programs + +If you installed Hmap with `opam` sample programs are located in +the directory `opam config var hmap:doc`. + +In the distribution sample programs and tests are located in the +[`test`](test) directory of the distribution. They can be built an run +with + + topkg build --tests true + topkg test diff --git a/hmap/index.html b/hmap/index.html new file mode 100644 index 00000000..2b0040ca --- /dev/null +++ b/hmap/index.html @@ -0,0 +1,2 @@ + +index (hmap.index)

Package hmap

Package info

changes-files
license-files
readme-files
diff --git a/index.html b/index.html index ed106d84..fe61a999 100644 --- a/index.html +++ b/index.html @@ -1,2 +1,2 @@ -_opam

OCaml package documentation

Browse by name, by tag, the standard library and the OCaml manual (online, latest version).

Generated for /home/runner/work/ocaml-opentelemetry/ocaml-opentelemetry/_opam/lib

Packages by name

a

  1. ambient-context
  2. angstrom

b

  1. bigstringaf

c

  1. cohttp
  2. cohttp-lwt

l

  1. lwt

m

  1. mtime

o

  1. ocaml
  2. opentelemetry
  3. opentelemetry-client-ocurl
  4. opentelemetry-cohttp-lwt
  5. opentelemetry-lwt

p

  1. pbrt
  2. ptime

s

  1. sexplib0

u

  1. uri

Packages by tag

\ No newline at end of file +_opam

OCaml package documentation

Browse by name, by tag, the standard library and the OCaml manual (online, latest version).

Generated for /home/runner/work/ocaml-opentelemetry/ocaml-opentelemetry/_opam/lib

Packages by name

a

  1. ambient-context
  2. angstrom

b

  1. bigstringaf

c

  1. cohttp
  2. cohttp-lwt

h

  1. hmap

l

  1. lwt

m

  1. mtime

o

  1. ocaml
  2. opentelemetry
  3. opentelemetry-client-ocurl
  4. opentelemetry-cohttp-lwt
  5. opentelemetry-lwt

p

  1. pbrt
  2. ptime

s

  1. sexplib0

u

  1. uri

Packages by tag

\ No newline at end of file diff --git a/opentelemetry/Opentelemetry/index.html b/opentelemetry/Opentelemetry/index.html index 64272b28..a50f0516 100644 --- a/opentelemetry/Opentelemetry/index.html +++ b/opentelemetry/Opentelemetry/index.html @@ -1,2 +1,2 @@ -Opentelemetry (opentelemetry.Opentelemetry)

Module Opentelemetry

Opentelemetry types and instrumentation

module Lock : sig ... end

Global lock.

module Rand_bytes : sig ... end

Generation of random identifiers.

module AList : sig ... end

Atomic list, for internal usage

Wire format

module Proto = Opentelemetry_proto

Protobuf types.

Timestamps

module Timestamp_ns : sig ... end

Unix timestamp.

Interface to data collector

module Collector : sig ... end

Collector types

Identifiers

module Trace_id : sig ... end

Trace ID.

module Span_id : sig ... end

Unique ID of a span.

module Span_ctx : sig ... end

Span context. This bundles up a trace ID and parent ID.

Attributes and conventions

module Conventions : sig ... end
type value = [
  1. | `Int of int
  2. | `String of string
  3. | `Bool of bool
  4. | `Float of float
  5. | `None
]
type key_value = string * value

Global settings

module Globals : sig ... end

Process-wide metadata, environment variables, etc.

Traces and Spans

module Event : sig ... end

Events.

Scopes

module Scope : sig ... end

Scopes.

Span Link

module Span : sig ... end

Spans.

module Trace : sig ... end

Traces.

Metrics

module Metrics : sig ... end

Metrics.

module Logs : sig ... end

Logs.

module Metrics_callbacks : sig ... end

A set of callbacks that produce metrics when called. The metrics are automatically called regularly.

Utils

module Trace_context : sig ... end

Implementation of the W3C Trace Context spec

module GC_metrics : sig ... end

Export GC metrics.

+Opentelemetry (opentelemetry.Opentelemetry)

Module Opentelemetry

Opentelemetry types and instrumentation

module Lock : sig ... end

Global lock.

module Rand_bytes : sig ... end

Generation of random identifiers.

module AList : sig ... end

Atomic list, for internal usage

Wire format

module Proto = Opentelemetry_proto

Protobuf types.

Timestamps

module Timestamp_ns : sig ... end

Unix timestamp.

Interface to data collector

module Collector : sig ... end

Collector types

Identifiers

module Trace_id : sig ... end

Trace ID.

val k_trace_id : Trace_id.t Hmap.key

Hmap key to carry around a Trace_id.t, to remember what the current trace is.

  • since NEXT_RELEASE
module Span_id : sig ... end

Unique ID of a span.

module Span_ctx : sig ... end

Span context. This bundles up a trace ID and parent ID.

val k_span_ctx : Span_ctx.t Hmap.key

Hmap key to carry around a Span_ctx.t, e.g. to remember what the current parent span is.

  • since NEXT_RELEASE

Attributes and conventions

module Conventions : sig ... end
type value = [
  1. | `Int of int
  2. | `String of string
  3. | `Bool of bool
  4. | `Float of float
  5. | `None
]
type key_value = string * value

Global settings

module Globals : sig ... end

Process-wide metadata, environment variables, etc.

Traces and Spans

module Event : sig ... end

Events.

Scopes

module Scope : sig ... end

Scopes.

Span Link

module Span : sig ... end

Spans.

module Trace : sig ... end

Traces.

Metrics

module Metrics : sig ... end

Metrics.

module Logs : sig ... end

Logs.

module Metrics_callbacks : sig ... end

A set of callbacks that produce metrics when called. The metrics are automatically called regularly.

Utils

module Trace_context : sig ... end

Implementation of the W3C Trace Context spec

module GC_metrics : sig ... end

Export GC metrics.