package irmin-containers

The type for node values.

The type for node metadata.

The type for keys.

The type for steps between nodes.

The type for either (node) keys or (contents) keys combined with their metadata.

of_list l is the node n such that list n = l.

list t is the contents of t. offset and length are used to paginate results.

caching

cache regulates the caching behaviour regarding the node's internal data which may be lazily loaded from the backend, depending on the node implementation.

cache defaults to true which may greatly reduce the IOs and the runtime but may also increase the memory consumption.

cache = false doesn't replace a call to clear, it only prevents the storing of new data, it doesn't discard the existing one.

of_seq s is the node n such that seq n = s.

seq t is the contents of t. offset and length are used to paginate results.

See caching for an explanation of the cache parameter

empty is the empty node.

is_empty t is true iff t is empty.

length t is the number of entries in t.

Cleanup internal caches.

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.

See caching for an explanation of the cache parameter

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.

t is the value type for t.

default is the default metadata value.

metadata_t is the value type for metadata.

hash_t is the value type for hash.

step_t is the value type for step.

value_t is the value type for value.