package irmin

  1. Overview
  2. Docs
Module type
Class type

STORE specifies the signature for node stores.

include AO

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

Read-only stores

type t

The type for read-only backend stores.

type key

The type for keys.

type 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 : Path.S

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 : Hash.S with type t = key

Key provides base functions for node keys.

Metadata provides base functions for node metadata.

module Val : S with type t = value and type node = key and type metadata = Metadata.t and type step = Path.step

Val provides base functions for node values.

Contents is the underlying contents store.