package irmin-http

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

Commit defines immutable objects to describe store updates.

type t = commit

The type for store commits.

val t : Repo.t -> t Irmin.Type.t

t is the value type for t.

val pp : t Fmt.t

pp is the pretty-printer for commit. Display only the hash.

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

of_string r str parsing the commit from the string str, using the base repository r.

val v : Repo.t -> info:Irmin.Info.t -> parents:commit list -> tree -> commit Lwt.t

v r i ~parents:p t is the commit c such that:

  • info c = i
  • parents c = p
  • tree c = t
val tree : commit -> tree Lwt.t

tree c is c's root tree.

val parents : commit -> commit list Lwt.t

parents c are c's parents.

val info : commit -> Irmin.Info.t

info c is c's info.

Import/Export

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

Hash provides base functions for commit hashes.

val hash : commit -> Hash.t

hash c it c's hash.

val of_hash : Repo.t -> Hash.t -> commit option Lwt.t

of_hash r h is the the commit object in r having h as hash, or None is no such commit 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