Module Index

Index

Index is a scalable implementation of persistent indices in OCaml.

Index provides the standard key-value interface: find, mem and replace. It requires three IO instances:

module type Key = sig ... end

The input of Make for keys.

module Stats : sig ... end
module type Value = sig ... end

The input of Make for values. The same requirements as for Key apply.

module type IO = Index__Io.S
module type MUTEX = sig ... end
module type THREAD = sig ... end
exception RO_not_allowed

The exception raised when a write operation is attempted on a read_only index.

exception Closed

The exception raised when any operation is attempted on a closed index, except for close, which is idempotent.

module type S = sig ... end

Index module signature.

module Make : functor (K : Key) -> functor (V : Value) -> functor (IO : IO) -> functor (M : MUTEX) -> functor (T : THREAD) -> S with type key = K.t and type value = V.t
module Private : sig ... end

These modules should not be used. They are exposed purely for testing purposes.