package octez-internal-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65
doc/irmin_mem/Irmin_mem/Append_only/index.html
Module Irmin_mem.Append_only
Source
An in-memory store for append-only values.
Parameters
module K : Irmin.Type.S
module V : Irmin.Type.S
Signature
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.
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.
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.