irmin-pack 3.5.2 · OCaml Package

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

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 ])
    Stdlib.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 ])
    Stdlib.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 ])
    Stdlib.result

val close : 
  t ->
  (unit,
    [> `Double_close
    | `Index_failure of string
    | `Io_misc of Io.misc_error
    | `Pending_flush
    | `Ro_not_allowed ])
    Stdlib.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 ])
    Stdlib.result

val fsync : 
  t ->
  (unit,
    [> `Closed
    | `Index_failure of string
    | `Io_misc of Io.misc_error
    | `Ro_not_allowed ])
    Stdlib.result

val reload : 
  ?hook:([ `After_control | `After_index | `After_suffix ] -> unit) ->
  t ->
  (unit, [> Errs.t ]) Stdlib.result

val register_dict_consumer : 
  t ->
  after_reload:(unit -> (unit, Errs.t) Stdlib.result) ->
  unit

val register_prefix_consumer : 
  t ->
  after_reload:(unit -> (unit, Errs.t) Stdlib.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 ])
    Stdlib.result

val cleanup : t -> unit

val swap : 
  t ->
  generation:int ->
  suffix_start_offset:Optint.Int63.t ->
  chunk_start_idx:int ->
  chunk_num:int ->
  suffix_dead_bytes:Optint.Int63.t ->
  latest_gc_target_offset:Optint.Int63.t ->
  (unit, [> Errs.t ]) Stdlib.result

val readonly : t -> bool

val generation : t -> int

val gc_allowed : t -> bool

val split : t -> (unit, [> Errs.t ]) Stdlib.result

val create_one_commit_store : 
  t ->
  Irmin.Backend.Conf.t ->
  generation:int ->
  latest_gc_target_offset:Optint.Int63.t ->
  suffix_start_offset:Optint.Int63.t ->
  Index.key Pack_key.t ->
  (unit,
    [> `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
    | `Pending_flush
    | `Read_out_of_bounds
    | `Ro_not_allowed
    | `Sys_error of string
    | `Unknown_major_pack_version of string
    | `V3_store_from_the_future ])
    Stdlib.result

package irmin-pack