package irmin
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=98cc035d7b618ae8d94925a00d80159d9fdabf5f165b80aedb5c879aa4cf4b8e
sha512=8a2b91621a5b74d9d88e975faa14efef18cf12cf0194f80279b0ac574468872bc0fc33d827f85dca55dbd4c46b7bb002808d9fc2fa0fa44fc85a845838c9f43b
doc/irmin.mem/Irmin_mem/Atomic_write/index.html
Module Irmin_mem.Atomic_write
Source
An in-memory store with atomic-write guarantees.
Parameters
module K : Irmin.Type.S
module V : Irmin.Type.S
Signature
Atomic write stores
Atomic-write stores are stores where it is possible to read, update and remove elements, with atomically guarantees.
The type for atomic-write backend stores.
Read-only stores
Read-only stores are store where it is only possible to read existing values.
find t k
is Some v
if k
is associated to v
in t
and None
is k
is not present in t
.
set t k v
replaces the contents of k
by v
in t
. If k
is not already defined in t
, create a fresh binding. Raise Invalid_argument
if k
is the empty path.
test_and_set t key ~test ~set
sets key
to set
only if the current value of key
is test
and in that case returns true
. If the current value of key
is different, it returns false
. None
means that the value does not have to exist or is removed.
Note: The operation is guaranteed to be atomic.
The type of watch handlers.
watch_key t k ?init f
adds f
to the list of t
's watch handlers for the key k
and returns the watch handler to be used with unwatch
. init
is the optional initial value of the key.
close t
frees up all the resources associated with t
. Any operations run on a closed handle will raise Closed
.