package irmin
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=652aa550ba01cb174310f8d46f3c484619e216b2f954e1f478c144cf42804b57
sha512=d1a25bd025530a5d5b6ad86e9b41146d8c406da81998740df984d9b45047917a8d1a5330eb0b195ee5a2d25769a62bfde5b8c4389f9296ac25333791272e22de
doc/irmin.mem/Irmin_mem/KV/Private/Contents/index.html
Module Private.Contents
Source
Private content store.
Content-addressable stores
Content-addressable stores are store where it is possible to read and add new values. Keys are derived from the values raw contents and hence are deterministic.
The type for content-addressable backend 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 to specify the key directly. The backend might choose to discared that key and/or can be corrupt if the key scheme is not consistent.
merge t
lifts the merge functions defined on contents values to contents key. The merge function will: (i) read the values associated with the given keys, (ii) use the merge function defined on values and (iii) write the resulting values into the store to get the resulting key. See Contents.S.merge
.
If any of these operations fail, return `Conflict
.
Key
provides base functions for user-defined contents keys.