package irmin

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 Readme Changelog ISC License Edit opam file Versions (44)

Authors

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-3.2.1.tbz

sha256=9cfb7291a7d90ca0e55ece33040ad41e74cadd8c6446e04c33558bc1a1951518

sha512=9605acd77de9aae70ae96554a28594e6ed5beba70a48145c0fc2204b32bb23b843ba98cf034e88391581d5f3495154195c644d64a3aa3f8d3994a9c5518c5cda

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 is the pretty-printer for commit. Display only the hash.

Sourceval v : 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

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