package irmin

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

Install

Dune Dependency

Authors

Maintainers

Sources

irmin-3.7.1.tbz
sha256=8d1a49318bda711ed44d9ea27ecd044b1d650390633d5b08f76590689c22056f
sha512=2995e6acc53dee2c59bf473c7c16c74daebfa193df552ec83ffe88fe598e26d4d8ff5da4f0cd575adaa49efa4b317d74f2c814c1b5601bed3833d76f377b6da7

doc/irmin.mem/Irmin_mem/Make/Contents/index.html

Module Make.ContentsSource

Contents provides base functions for the store's contents.

include Irmin.Contents.S with type t = contents

Signature for store contents

type t = contents

The type for user-defined contents.

val t : t Irmin.Type.t
val merge : t option Irmin.Merge.t

Merge function. Evaluates to `Conflict msg if the values cannot be merged properly. The arguments of the merge function can take None to mean that the key does not exists for either the least-common ancestor or one of the two merging points. The merge function returns None when the key's value should be deleted.

Import/Export

Sourceval hash : contents -> hash

hash c it c's hash.

Sourceval of_key : repo -> contents_key -> contents option Lwt.t

of_key r k is the contents object in r with key k, or None if no such contents object exists.

Sourceval of_hash : repo -> hash -> contents option Lwt.t

of_hash r h is the contents object in r with hash h, or None if no such contents object is indexed in r.

Note: in stores for which contents_key = hash, this function has identical behaviour to of_key.

OCaml

Innovation. Community. Security.