package octez-internal-libs

You can search for identifiers within the package.

in-package search v0.2.0

A package that contains some libraries used by the Octez suite

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (1)

Authors

Maintainers

C

contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2

sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61

sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/irmin_mem/Irmin_mem/KV/Make/Commit/index.html

Module `Make.Commit`

Commit defines immutable objects to describe store updates.

type t = commit

The type for store commits.

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

t is the value type for t.

val pp_hash : t Fmt.t

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

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.

val tree : commit -> tree

tree c is c's root tree.

val parents : commit -> commit_key list

parents c are c's parents.

val info : commit -> info

info c is c's info.

val hash : commit -> hash

hash c is c's hash.

Import/Export

val key : commit -> commit_key

key c is c's key.

val 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.

val 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