package irmin
-
irmin
-
-
irmin_mem
-
Library
Module
Module type
Parameter
Class
Class type
Parameters
module S : APPEND_ONLY_STORE_MAKER
Signature
include CONTENT_ADDRESSABLE_STORE
with type 'a t = 'a S(K)(V).t
and type key = K.t
and type value = V.t
Content-addressable stores
Content-addressable stores are store where it is possible to read and add new values. Keys are derived from the values raw contents and hence are deterministic.
type 'a t = 'a S(K)(V).t
The type for content-addressable backend 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 : [> Perms.read ] t -> key -> bool Lwt.t
mem t k
is true iff k
is present in t
.
val find : [> Perms.read ] t -> key -> value option Lwt.t
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 : [> Perms.write ] t -> value -> key Lwt.t
Write the contents of a value to the store. It's the responsibility of the content-addressable store to generate a consistent key.
val batch :
Perms.read t ->
([ Perms.read | Perms.write ] t -> 'a Lwt.t) ->
'a Lwt.t
batch t f
applies the writes in f
in a separate batch. The exact guarantees depend on the implementation.
val v : Irmin__.Conf.t -> Perms.read t Lwt.t
v config
is a function returning fresh store handles, with the configuration config
, which is provided by the backend.