package irmin

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

Module KV.CommitSource

Commit defines immutable objects to describe store updates.

Sourcetype t = commit

The type for store commits.

t is the value type for t.

Sourceval pp_hash : t Fmt.t

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

Sourceval v : repo -> info:Irmin.Info.t -> parents:hash 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
Sourceval tree : commit -> tree

tree c is c's root tree.

Sourceval parents : commit -> hash list

parents c are c's parents.

info c is c's info.

Import/Export

Sourceval hash : commit -> hash

hash c it c's hash.

Sourceval of_hash : repo -> hash -> 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