package containers

  1. Overview
  2. Docs
type key
type t

A map containing values of different types, indexed by key.

val empty : t

Empty map

val get : inj:'a injection -> t -> key -> 'a option

Get the value corresponding to this key, if it exists and belongs to the same key

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

Bind the key to the value, using inj

val find : inj:'a injection -> t -> key -> 'a

Find the value for the given key, which must be of the right type.

  • raises Not_found

    if either the key is not found, or if its value doesn't belong to the right type

val cardinal : t -> int

Number of bindings

val remove : t -> key -> t

Remove the binding for this key

val mem : inj:_ injection -> t -> key -> bool

Is the given key in the map, with the right type?

val iter_keys : f:(key -> unit) -> t -> unit

Iterate on the keys of this map

val fold_keys : f:('a -> key -> 'a) -> x:'a -> t -> 'a

Fold over the keys

Iterators

type 'a sequence = ('a -> unit) -> unit
val keys_seq : t -> key sequence

All the keys

val bindings_of : inj:'a injection -> t -> (key * 'a) sequence

All the bindings that come from the corresponding injection

type value =
  1. | Value : ('a injection -> 'a option) -> value
val bindings : t -> (key * value) sequence

Iterate on all bindings

OCaml

Innovation. Community. Security.