package irmin-containers

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

Make returns a mergeable last-write-wins register using the backend and other parameters as specified by the user.

Parameters

module Backend : sig ... end
module T : Time.S
module V : Irmin.Type.S

Signature

module Store : Irmin.S with type branch = string with type key = string list with type step = string

Content store of the register. All store related operations like branching, cloning, merging, etc are done through this module.

type value = V.t

Type of values stored in the register

val read : path:Store.key -> Store.t -> value option Lwt.t

Reads the value from the register. Returns None if no value is written

val write : ?info:Irmin.Info.f -> path:Store.key -> Store.t -> value -> unit Lwt.t

Writes the provided value to the register