Module Storage.Append_only

Parameters

module M : Make
module K : Type.S
module V : Type.S

Signature

include Append_only_intf.S with type key = K.t and type value = V.t

Append-only stores

Append-only stores are store where it is possible to read and add new values.

Read-only stores

Read-only stores are store where it is only possible to read existing values.

type -'a t

The type for stores. The 'a phantom type carries information about the store mutability.

type key = K.t

The type for keys.

type value = V.t

The type for raw values.

val mem : [> Import.read ] t -> key -> bool

mem t k is true iff k is present in t.

val find : [> Import.read ] t -> key -> value option

find t k is Some v if k is associated to v in t and None is k is not present in t.

val add : [> Import.write ] t -> key -> value -> unit

Write the contents of a value to the store.

val close : 'a t -> unit

close t frees up all the resources associated with t. Any operations run on a closed handle will raise Closed.

val batch : Import.read t -> ([ Import.read | Import.write ] t -> 'a) -> 'a

batch t f applies the writes in f in a separate batch. The exact guarantees depend on the implementation.

val init : Conf.t -> Import.read t

init config is a function returning fresh store handles, with the configuration config, which is provided by the backend.