ebacktrace 0.5.1

A simple error wrapper which captures a backtrace and can carry an optional textual description
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

//! Implements a backtrace

use std::{ 
    fmt::{ self, Debug, Display, Formatter },
    sync::{ Arc, Mutex }
};


/// The "raw" underlying backtrace
#[derive(Debug)]
struct BacktraceRaw {
    /// The wrapped backtrace; will use `std::backtrace` once it is stable
    backtrace: backtrace::Backtrace,
    /// The backtrace as human readable string
    readable: String
}
impl BacktraceRaw {
    /// Creates a new unresolved (=thin) backtrace
    pub fn new_thin() -> Self {
        Self { backtrace: backtrace::Backtrace::new_unresolved(), readable: String::new() }
    }

    /// Ensures that the backtrace has been resolved
    pub fn ensure_resolved(&mut self) {
        // Resolve the backtrace
        if self.readable.is_empty() {
            self.backtrace.resolve();
            self.readable = format!("{:?}", self.backtrace);
        }
    }
}


/// The backtrace implementation
#[derive(Clone)]
pub struct Backtrace {
    /// The wrapped backtrace; will use `std::backtrace` once it is stable
    inner: Arc<Mutex<BacktraceRaw>>
}
impl Backtrace {
    /// Captures a new backtrace if `RUST_BACKTRACE` is set
    #[inline]
    #[cfg(not(feature = "force_backtrace"))]
    pub fn capture() -> Option<Self> {
        // NOTE: Use full path to avoid "unused_imports"-errors when using "force_backtrace"
        let rust_backtrace = std::env::var("RUST_BACKTRACE").unwrap_or_default();
        if !matches!(rust_backtrace.as_str(), "1" | "true" | "full") {
            return None
        }

        // Capture the backtrace
        let backtrace = BacktraceRaw::new_thin();
        let this = Self { inner: Arc::new(Mutex::new(backtrace)) };
        Some(this)
    }

    /// Always captures a new backtrace
    #[inline]
    #[cfg(feature = "force_backtrace")]
    pub fn capture() -> Option<Self> {
        let backtrace = BacktraceRaw::new_thin();
        let this = Self { inner: Arc::new(Mutex::new(backtrace)) };
        Some(this)
    }
}
impl Debug for Backtrace {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        // Get exclusive access to the underlying backtrace
        let mut inner = match self.inner.lock() {
            Ok(inner) => inner,
            Err(inner) => inner.into_inner()
        };

        // Resolve backtrace if necessary and write the struct
        inner.ensure_resolved();
        f.debug_struct("Backtrace")
            .field("inner", &inner)
            .finish()
    }
}
impl Display for Backtrace {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        // Get exclusive access to the underlying backtrace
        let mut inner = match self.inner.lock() {
            Ok(inner) => inner,
            Err(inner) => inner.into_inner()
        };

        // Resolve backtrace if necessary and write the backtrace
        inner.ensure_resolved();
        write!(f, "{}", &inner.readable)
    }
}