package irmin-pack

  1. Overview
  2. Docs
package irmin-pack
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
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 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_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 swap : t -> generation:int -> right_start_offset:Optint.Int63.t -> right_end_offset:Optint.Int63.t -> (unit, [> Errs.t ]) Stdlib.result
val write_gc_output : root:string -> generation:int -> (Optint.Int63.t, Errs.t) Stdlib.result -> (unit, [> `Closed | `Double_close | `File_exists of string | `Io_misc of Io.misc_error | `Ro_not_allowed ]) Stdlib.result
type read_gc_output_error = [
  1. | `Corrupted_gc_result_file of string
  2. | `Gc_process_error of string
]
val read_gc_output_error_t : read_gc_output_error Irmin.Type.t
val read_gc_output : root:string -> generation:int -> (Optint.Int63.t, [> read_gc_output_error ]) Stdlib.result
val readonly : t -> bool
val generation : t -> int
val gc_allowed : t -> bool
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct