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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
// =============================================================================
// USES
// =============================================================================
// -----------------------------------------------------------------------------
use crateStaticString;
use crateErrorEnvelope;
use crate::;
use ;
// =============================================================================
// TRAITS
// =============================================================================
/// A marker trait for a type that denotes a kind of error that took place.
///
/// These types are expected to be very simple enums, which contain only unit
/// variants denoting the kind of error that occurred.
///
/// If you want to compose an `ErrorKind` which is a combination of multiple
/// different `ErrorKind`, see the [`ErrorDomain`] trait.
///
/// [`ErrorDomain`]: crate::ErrorDomain
///
/// # Display Formatting
///
/// The derive macro for this trait will automatically implement `Display` for
/// you. The default process is to break the variant name into words, lowercase
/// it, and then separate the words by spaces.
///
/// ```rust
/// # use error_kind::ErrorKind;
/// #[derive(Clone, Copy, Debug, ErrorKind)]
/// enum IoErrorKind {
/// BadFileDescriptor, // Prints "bad file descriptor"
/// FileNotFound, // Prints "file not found"
/// // ...
/// }
/// ```
///
/// If you don't like a particular display format, you can change it with the
/// `#[error(...)]` attribute on a variant.
///
/// ```rust
/// # use error_kind::ErrorKind;
/// #[derive(Clone, Copy, Debug, ErrorKind)]
/// enum IoErrorKind {
/// BadFileDescriptor, // Prints "bad file descriptor"
/// #[error("custom display")]
/// FileNotFound, // Prints "custom display"
/// // ...
/// }
/// ```
///
/// # Examples
///
/// An error kind denotes a set of semantically related errors.
///
/// ```rust
/// # use error_kind::ErrorKind;
/// #[derive(Clone, Copy, Debug, ErrorKind)]
/// enum IoErrorKind {
/// BadFileDescriptor,
/// FileNotFound,
/// // ...
/// }
/// ```
///
/// You can define multiple kinds of errors by creating separate enums.
///
/// ```rust
/// # use error_kind::ErrorKind;
/// #[derive(Clone, Copy, Debug, ErrorKind)]
/// enum IoErrorKind {
/// BadFileDescriptor,
/// FileNotFound,
/// // ...
/// }
///
/// #[derive(Clone, Copy, Debug, ErrorKind)]
/// enum ParseErrorKind {
/// InvalidFormat,
/// UnexpectedEndOfData,
/// // ...
/// }
/// ```
// =============================================================================
// TRAIT IMPLS
// =============================================================================
// -----------------------------------------------------------------------------
// -----------------------------------------------------------------------------