package irmin

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

Install 

dune-project
 Dependency

github.com Edit opam file Versions (10)

Authors

  1. T
    Thomas Gazagnaire
  2. T
    Thomas Leonard

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

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

doc/irmin.mem/Irmin_mem/Make/Private/Commit/Node/Val/index.html

Module Node.ValSource

Val provides base functions for node values.

Node values

Sourcetype t = value

The type for node values.

Sourcetype metadata = Metadata.t

The type for node metadata.

Sourcetype hash = key

The type for keys.

Sourcetype step = Path.step

The type for steps between nodes.

Sourcetype value = [
  1. | `Node of hash
  2. | `Contents of hash * metadata
]

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

Sourceval v : (step * value) list -> t

create l is a new node.

Sourceval list : ?offset:int -> ?length:int -> t -> (step * value) list

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

Sourceval empty : t

empty is the empty node.

Sourceval is_empty : t -> bool

is_empty t is true iff t is empty.

Sourceval length : t -> int

length t is the number of entries in t.

Sourceval find : t -> step -> value option

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.

Sourceval add : t -> step -> value -> t

add t s v is the node where find t v is Some s but is similar to t otherwise.

Sourceval remove : t -> step -> t

remove t s is the node where find t s is None but is similar to t otherwise.

Value types

t is the value type for t.

Sourceval default : metadata

default is the default metadata value.

Sourceval metadata_t : metadata Irmin.Type.t

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.