tracerr 0.5.0

Custom compile-time captured error tracing.
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

//! Error trace.

use std::{
    fmt,
    ops::{Deref, DerefMut},
};

use derive_more::with_trait::Display;

/// Captured frame of [`Trace`].
#[derive(Clone, Copy, Debug, Display)]
#[display("{module}\n  at {file}:{line}")]
pub struct Frame {
    /// Name of source file where [`Frame`] is captured.
    pub file: &'static str,

    /// Line number in source file where [`Frame`] is captured.
    pub line: u32,

    /// Absolute name of module where [`Frame`] is captured.
    pub module: &'static str,
}

/// Captures and returns new [`Frame`] in the macro invocation place.
#[macro_export]
macro_rules! new_frame {
    () => {
        $crate::Frame { file: file!(), line: line!(), module: module_path!() }
    };
}

/// Trace composed from captured [`Frame`]s.
#[derive(Clone, Debug)]
pub struct Trace(Vec<Frame>);

impl Trace {
    /// Creates and returns new [`Trace`] from the given [`Frame`]s.
    #[inline]
    #[must_use]
    pub const fn new(frames: Vec<Frame>) -> Self {
        Self(frames)
    }
}

impl Deref for Trace {
    type Target = Vec<Frame>;

    fn deref(&self) -> &Vec<Frame> {
        &self.0
    }
}

impl DerefMut for Trace {
    fn deref_mut(&mut self) -> &mut Vec<Frame> {
        &mut self.0
    }
}

impl Display for Trace {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "error trace:")?;
        for frame in &self.0 {
            write!(f, "\n{frame}")?;
        }
        Ok(())
    }
}

#[cfg(test)]
mod frame_spec {
    use super::Frame;

    #[test]
    fn displays_module_followed_by_file_and_line() {
        let frame = Frame { file: "my_file.rs", line: 32, module: "main::sub" };

        assert_eq!(frame.to_string(), "main::sub\n  at my_file.rs:32");
    }
}

#[cfg(test)]
mod trace_spec {
    use super::{Frame, Trace};

    #[test]
    fn displays_frames_separated_by_blank_line() {
        let stack = Trace(vec![
            Frame { file: "src/my_file.rs", line: 32, module: "main::sub1" },
            Frame {
                file: "anywhere/my_file.rs",
                line: 54,
                module: "main::sub2",
            },
            Frame { file: "file.rs", line: 232, module: "main::sub3" },
        ]);

        assert_eq!(
            format!("{stack}\n            "),
            r#"error trace:
main::sub1
  at src/my_file.rs:32
main::sub2
  at anywhere/my_file.rs:54
main::sub3
  at file.rs:232
            "#,
        );
    }
}