package irmin-pack

  1. Overview
  2. Docs
package irmin-pack
Legend:
Library
Module
Module type
Parameter
Class
Class type
val cancel : t -> bool
val direct_commit_key : t -> Commit.CA.hash Pack_key.t -> (Commit.CA.hash Pack_key.t, [> `Commit_key_is_dangling of string ]) Stdlib.result
val start : unlink:bool -> use_auto_finalisation:bool -> new_files_path:string -> t -> XKey.t -> (unit, [> `Commit_key_is_dangling of string | `Gc_disallowed | `Gc_forbidden_during_batch ]) Stdlib.result
val start_exn : ?unlink:bool -> use_auto_finalisation:bool -> new_files_path:string -> t -> XKey.t -> bool Lwt.t
val finalise_exn : ?wait:bool -> t -> [> `Finalised of Stats.Latest_gc.stats | `Idle | `Running ] Lwt.t
val is_finished : t -> bool
val on_finalise : t -> ((Stats.Latest_gc.stats, Gc.Args.Errs.t) Stdlib.result -> unit Lwt.t) -> unit
val try_auto_finalise_exn : t -> unit Lwt.t
val latest_gc_target : t -> Commit.CA.hash Pack_key.t option
val create_one_commit_store : t -> Commit.CA.hash Pack_key.t -> string -> unit Lwt.t