package irmin

  1. Overview
  2. Docs
On This Page
  1. Import/Export
package irmin
Legend:
Library
Module
Module type
Parameter
Class
Class type

Contents provides base functions for the store's contents.

include Contents.S with type t = contents

Signature for store contents

type t = contents

The type for user-defined contents.

val t : t 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 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

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

Hash provides base functions for contents hashes.

val hash : Repo.t -> contents -> Hash.t Lwt.t

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

val of_hash : Repo.t -> Hash.t -> 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.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct