package irmin-mem

  1. Overview
  2. Docs

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

t is the value type for t.

val pp : t Fmt.t

pp pretty-prints contents.

val of_string : string -> (t, [ `Msg of string ]) Result.result

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


module Hash : Irmin.Hash.S with type t = H.t

Hash provides base functions for contents hashes.

type hash = Hash.t

The type for content hashes.

val hash : repo -> contents -> hash Lwt.t

hash r c it c's hash in the repository r.

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

of_hash r h is the the contents object in r having h as hash, or None is no such contents object exists.