Branch (octez-libs.Brassaia_eio.Brassaia.Of

Branch Store

Manipulate relations between branches and commits.

val mem : repo -> branch -> bool

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

val find : repo -> branch -> commit option

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

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

val set : repo -> branch -> commit -> unit

set t b c bounds c to b in t.

val remove : repo -> branch -> unit

remove t b removes b from t.

val list : repo -> branch list

list t is the list of branches present in t.

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

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

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

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

val pp : branch Fmt.t

pp is a pretty-printer for a branch.

Base functions for branches.

include Branch.S with type t = branch

type t = branch

The type for branches.

val t : t Type.t

val main : t

The name of the main branch.

val encoding : t Data_encoding.t

encoding is the data_encoding for t.

val is_valid : t -> bool

Check if the branch is valid.