package irmin
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=92a9de7a0a2a35c2feba0c35a806b1f0df24c1c0d15164eebf3f919296d26715
sha512=0203ec5117a851ad5afeb2f9091659b4e142e231b6b945caab93f4d7beb23397c8ac43f7056e91d18f4bff0be1062f6ae966d221f877c229328c0cbbf29fd9f0
doc/irmin.mem/Irmin_mem/Content_addressable/index.html
Module Irmin_mem.Content_addressable
Source
An in-memory store for content-addressable values.
A content-addressable store is an indexed read-write store in which values are keyed directly by their hashes.
Parameters
module Hash : Irmin.Hash.S
module Value : Irmin.Type.S
Signature
Read-only stores
Read-only stores are store where it is only possible to read existing values.
The type for stores. The 'a
phantom type carries information about the store mutability.
mem t k
is true iff k
is present in t
.
find t k
is Some v
if k
is associated to v
in t
and None
is k
is not present in t
.
Write the contents of a value to the store. It's the responsibility of the content-addressable store to generate a consistent key.
Same as add
but allows specifying the key directly. The backend might choose to discard that key and/or can be corrupt if the key scheme is not consistent.
close t
frees up all the resources associated with t
. Any operations run on a closed handle will raise Closed
.
val batch :
Irmin.Perms.read t ->
([ Irmin.Perms.read | Irmin.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.
v config
is a function returning fresh store handles, with the configuration config
, which is provided by the backend.