package irmin-git

  1. Overview
  2. Docs
On This Page
  1. Import/Export

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 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.