package irmin-git

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Git.S
type t
type hash
type error = private [>
  1. | `Msg of string
  2. | `Not_found of hash
  3. | `Reference_not_found of Git__.Reference.t
]
val pp_error : error Fmt.t
module Hash : sig ... end
module Value : sig ... end
module Reference : sig ... end
val dotgit : t -> Fpath.t
val root : t -> Fpath.t
val contents : t -> (hash * Value.t) list Lwt.t
val size : t -> hash -> (int64, error) Stdlib.result Lwt.t
val read : t -> hash -> (Value.t, error) Stdlib.result Lwt.t
val read_opt : t -> hash -> (Value.t option, [ `Msg of string ]) Stdlib.result Lwt.t
val read_exn : t -> hash -> Value.t Lwt.t
val mem : t -> hash -> bool Lwt.t
val list : t -> hash list Lwt.t
val write : t -> Value.t -> (hash * int, error) Stdlib.result Lwt.t
val batch_write : t -> hash -> pck:(unit -> string option Lwt.t) -> idx:(unit -> string option Lwt.t) -> (unit, error) Stdlib.result Lwt.t
val fold : t -> ('acc -> ?name:Fpath.t -> length:int64 -> hash -> Value.t -> 'acc Lwt.t) -> path:Fpath.t -> 'acc -> hash -> 'acc Lwt.t
val iter : t -> (hash -> Value.t -> unit Lwt.t) -> hash -> unit Lwt.t
module Ref : sig ... end
val reset : t -> (unit, error) Stdlib.result Lwt.t
val read_inflated : t -> hash -> ([ `Blob | `Commit | `Tag | `Tree ] * Cstruct.t) option Lwt.t
val write_inflated : t -> kind:[ `Blob | `Commit | `Tag | `Tree ] -> Cstruct.t -> hash Lwt.t
val is_shallowed : t -> hash -> bool Lwt.t
val shallowed : t -> hash list Lwt.t
val shallow : t -> hash -> unit Lwt.t
val unshallow : t -> hash -> unit Lwt.t
val has_global_watches : bool
val has_global_checkout : bool
val v : ?dotgit:Fpath.t -> Fpath.t -> (t, error) Stdlib.result Lwt.t
OCaml

Innovation. Community. Security.