On This Page
package irmin-containers
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Parameters
module K : Irmin.Hash.Smodule V : Irmin.Type.SSignature
include Irmin.CONTENT_ADDRESSABLE_STORE
with 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.
The type for content-addressable backend stores. The 'a phantom type carries information about the store mutability.
type key = K.tThe type for keys.
type value = V.tThe type for raw values.
val mem : [> Irmin.Perms.read ] t -> key -> bool Lwt.tmem t k is true iff k is present in t.
val find : [> Irmin.Perms.read ] t -> key -> value option Lwt.tfind t k is Some v if k is associated to v in t and None is k is not present in t.
val add : [> Irmin.Perms.write ] t -> value -> key Lwt.tWrite the contents of a value to the store. It's the responsibility of the content-addressable store to generate a consistent key.
val unsafe_add : [> Irmin.Perms.write ] t -> key -> value -> unit Lwt.tSame as add but allows to specify the key directly. The backend might choose to discared that key and/or can be corrupt if the key scheme is not consistent.
val clear : 'a t -> unit Lwt.tClear the store. This operation is expected to be slow.
val batch :
Irmin.Perms.read t ->
([ Irmin.Perms.read | Irmin.Perms.write ] t -> 'a Lwt.t) ->
'a Lwt.tbatch t f applies the writes in f in a separate batch. The exact guarantees depend on the implementation.
val v : Irmin__.Conf.t -> Irmin.Perms.read t Lwt.tv config is a function returning fresh store handles, with the configuration config, which is provided by the backend.
val close : 'a t -> unit Lwt.tclose t frees up all the resources associated with t. Any operations run on a closed handle will raise Closed.
On This Page