package irmin

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

Irmin, a distributed database that follows the same design principles as Git

Install

Dune Dependency

github.com Edit opam file Versions (44)

Authors

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-3.9.0.tbz

sha256=8e073abe1b5ffb5b6d58c32606c9d7dabc32c53501756be80a92ed4777ad51a0

sha512=70769a8d36520626fecd6f68e5f3abe6a0d67a65af915312206cc3f4da230df48512faee178aa6e899d3fb640b9340f6c92486185be5432a1a1a161c70386c99

doc/irmin.mem/Irmin_mem/Make/Commit/index.html

Module `Make.Commit`Source

Commit defines immutable objects to describe store updates.

Sourcetype t = commit

The type for store commits.

Sourceval t : repo -> t Irmin.Type.t

t is the value type for t.

Sourceval pp_hash : t Fmt.t

pp_hash is a pretty-printer for a commit. Displays only the hash.

Sourceval pp : t Fmt.t

pp is a full pretty-printer for a commit. Displays all information.

Source

val v : 
  ?clear:bool ->
  repo ->
  info:info ->
  parents:commit_key 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

When clear is set (the default), the tree cache is emptied upon the function's completion, mirroring the effect of invoking Tree.clear.

Sourceval tree : commit -> tree

tree c is c's root tree.

Sourceval parents : commit -> commit_key list

parents c are c's parents.

Sourceval info : commit -> info

info c is c's info.

Sourceval hash : commit -> hash

hash c is c's hash.

Import/Export

Sourceval key : commit -> commit_key

key c is c's key.

Sourceval of_key : repo -> commit_key -> commit option Lwt.t

of_key r k is the the commit object in r with key k, or None if no such commit object exists.

Sourceval of_hash : repo -> hash -> commit option Lwt.t

of_hash r h is the commit object in r with hash h, or None if no such commit object is indexed in r.

Note: in stores for which commit_key = hash, this function has identical behaviour to of_key.

On This Page

Import/Export