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/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

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