package irmin-mirage-git

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

Contents provides base functions for the store's 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 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

val hash : contents -> hash

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