package irmin-pack

  1. Overview
  2. Docs
package irmin-pack
Legend:
Library
Module
Module type
Parameter
Class
Class type
type msg = [
  1. | `Msg of string
]
type stats = {
  1. duration : float;
  2. finalisation_duration : float;
  3. read_gc_output_duration : float;
  4. transfer_latest_newies_duration : float;
  5. swap_duration : float;
}
val stats_t : stats Irmin.Type.t
type process_state = [
  1. | `Finalised of stats
  2. | `Idle
  3. | `Running
]
val catch_errors : string -> exn -> ('a, [> `Msg of string ]) result Lwt.t
val map_errors : string -> Errs.t -> [> `Msg of string ]
val finalise_exn : ?wait:bool -> X.Repo.t -> [> `Finalised of Irmin_pack_unix__Gc_intf.stats | `Idle | `Running ] Lwt.t
val start_exn : ?unlink:bool -> X.Repo.t -> XKey.t -> bool Lwt.t
val start : X.Repo.t -> XKey.t -> (bool, [> `Msg of string ]) result Lwt.t
val is_finished : X.Repo.t -> bool
val wait : X.Repo.t -> (Irmin_pack_unix__Gc_intf.stats option, [> `Msg of string ]) result Lwt.t
val run : ?finished: ((Irmin_pack_unix__Gc_intf.stats, [> `Msg of string ]) result -> unit Lwt.t) -> X.Repo.t -> XKey.t -> (bool, [> `Msg of string ]) result Lwt.t
val is_allowed : X.Repo.t -> bool
val cancel : X.Repo.t -> bool