package irmin
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=95a87ecc3dc2b35eee56cb351c32d2bd78c8967180a4b028324d815bfce1a6ff
sha512=20faba561c80c5389e91993d7e2cc0cedd1330cf098b68f0456f5068cde369a5589a05cd2aeb0a701d65a7d1e1e6f4045ccfbf60349cbea2bfd02981d7bb244c
doc/irmin.mem/Irmin_mem/Make/Backend/Commit/Node/index.html
Module Commit.Node
Source
Node
is the underlying node store.
include Irmin.Indexable.S with type key = Val.node_key
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.
The type for keys.
The type for raw values.
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
.
close t
frees up all the resources associated with t
. Any operations run on a closed handle will raise Closed
.
The type of hashes of value
.
Write the contents of a value to the store, and obtain its key.
Same as add
but allows specifying the value's hash directly. The backend might choose to discard that hash and/or can be corrupt if the hash is not consistent.
Indexing maps the hash of a value to a corresponding key of that value in the store. For stores that are addressed by hashes directly, this is typically fun _t h -> Lwt.return (Key.of_hash h)
; for stores with more complex addressing schemes, index
may attempt a lookup operation in the store.
In general, indexing is best-effort and reveals no information about the membership of the value in the store. In particular:
index t hash = Some key
doesn't guaranteemem t key
: the value with hashhash
may still be absent from the store;
index t hash = None
doesn't guarantee that there is nokey
such thatmem t key
andKey.to_hash key = hash
: the value may still be present in the store under a key that is not indexed.
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.
Path
provides base functions on node paths.
merge
is the 3-way merge function for nodes keys.
Metadata
provides base functions for node metadata.
Contents
is the underlying contents store.