package irmin-pack

  1. Overview
  2. Docs
package irmin-pack
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file errors_base.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
(*
 * Copyright (c) 2022-2022 Tarides <contact@tarides.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

type error =
  [ `Double_close
  | `File_exists of string
  | `Invalid_parent_directory
  | `No_such_file_or_directory
  | `Not_a_file
  | `Read_on_closed
  | `Read_out_of_bounds
  | `Ro_not_allowed
  | `Write_on_closed
  | `Invalid_argument
  | `Decoding_error
  | `Not_a_directory of string
  | `Index_failure of string
  | `Invalid_layout
  | `Corrupted_legacy_file
  | `Pending_flush
  | `Rw_not_allowed
  | `Migration_needed
  | `Corrupted_control_file
  | `Sys_error of string
  | `V3_store_from_the_future
  | `Unknown_major_pack_version of string ]
[@@deriving irmin ~pp]
(** [error] is the type of all errors that can occur in a [result], except
    [`Io_misc] which depends on the Io module used. *)

type error' =
  [ `Double_close
  | `File_exists of string
  | `Invalid_parent_directory
  | `No_such_file_or_directory
  | `Not_a_file
  | `Read_on_closed
  | `Read_out_of_bounds
  | `Write_on_closed
  | `Invalid_argument
  | `Decoding_error
  | `Not_a_directory of string
  | `Index_failure of string
  | `Invalid_layout
  | `Corrupted_legacy_file
  | `Pending_flush
  | `Rw_not_allowed
  | `Migration_needed
  | `Corrupted_control_file
  | `V3_store_from_the_future
  | `Sys_error of string
  | `V3_store_from_the_future
  | `Unknown_major_pack_version of string ]
(** [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'

let () =
  Printexc.register_printer (function
    | Pack_error e ->
        Some (Fmt.str "Pack_error: %a" pp_error (e : error' :> error))
    | _ -> None)

exception RO_not_allowed = Irmin_pack.RO_not_allowed
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