package irmin-pack

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Io : sig ... end
module Control : sig ... end
module Dict : sig ... end
module Suffix : sig ... end
module Index : sig ... end
module Errs : sig ... end
module Mapping_file : sig ... end
type t = Fm.t
val control : t -> Control.t
val dict : t -> Dict.t
val suffix : t -> Suffix.t
val index : t -> Index.t
val mapping : t -> Mapping_file.t option
val prefix : t -> Io.t option
val create_rw : overwrite:bool -> Irmin.Backend.Conf.t -> (t, [> `Closed | `Corrupted_mapping_file of string | `File_exists of string | `Index_failure of string | `Invalid_parent_directory | `Io_misc of Io.misc_error | `No_such_file_or_directory | `Not_a_directory of string | `Not_a_file | `Ro_not_allowed ]) result
val open_rw : Irmin.Backend.Conf.t -> (t, [> `Closed | `Corrupted_control_file | `Corrupted_mapping_file of string | `Double_close | `File_exists of string | `Inconsistent_store | `Index_failure of string | `Invalid_argument | `Invalid_layout | `Io_misc of Control.Io.misc_error | `Migration_needed | `No_such_file_or_directory | `Not_a_directory of string | `Not_a_file | `Only_minimal_indexing_strategy_allowed | `Read_out_of_bounds | `Ro_not_allowed | `Sys_error of string | `Unknown_major_pack_version of string | `V3_store_from_the_future ]) result
val open_ro : Irmin.Backend.Conf.t -> (t, [> `Closed | `Corrupted_control_file | `Corrupted_mapping_file of string | `Inconsistent_store | `Index_failure of string | `Invalid_argument | `Invalid_layout | `Io_misc of Io.misc_error | `Migration_needed | `No_such_file_or_directory | `Not_a_file | `Read_out_of_bounds | `Unknown_major_pack_version of string | `V3_store_from_the_future ]) result
val close : t -> (unit, [> `Double_close | `Index_failure of string | `Io_misc of Io.misc_error | `Pending_flush | `Ro_not_allowed ]) result
val flush : ?hook:([ `After_dict | `After_suffix ] -> unit) -> t -> (unit, [> `Closed | `Index_failure of string | `Io_misc of Io.misc_error | `Ro_not_allowed ]) result
val fsync : t -> (unit, [> `Closed | `Index_failure of string | `Io_misc of Io.misc_error | `Ro_not_allowed ]) result
val reload : ?hook:([ `After_control | `After_index | `After_suffix ] -> unit) -> t -> (unit, [> Errs.t ]) result
val register_dict_consumer : t -> after_reload:(unit -> (unit, Errs.t) result) -> unit
val register_suffix_consumer : t -> after_flush:(unit -> unit) -> unit
val version : root:string -> (Irmin_pack.Version.t, [> `Corrupted_control_file | `Corrupted_legacy_file | `Invalid_layout | `Io_misc of Io.misc_error | `No_such_file_or_directory | `Not_a_directory of string | `Unknown_major_pack_version of string ]) result
val cleanup : root:string -> generation:int -> unit
val swap : t -> generation:int -> new_suffix_start_offset:Optint.Int63.t -> new_suffix_end_offset:Optint.Int63.t -> (unit, [> Errs.t ]) result
val readonly : t -> bool
val generation : t -> int
val gc_allowed : t -> bool