Module `Make.File_manager`Source

Sourcemodule Io : sig ... end

Sourcemodule Control : sig ... end

Sourcemodule Dict : sig ... end

Sourcemodule Suffix : sig ... end

Sourcemodule Index : sig ... end

Sourcemodule Errs : sig ... end

Sourcemodule Mapping_file : sig ... end

Sourcetype t

Sourceval control : t -> Control.t

Sourceval dict : t -> Dict.t

Sourceval suffix : t -> Suffix.t

Sourceval index : t -> Index.t

Sourceval mapping : t -> Mapping_file.t option

Sourceval prefix : t -> Io.t option

Source

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

Source

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

Source

val open_ro : 
  Irmin.Backend.Conf.t ->
  (t,
    [> `Closed
    | `Corrupted_control_file
    | `Corrupted_mapping_file of string
    | `File_exists of string
    | `Inconsistent_store
    | `Index_failure of string
    | `Invalid_argument
    | `Io_misc of Io.misc_error
    | `Migration_needed
    | `No_such_file_or_directory
    | `Not_a_file
    | `Read_out_of_bounds
    | `Ro_not_allowed
    | `Unknown_major_pack_version of string
    | `V3_store_from_the_future ])
    result

Source

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

Source

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

Source

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

Source

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

Source

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

Sourceval register_suffix_consumer : t -> after_flush:(unit -> unit) -> unit

Source

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

Source

val swap : 
  t ->
  generation:int ->
  right_start_offset:Optint.Int63.t ->
  right_end_offset:Optint.Int63.t ->
  (unit, [> Errs.t ]) result

Source

val write_gc_output : 
  root:string ->
  generation:int ->
  (Optint.Int63.t, Errs.t) result ->
  (unit,
    [> `Closed
    | `Double_close
    | `File_exists of string
    | `Io_misc of Io.misc_error
    | `Ro_not_allowed ])
    result

Sourcetype read_gc_output_error = [

| `Corrupted_gc_result_file of string
| `Gc_process_error of string

]

Sourceval read_gc_output_error_t : read_gc_output_error Irmin.Type.t

Source

val read_gc_output : 
  root:string ->
  generation:int ->
  (Optint.Int63.t, [> read_gc_output_error ]) result

Sourceval readonly : t -> bool

Sourceval generation : t -> int

Sourceval gc_allowed : t -> bool

Install

Dune Dependency

Authors

Maintainers

Sources

doc/irmin-pack.unix/Irmin_pack_unix/Maker/Make/File_manager/index.html

Module `Make.File_manager`Source

package irmin-pack

Install

Dune Dependency

Authors

Maintainers

Sources

doc/irmin-pack.unix/Irmin_pack_unix/Maker/Make/File_manager/index.html

Module Make.File_managerSource

Module `Make.File_manager`Source