Index (index.Index)

module Key : sig ... end

module Value : sig ... end

Platform dependencies required by Make.

module Platform : sig ... end

module Cache : sig ... end

Signatures and implementations of caches. Make requires a cache in order to provide instance sharing.

module type S = sig ... end

Index module signature.

exception RO_not_allowed

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

exception RW_not_allowed

The exception is raised when a sync operation is attempted on a read-write index.

exception Closed

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

module Make
  (K : Key.S)
  (V : Value.S)
  (_ : Platform.S)
  (C : Cache.S) : 
  S with type key = K.t and type value = V.t

module Stats : sig ... end

Run-time metric tracking for index instances.

module Checks : sig ... end

Offline integrity checking and recovery for Index stores.

module Private : sig ... end

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