package irmin-pack
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=8d1a49318bda711ed44d9ea27ecd044b1d650390633d5b08f76590689c22056f
sha512=2995e6acc53dee2c59bf473c7c16c74daebfa193df552ec83ffe88fe598e26d4d8ff5da4f0cd575adaa49efa4b317d74f2c814c1b5601bed3833d76f377b6da7
doc/irmin-pack.mem/Irmin_pack_mem/Maker/Make/Backend/Node/index.html
Module Backend.Node
A node store.
An indexable store is a read-write store in which values can be added and later found via their keys.
Keys are not necessarily portable between different stores, so each store provides an index mechanism to find keys by the hashes of the values they reference.
Read-only stores
Read-only stores are store where it is only possible to read existing values.
type key = node_keyThe type for keys.
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.
type hash = Hash.tThe 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 keydoesn't guaranteemem t key: the value with hashhashmay still be absent from the store;
index t hash = Nonedoesn't guarantee that there is nokeysuch thatmem t keyandKey.to_hash key = hash: the value may still be present in the store under a key that is not indexed.
val batch :
Irmin__.Import.read t ->
([ Irmin__.Import.read | Irmin__.Import.write ] t -> 'a Lwt.t) ->
'a Lwt.tbatch t f applies the writes in f in a separate batch. The exact guarantees depend on the implementation.
module Key : sig ... endmodule Path = PathPath provides base functions on node paths.
merge is the 3-way merge function for nodes keys.
module Metadata = Schema.MetadataMetadata provides base functions for node metadata.
module Val : sig ... endVal provides base functions for node values.
module Hash : sig ... endmodule Contents : sig ... endContents is the underlying contents store.