package irmin

  1. Overview
  2. Docs
package irmin
Legend:
Library
Module
Module type
Parameter
Class
Class type

Store creates node stores.

Parameters

module C : Contents.STORE
module P : Path.S
module M : Metadata.S
module S : sig ... end

Signature

include AO with type t = C.t * S.t with type key = S.key with type value = S.value

Append-only stores

Append-only stores are read-only store where it is also possible to add values. Keys are derived from the values raw contents and hence are deterministic.

include RO with type t = C.t * S.t with type key = S.key with type value = S.value

Read-only stores

type t = C.t * S.t

The type for read-only backend stores.

type key = S.key

The type for keys.

type value = S.value

The type for raw values.

val mem : t -> key -> bool Lwt.t

mem t k is true iff k is present in t.

val find : t -> key -> value option Lwt.t

find t k is Some v if k is associated to v in t and None is k is not present in t.

val add : t -> value -> key Lwt.t

Write the contents of a value to the store. It's the responsibility of the append-only store to generate a consistent key.

module Path = P

Path provides base functions on node paths.

val merge : t -> key option Merge.t

merge is the 3-way merge function for nodes keys.

module Key = S.Key

Key provides base functions for node keys.

module Metadata = M

Metadata provides base functions for node metadata.

module Val = S.Val

Val provides base functions for node values.

Contents is the underlying contents store.