package tezos-protocol-alpha

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Name : NAME
module Key : KEY
module Value : VALUE

Signature

type t
type key = Key.t
type value = Value.t
val empty : capacity:int64 -> t

empty ~capacity returns a new table whose maximum capacity is given.

Encoding for values of type t

Pretty-printer for values of type t

val find : key -> t -> value option

find key t returns Some value if there exists some value associated to key in the table, and None otherwise.

type Tezos_protocol_environment_alpha.Error_monad.error +=
  1. | Key_bound_to_different_value of {
    1. key : key;
    2. existing_value : value;
    3. given_value : value;
    }

remember key value t inserts a new entry (key |-> value) in t.

If key already exists in t, its associated binding value' should be equal to value. In this case, t is returned unchanged. Otherwise, an error Key_bound_to_different_value is returned.

If key is not already present in t, the new binding (key |-> value) is inserted in t. If the number of elements would exceed t's capacity after the insertion of the new binding, the oldest binding is removed from t.

The structure t is returned unchanged if its capacity is negative or null.

module Internal_for_tests : sig ... end
OCaml

Innovation. Community. Security.