package irmin

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

Contents specifies how user-defined contents need to be serializable and mergeable.

The user needs to provide:

  • a type t to be used as store contents.
  • a value type for t (built using the Irmin.Type combinators).
  • a 3-way merge function, to handle conflicts between multiple versions of the same contents.

Default implementations for idempotent string and JSON contents are provided.

Values.

module type S = sig ... end
module String : S with type t = string

Contents of type string, with the default 3-way merge strategy: assume that update operations are idempotent and conflict iff values are modified concurrently.

type json = [
  1. | `Null
  2. | `Bool of bool
  3. | `String of string
  4. | `Float of float
  5. | `O of (string * json) list
  6. | `A of json list
]
module Json : S with type t = (string * json) list

Json contents are associations from strings to json values stored as JSON encoded strings. If the same JSON key has been modified concurrently with different values then the merge function conflicts.

module Json_value : S with type t = json

Json_value allows any kind of json value to be stored, not only objects.

module V1 : sig ... end
module type STORE = sig ... end

Contents store.

module Store (C : sig ... end) : STORE with type 'a t = 'a C.t and type key = C.key and type value = C.value

Store creates a contents store.