package irmin-pack
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=29c68c5001a727aaa7a6842d6204ffa3e24b3544fa4f6af2234cdbfa032f7fdf
sha512=87254dfe640619b678a95c211435c0deaaaac8bec50bba711757dd610c9fe6d9a80938399b7e2bb7bc813116eebc82bf3474b281d1afcd1031586f3d51579925
doc/irmin-pack.layered/Irmin_pack_layered/Maker/Private/Branch/index.html
Module Private.Branch
Private branch store.
Branch Store
Atomic write stores
Atomic-write stores are stores where it is possible to read, update and remove elements, with atomically guarantees.
type key = branch
The type for keys.
type value = Hash.t
The type for raw 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.
val watch :
t ->
?init:(key * value) list ->
(key -> value Irmin__.S.diff -> unit Lwt.t) ->
watch Lwt.t
watch t ?init f
adds f
to the list of t
's watch handlers and returns the watch handler to be used with unwatch
. init
is the optional initial values. It is more efficient to use watch_key
to watch only a single given key.
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
.
module Key : sig ... end
Base functions on keys.
module Val : sig ... end
Base functions on values.