package irmin-pack
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=29c68c5001a727aaa7a6842d6204ffa3e24b3544fa4f6af2234cdbfa032f7fdf
sha512=87254dfe640619b678a95c211435c0deaaaac8bec50bba711757dd610c9fe6d9a80938399b7e2bb7bc813116eebc82bf3474b281d1afcd1031586f3d51579925
doc/irmin-pack.layered/Irmin_pack_layered/Checks/Make/argument-1-M/Private/Node/Val/index.html
Module Node.Val
Val
provides base functions for node values.
Node values
type t = value
The type for node values.
type metadata = Metadata.t
The type for node metadata.
type hash = key
The type for keys.
type step = Path.step
The 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 : t
empty
is the empty node.
val is_empty : t -> bool
is_empty t
is true iff t
is empty
.
val length : t -> int
length 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.t
t
is the value type for t
.
val default : metadata
default
is the default metadata value.
val metadata_t : metadata Irmin__.Type.t
metadata_t
is the value type for metadata
.
val hash_t : hash Irmin__.Type.t
hash_t
is the value type for hash
.
val step_t : step Irmin__.Type.t
step_t
is the value type for step
.
val value_t : value Irmin__.Type.t
value_t
is the value type for value
.