package irmin-pack
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=fac7c032f472fb369378ad2d8fe77e7cd3b3c1c6a0d7bf59980b69528891b399
sha512=06db1c4e90d43bdfbea2d4f15037eef77207877c05019a6ce0f7f7771afe7d9200da019e3d845ff98ee86947f3e538e1521d818e6d6ddd97105fcaeb746fe418
doc/irmin-pack.mem/Irmin_pack_mem/Make/Private/Node/Val/index.html
Module Node.Val
Val provides base functions for node values.
Node values
type t = valueThe type for node values.
type metadata = Metadata.tThe type for node metadata.
type hash = keyThe type for keys.
type step = Path.stepThe type for steps between nodes.
The type for either (node) keys or (contents) keys combined with their metadata.
list t is the contents of t. offset and length are used to paginate results.
val empty : tempty is the empty node.
val is_empty : t -> boolis_empty t is true iff t is empty.
val length : t -> intlength t is the number of entries in t.
find t s is the value associated with s in t.
A node can point to user-defined contents. The edge between the node and the contents is labeled by a step.
add t s v is the node where find t v is Some s but is similar to t otherwise.
remove t s is the node where find t s is None but is similar to t otherwise.
Value types
val t : t Irmin__.Type.tt is the value type for t.
val default : metadatadefault is the default metadata value.
val metadata_t : metadata Irmin__.Type.tmetadata_t is the value type for metadata.
val hash_t : hash Irmin__.Type.thash_t is the value type for hash.
val step_t : step Irmin__.Type.tstep_t is the value type for step.
val value_t : value Irmin__.Type.tvalue_t is the value type for value.