package irmin-git

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
val list : t -> (Reference.t * hash) list Lwt.t

list state returns an associated list between reference and its bind hash.

val mem : t -> Reference.t -> bool Lwt.t

mem state ref returns true iff ref exists in state, otherwise returns false.

val read : t -> Reference.t -> (Reference.contents, error) Stdlib.result Lwt.t

read state reference returns the value contains in the reference reference (available in the git repository state).

val resolve : t -> Reference.t -> (hash, error) Stdlib.result Lwt.t

resolve state reference returns obj-id pointed at by reference (available in the git repository state).

val write : t -> Reference.t -> Reference.contents -> (unit, error) Stdlib.result Lwt.t

write state reference value writes the value value in the mutable representation of the reference in the git repository state.

val remove : t -> Reference.t -> (unit, error) Stdlib.result Lwt.t

remove state reference removes the reference reference from the git repository state.