package irmin-pack

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type error = [
  1. | `Double_close
  2. | `File_exists of string
  3. | `Invalid_parent_directory
  4. | `No_such_file_or_directory
  5. | `Not_a_file
  6. | `Read_on_closed
  7. | `Read_out_of_bounds
  8. | `Ro_not_allowed
  9. | `Write_on_closed
  10. | `Invalid_argument
  11. | `Decoding_error
  12. | `Not_a_directory of string
  13. | `Index_failure of string
  14. | `Invalid_layout
  15. | `Corrupted_legacy_file
  16. | `Pending_flush
  17. | `Rw_not_allowed
  18. | `Migration_needed
  19. | `Corrupted_control_file
  20. | `Sys_error of string
  21. | `V3_store_from_the_future
  22. | `Unknown_major_pack_version of string
  23. | `Inconsistent_store
]

error is the type of all errors that can occur in a result, except `Io_misc which depends on the Io module used.

val error_t : [ `Corrupted_control_file | `Corrupted_legacy_file | `Decoding_error | `Double_close | `File_exists of string | `Inconsistent_store | `Index_failure of string | `Invalid_argument | `Invalid_layout | `Invalid_parent_directory | `Migration_needed | `No_such_file_or_directory | `Not_a_directory of string | `Not_a_file | `Pending_flush | `Read_on_closed | `Read_out_of_bounds | `Ro_not_allowed | `Rw_not_allowed | `Sys_error of string | `Unknown_major_pack_version of string | `V3_store_from_the_future | `Write_on_closed ] Irmin.Type.t
val pp_error : [ `Corrupted_control_file | `Corrupted_legacy_file | `Decoding_error | `Double_close | `File_exists of string | `Inconsistent_store | `Index_failure of string | `Invalid_argument | `Invalid_layout | `Invalid_parent_directory | `Migration_needed | `No_such_file_or_directory | `Not_a_directory of string | `Not_a_file | `Pending_flush | `Read_on_closed | `Read_out_of_bounds | `Ro_not_allowed | `Rw_not_allowed | `Sys_error of string | `Unknown_major_pack_version of string | `V3_store_from_the_future | `Write_on_closed ] Repr.pp
type error' = [
  1. | `Double_close
  2. | `File_exists of string
  3. | `Invalid_parent_directory
  4. | `No_such_file_or_directory
  5. | `Not_a_file
  6. | `Read_on_closed
  7. | `Read_out_of_bounds
  8. | `Write_on_closed
  9. | `Invalid_argument
  10. | `Decoding_error
  11. | `Not_a_directory of string
  12. | `Index_failure of string
  13. | `Invalid_layout
  14. | `Corrupted_legacy_file
  15. | `Pending_flush
  16. | `Rw_not_allowed
  17. | `Migration_needed
  18. | `Corrupted_control_file
  19. | `V3_store_from_the_future
  20. | `Sys_error of string
  21. | `V3_store_from_the_future
  22. | `Unknown_major_pack_version of string
  23. | `Inconsistent_store
]

error' is the payload of the Pack_error exception.

error' is error without `Ro_not_allowed, because there exist a dedicated RO_not_allowed exception.

We can't use polyval inclusion because repr doesn't support it

exception Pack_error of error'
exception RO_not_allowed
module type S = sig ... end
module Make (Io : Io.S) : S with module Io = Io