thiserror-ext 0.4.0-alpha

Useful extension utilities for `thiserror`.
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

/// Provides backtrace to the error.
pub trait WithBacktrace {
    /// Capture backtrace based on whether the error already has one.
    fn capture(inner: &dyn core::error::Error) -> Self;

    #[cfg(feature = "std")]
    /// Get the captured backtrace, if any.
    fn backtrace(&self) -> Option<&std::backtrace::Backtrace>;

    #[cfg(feature = "nightly")]
    /// Provide the backtrace, if any.
    fn provide<'a>(&'a self, request: &mut core::error::Request<'a>);
}

/// Do not capture extra backtrace.
#[derive(Clone, Copy)]
pub struct NoExtraBacktrace;

impl WithBacktrace for NoExtraBacktrace {
    fn capture(_inner: &dyn core::error::Error) -> Self {
        Self
    }

    #[cfg(feature = "std")]
    fn backtrace(&self) -> Option<&std::backtrace::Backtrace> {
        None
    }

    #[cfg(feature = "nightly")]
    fn provide<'a>(&'a self, _request: &mut core::error::Request<'a>) {}
}

#[cfg(feature = "std")]
mod always {
    use super::WithBacktrace;
    use std::backtrace::Backtrace;

    /// Always capture a new backtrace.
    pub struct AlwaysBacktrace(Backtrace);

    impl WithBacktrace for AlwaysBacktrace {
        fn capture(_inner: &dyn core::error::Error) -> Self {
            Self(Backtrace::capture())
        }

        fn backtrace(&self) -> Option<&Backtrace> {
            Some(&self.0)
        }

        #[cfg(feature = "nightly")]
        fn provide<'a>(&'a self, request: &mut core::error::Request<'a>) {
            request.provide_ref(&self.0);
        }
    }
}

#[cfg(feature = "std")]
pub use always::AlwaysBacktrace;

#[cfg(feature = "nightly")]
mod maybe {
    use super::WithBacktrace;
    use std::backtrace::Backtrace;

    /// Capture backtrace if the error does not already have one.
    pub struct MaybeBacktrace(Option<Backtrace>);

    impl WithBacktrace for MaybeBacktrace {
        fn capture(inner: &dyn core::error::Error) -> Self {
            let inner = if core::error::request_ref::<Backtrace>(inner).is_none() {
                Some(Backtrace::capture())
            } else {
                None
            };
            Self(inner)
        }

        fn backtrace(&self) -> Option<&Backtrace> {
            self.0.as_ref()
        }

        fn provide<'a>(&'a self, request: &mut core::error::Request<'a>) {
            if let Some(backtrace) = &self.0 {
                request.provide_ref(backtrace);
            }
        }
    }
}

#[cfg(feature = "nightly")]
pub use maybe::MaybeBacktrace;