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.5.2.tbz

sha256=2a1e6a7577e498fbfeb678d666da210dc48d1344637e8ecb653e1dd88c640b5f

sha512=3fb6f49a1af2f8bab1df5b6f5affaaa09f09fe892a08eb2d9de58138e56646d4a6797f3c087b22875e36e3411218ab2435fe5437ac78f323dd661932af021fad

doc/irmin.mem/Irmin_mem/KV/Make/Branch/index.html

Module `Make.Branch`Source

Manipulate branches.

Branch Store

Manipulate relations between branches and commits.

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

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

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

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

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

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

set t b c bounds c to b in t.

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

remove t b removes b from t.

Sourceval list : repo -> branch list Lwt.t

list t is the list of branches present in t.

Source

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.

Source

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

Sourcetype t = branch

The type for branches.

Sourceval t : t Irmin.Type.t

Sourceval main : t

The name of the main branch.

Sourceval is_valid : t -> bool

Check if the branch is valid.

On This Page

Branch Store