veilid-tools 0.5.4

A collection of baseline tools for Rust development use by Veilid and Veilid-enabled Rust applications
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
115
116
117
118
119
120
121
122
123
124
125

use super::*;

/// A [`backtrace::Backtrace`] whose [`fmt::Display`] output drops runtime and panic-machinery
/// frames (backtrace, tokio, async-lock, panic/unwind internals) and shortens paths relative to
/// the current directory.
pub struct TrimmedBacktrace {
    backtrace: backtrace::Backtrace,
}

impl TrimmedBacktrace {
    /// Resolve and wrap a backtrace for trimmed display.
    #[must_use]
    pub fn new(mut backtrace: backtrace::Backtrace) -> Self {
        backtrace.resolve();
        Self { backtrace }
    }

    /// Borrow the underlying backtrace.
    #[must_use]
    pub fn backtrace(&self) -> &backtrace::Backtrace {
        &self.backtrace
    }

    /// Mutably borrow the underlying backtrace.
    #[must_use]
    pub fn backtrace_mut(&mut self) -> &mut backtrace::Backtrace {
        &mut self.backtrace
    }

    fn format_display(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let cwd = std::env::current_dir();
        let mut print_path =
            move |f: &mut fmt::Formatter<'_>, path: backtrace::BytesOrWideString<'_>| {
                let path = path.into_path_buf();
                if let Ok(cwd) = &cwd {
                    if let Ok(suffix) = path.strip_prefix(cwd) {
                        return fmt::Display::fmt(&suffix.display(), f);
                    }
                }
                fmt::Display::fmt(&path.display(), f)
            };

        let mut f = backtrace::BacktraceFmt::new(f, backtrace::PrintFmt::Short, &mut print_path);
        f.add_context()?;
        'frame_loop: for frame in self.backtrace.frames() {
            let mut frame_fmt = f.frame();

            let symbols = frame.symbols();
            for symbol in symbols {
                let symbol_name = symbol.name().map(|x| x.to_string()).unwrap_or_default();

                // Trim: Don't print lines with certain symbols
                if symbol_name.starts_with("backtrace::")
                    || symbol_name.starts_with("veilid_tools::async_locks::")
                    || symbol_name.starts_with("<tracing::instrument::Instrumented")
                    || symbol_name.starts_with("<core::pin::Pin<")
                    || symbol_name.starts_with("<core::panic::")
                    || symbol_name.starts_with("tokio::runtime::")
                    || symbol_name.starts_with("tokio::loom::")
                    || symbol_name.starts_with("std::panicking::")
                    || symbol_name.starts_with("std::panic::")
                {
                    continue 'frame_loop;
                }

                // Trim: Stop the backtrace at the first rust try/unwind frame
                if symbol_name.starts_with("___rust_try") {
                    break 'frame_loop;
                }

                frame_fmt.backtrace_symbol(frame, symbol)?;
            }
            if symbols.is_empty() {
                // Trim: don't print raw frames
                // frame_fmt.print_raw(frame.ip(), None, None, None)?;
            }
        }
        f.finish()?;
        Ok(())
    }
}

impl core::ops::Deref for TrimmedBacktrace {
    type Target = backtrace::Backtrace;

    fn deref(&self) -> &Self::Target {
        self.backtrace()
    }
}

impl core::ops::DerefMut for TrimmedBacktrace {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.backtrace_mut()
    }
}

/// Wrap a backtrace in a [`TrimmedBacktrace`].
pub trait TrimBacktraceTrait {
    /// Clone this backtrace into a [`TrimmedBacktrace`] for trimmed display.
    fn trim(&self) -> TrimmedBacktrace;
}

impl TrimBacktraceTrait for backtrace::Backtrace {
    fn trim(&self) -> TrimmedBacktrace {
        TrimmedBacktrace::new(self.clone())
    }
}

impl From<TrimmedBacktrace> for backtrace::Backtrace {
    fn from(value: TrimmedBacktrace) -> Self {
        value.backtrace
    }
}

impl fmt::Display for TrimmedBacktrace {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.format_display(f)
    }
}

impl fmt::Debug for TrimmedBacktrace {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.backtrace.fmt(f)
    }
}