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
|
use failure::{Backtrace, Context, Fail};
use std::fmt::{self, Debug, Display};
/// Kinds of errors which might happen during the generation of an archive
#[derive(Debug, Fail)]
pub enum CompressionErrorKind {
/// This error will occur if the directory name could not be retrieved from the path
/// See https://doc.rust-lang.org/std/path/struct.Path.html#method.file_name
#[fail(display = "Invalid path: directory name terminates in \"..\"")]
InvalidDirectoryName,
/// This error will occur when trying to convert an OSString into a String, if the path
/// contains invalid UTF-8 characters
/// See https://doc.rust-lang.org/std/ffi/struct.OsStr.html#method.to_str
#[fail(display = "Invalid path: directory name contains invalid UTF-8 characters")]
InvalidUTF8DirectoryName,
/// This error might occur while building a TAR archive, or while writing the termination sections
/// See https://docs.rs/tar/0.4.22/tar/struct.Builder.html#method.append_dir_all
/// and https://docs.rs/tar/0.4.22/tar/struct.Builder.html#method.into_inner
#[fail(display = "Failed to create the TAR archive: {}", message)]
TarBuildingError { message: String },
/// This error might occur while building a GZIP archive, or while writing the GZIP trailer
/// See https://docs.rs/libflate/0.1.21/libflate/gzip/struct.Encoder.html#method.finish
#[fail(display = "Failed to create the GZIP archive: {}", message)]
GZipBuildingError { message: String },
}
/// Prints the full chain of error, up to the root cause.
/// If RUST_BACKTRACE is set to 1, also prints the backtrace for each error
pub fn print_error_chain(err: CompressionError) {
log::error!("{}", &err);
print_backtrace(&err);
for cause in Fail::iter_causes(&err) {
log::error!("caused by: {}", cause);
print_backtrace(cause);
}
}
/// Prints the backtrace of an error
/// RUST_BACKTRACE needs to be set to 1 to display the backtrace
fn print_backtrace(err: &dyn Fail) {
if let Some(backtrace) = err.backtrace() {
let backtrace = backtrace.to_string();
if backtrace != "" {
log::error!("{}", backtrace);
}
}
}
/// Based on https://boats.gitlab.io/failure/error-errorkind.html
pub struct CompressionError {
inner: Context<CompressionErrorKind>,
}
impl CompressionError {
pub fn new(kind: CompressionErrorKind) -> CompressionError {
CompressionError {
inner: Context::new(kind),
}
}
}
impl Fail for CompressionError {
fn cause(&self) -> Option<&Fail> {
self.inner.cause()
}
fn backtrace(&self) -> Option<&Backtrace> {
self.inner.backtrace()
}
}
impl Display for CompressionError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
Display::fmt(&self.inner, f)
}
}
impl Debug for CompressionError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
Debug::fmt(&self.inner, f)
}
}
impl From<Context<CompressionErrorKind>> for CompressionError {
fn from(inner: Context<CompressionErrorKind>) -> CompressionError {
CompressionError { inner }
}
}
impl From<CompressionErrorKind> for CompressionError {
fn from(kind: CompressionErrorKind) -> CompressionError {
CompressionError {
inner: Context::new(kind),
}
}
}
|