package irmin

  1. Overview
  2. Docs
Irmin, a distributed database that follows the same design principles as Git

Install

Dune Dependency

Authors

Maintainers

Sources

irmin-2.7.1.tbz
sha256=fac7c032f472fb369378ad2d8fe77e7cd3b3c1c6a0d7bf59980b69528891b399
sha512=06db1c4e90d43bdfbea2d4f15037eef77207877c05019a6ce0f7f7771afe7d9200da019e3d845ff98ee86947f3e538e1521d818e6d6ddd97105fcaeb746fe418

doc/irmin.mem/Irmin_mem/KV/Key/index.html

Module KV.KeySource

Key provides base functions for the stores's paths.

Path

Sourcetype t = key

The type for path values.

Sourcetype step = step

Type type for path's steps.

Sourceval empty : t

The empty path.

Sourceval v : step list -> t

Create a path from a list of steps.

Sourceval is_empty : t -> bool

Check if the path is empty.

Sourceval cons : step -> t -> t

Prepend a step to the path.

Sourceval rcons : t -> step -> t

Append a step to the path.

Sourceval decons : t -> (step * t) option

Deconstruct the first element of the path. Return None if the path is empty.

Sourceval rdecons : t -> (t * step) option

Deconstruct the last element of the path. Return None if the path is empty.

Sourceval map : t -> (step -> 'a) -> 'a list

map t f maps f over all steps of t.

Value Types

t is the value type for t.

step_t is the value type for step.

OCaml

Innovation. Community. Security.