err-report 0.1.2

Clone of the unstable `std::error::Report` type
Documentation 
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

#![expect(missing_docs)]

use std::{error::Error as StdError, fmt, io};

use err_report::Report;

#[derive(Debug)]
struct WrappedError<E>(E);

impl<E> fmt::Display for WrappedError<E> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("Wrapped")
    }
}

impl<E> StdError for WrappedError<E>
where
    E: StdError + 'static,
{
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        Some(&self.0)
    }
}

#[test]
fn standalone_error_single_line() {
    assert_eq!(
        "Verbatim",
        Report::new(io::Error::other("Verbatim")).to_string(),
    );

    assert_eq!(
        "Passed non-utf8 string",
        Report::new(io::Error::new(
            io::ErrorKind::InvalidData,
            "Passed non-utf8 string"
        ))
        .to_string(),
    );
}

#[test]
fn wrapped_error_single_line() {
    assert_eq!(
        "Wrapped: Verbatim",
        Report::new(WrappedError(io::Error::other("Verbatim"))).to_string(),
    );

    assert_eq!(
        "Wrapped: Passed non-utf8 string",
        Report::new(WrappedError(io::Error::new(
            io::ErrorKind::InvalidData,
            "Passed non-utf8 string"
        )))
        .to_string(),
    );
}

#[test]
fn standalone_error_pretty() {
    assert_eq!(
        "Verbatim",
        Report::new(io::Error::other("Verbatim"))
            .pretty(true)
            .to_string(),
    );

    assert_eq!(
        "Passed non-utf8 string",
        Report::new(io::Error::new(
            io::ErrorKind::InvalidData,
            "Passed non-utf8 string"
        ))
        .pretty(true)
        .to_string(),
    );
}

#[test]
fn wrapped_error_pretty() {
    assert_eq!(
        indoc::indoc! {"
            Wrapped
            
            Caused by:
                  Verbatim"},
        Report::new(WrappedError(io::Error::other("Verbatim")))
            .pretty(true)
            .to_string(),
    );

    assert_eq!(
        indoc::indoc! {"
            Wrapped

            Caused by:
                  Root error"},
        Report::new(WrappedError(io::Error::other("Root error")))
            .pretty(true)
            .to_string(),
    );

    assert_eq!(
        indoc::indoc! {"
            Wrapped

            Caused by:
               0: Wrapped
               1: Root error"},
        Report::new(WrappedError(WrappedError(io::Error::other("Root error"))))
            .pretty(true)
            .to_string(),
    );
}