package irmin-pack

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
val start : unlink:bool -> use_auto_finalisation:bool -> t -> XKey.t -> (unit, [> `Commit_key_is_dangling of string | `Gc_disallowed | `Gc_forbidden_during_batch ]) Stdlib.result
val open_new_suffix : root:string -> generation:int -> end_offset:Optint.Int63.t -> (Aof.t, [> `Closed | `Inconsistent_store | `Invalid_argument | `Io_misc of Aof.Io.misc_error | `No_such_file_or_directory | `Not_a_file | `Read_out_of_bounds ]) Stdlib.result
val transfer_latest_newies : generation:int -> right_start_offset:Optint.Int63.t -> copy_end_offset:Optint.Int63.t -> root:string -> t -> (Optint.Int63.t, [> Errs.t ]) Stdlib.result
val swap_and_purge : generation:int -> right_start_offset:Optint.Int63.t -> right_end_offset:Optint.Int63.t -> t -> (unit, [> File_manager.Errs.t ]) Stdlib.result
val pp_status : Async.status Irmin.Type.pp
val pp_gc_error : File_manager.read_gc_output_error Irmin.Type.pp
val gc_errors : [< `Cancelled | `Failure of string | `Running | `Success ] -> ('a, [< `Corrupted_gc_result_file of string & string & string | `Gc_process_error of string & string & string ]) Stdlib.result -> ('b, [> `Gc_process_died_without_result_file of string | `Gc_process_error of string ]) Stdlib.result
val finalise : wait:bool -> t -> ([> `Finalised of gc_stats | `Idle | `Running ], [> File_manager.Errs.t ]) Stdlib.result Lwt.t
val start_or_skip : unlink:bool -> use_auto_finalisation:bool -> t -> XKey.t -> (bool, [> `Commit_key_is_dangling of string | `Gc_disallowed | `Gc_forbidden_during_batch ]) Lwt_result.t
val start_exn : ?unlink:bool -> use_auto_finalisation:bool -> t -> XKey.t -> bool Lwt.t
val finalise_exn : ?wait:bool -> t -> [> `Finalised of gc_stats | `Idle | `Running ] Lwt.t
val is_finished : t -> bool
val on_finalise : t -> ((gc_stats, Errs.t) Stdlib.result -> 'a Lwt.t) -> unit
val try_auto_finalise_exn : t -> unit Lwt.t
OCaml

Innovation. Community. Security.