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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
//! Product-level failures while loading and parsing one native manual.
use std::{
fmt,
path::{Path, PathBuf},
};
use libmandoc_rs::ParseError;
/// Stable category for a native manual failure.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ManualErrorKind {
/// Source bytes could not be read.
Read,
/// Compressed source bytes could not be decoded.
Decompression,
/// A configured resource bound was exceeded.
Limit,
/// A path or redirect crossed the approved manual tree.
UnsafePath,
/// A native alias redirect was invalid or could not be resolved.
Redirect,
/// libmandoc rejected or could not represent the source.
Parse,
}
/// Failure produced by `ManT`'s source policy or by the underlying roff parser.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ManualError {
/// Filesystem read failure.
Read {
/// Original source path.
path: PathBuf,
/// Stable human-readable detail.
message: String,
},
/// Top-level decompression failure.
Decompression {
/// Original source path.
path: PathBuf,
/// Stable human-readable detail.
message: String,
},
/// Input resource limit violation.
Limit {
/// Original source path.
path: PathBuf,
/// Stable human-readable detail.
message: String,
},
/// Manual-tree containment policy violation.
UnsafePath {
/// Rejected source or target path.
path: PathBuf,
/// Stable human-readable detail.
message: String,
},
/// Invalid or unresolved `.so` alias page.
Redirect {
/// Alias source path.
path: PathBuf,
/// Stable human-readable detail.
message: String,
},
/// Failure reported by the low-level libmandoc binding.
Parse(ParseError),
}
impl ManualError {
pub(super) fn read(path: &Path, message: impl Into<String>) -> Self {
Self::Read {
path: path.to_path_buf(),
message: message.into(),
}
}
pub(super) fn decompression(path: &Path, message: impl Into<String>) -> Self {
Self::Decompression {
path: path.to_path_buf(),
message: message.into(),
}
}
pub(super) fn limit(path: &Path, message: impl Into<String>) -> Self {
Self::Limit {
path: path.to_path_buf(),
message: message.into(),
}
}
pub(super) fn unsafe_path(path: &Path, message: impl Into<String>) -> Self {
Self::UnsafePath {
path: path.to_path_buf(),
message: message.into(),
}
}
pub(super) fn redirect(path: &Path, message: impl Into<String>) -> Self {
Self::Redirect {
path: path.to_path_buf(),
message: message.into(),
}
}
#[must_use]
/// Return the stable failure category.
pub const fn kind(&self) -> ManualErrorKind {
match self {
Self::Read { .. } => ManualErrorKind::Read,
Self::Decompression { .. } => ManualErrorKind::Decompression,
Self::Limit { .. } => ManualErrorKind::Limit,
Self::UnsafePath { .. } => ManualErrorKind::UnsafePath,
Self::Redirect { .. } => ManualErrorKind::Redirect,
Self::Parse(_) => ManualErrorKind::Parse,
}
}
#[must_use]
/// Return the original caller-facing source path.
pub fn path(&self) -> &Path {
match self {
Self::Read { path, .. }
| Self::Decompression { path, .. }
| Self::Limit { path, .. }
| Self::UnsafePath { path, .. }
| Self::Redirect { path, .. } => path,
Self::Parse(error) => &error.path,
}
}
#[must_use]
/// Return the stable human-readable detail.
pub fn message(&self) -> &str {
match self {
Self::Read { message, .. }
| Self::Decompression { message, .. }
| Self::Limit { message, .. }
| Self::UnsafePath { message, .. }
| Self::Redirect { message, .. } => message,
Self::Parse(error) => &error.message,
}
}
}
impl From<ParseError> for ManualError {
fn from(error: ParseError) -> Self {
Self::Parse(error)
}
}
impl fmt::Display for ManualError {
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(formatter, "{}: {}", self.path().display(), self.message())
}
}
impl std::error::Error for ManualError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
Self::Parse(error) => Some(error),
Self::Read { .. }
| Self::Decompression { .. }
| Self::Limit { .. }
| Self::UnsafePath { .. }
| Self::Redirect { .. } => None,
}
}
}