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/Branch/index.html

Module `Make.Branch`

Manipulate branches.

Branch Store

Manipulate relations between branches and commits.

val mem : repo -> branch -> bool Lwt.t

mem r b is true iff b is present in r.

val find : repo -> branch -> commit option Lwt.t

find r b is Some c iff c is bound to b in t. It is None if b is not present in t.

val get : repo -> branch -> commit Lwt.t

get t b is similar to find but raise Invalid_argument if b is not present in t.

val set : repo -> branch -> commit -> unit Lwt.t

set t b c bounds c to b in t.

val remove : repo -> branch -> unit Lwt.t

remove t b removes b from t.

val list : repo -> branch list Lwt.t

list t is the list of branches present in t.

val watch : 
  repo ->
  branch ->
  ?init:commit ->
  (commit Irmin.Diff.t -> unit Lwt.t) ->
  watch Lwt.t

watch t b f calls f on every change in b.

val watch_all : 
  repo ->
  ?init:(branch * commit) list ->
  (branch -> commit Irmin.Diff.t -> unit Lwt.t) ->
  watch Lwt.t

watch_all t f calls f on every branch-related change in t, including creation/deletion events.

Base functions for branches.

include Irmin.Branch.S with type t = branch

Signature for Branches

type t = branch

The type for branches.

val t : t Irmin.Type.t

val main : t

The name of the main branch.

val is_valid : t -> bool

Check if the branch is valid.

On This Page

Branch Store