panic-log 0.3.1

Log panics to the `log` macro as error
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

#![doc = include_str!("../README.md")]

use std::{backtrace, panic, thread};

pub struct Configuration {
    /// Always force capture a backtrace.
    ///
    /// If false, the presence of a backtrace will depend on the value of `RUST_BACKTRACE`.
    /// See [`std::backtrace::Backtrace`] for more info
    pub force_capture: bool,

    /// Keep the originally set panic hook, continuing any normal panic behaviour
    /// and custom panic behaviour set.
    pub keep_original_hook: bool,

    /// When set, flush the given logger after we invoke `log::error!()`
    pub logger: Option<&'static dyn log::Log>,
}

impl Default for Configuration {
    fn default() -> Self {
        Self {
            force_capture: false,
            keep_original_hook: true,
            logger: None,
        }
    }
}

pub fn initialize_hook(config: Configuration) {
    let original_hook = if config.keep_original_hook {
        Some(panic::take_hook())
    } else {
        None
    };
    panic::set_hook(Box::new(move |info| {
        let thread_name = thread::current()
            .name()
            .unwrap_or("<unnamed thread>")
            .to_owned();

        let location = if let Some(panic_location) = info.location() {
            format!(
                "{}:{}:{}",
                panic_location.file(),
                panic_location.line(),
                panic_location.column()
            )
        } else {
            "<unknown location>".to_owned()
        };
        let message = info
            .payload()
            .downcast_ref::<&str>()
            .copied()
            .or_else(|| info.payload().downcast_ref::<String>().map(|s| s.as_str()))
            .unwrap_or("<message is not a string>");

        let backtrace = if config.force_capture {
            backtrace::Backtrace::force_capture()
        } else {
            backtrace::Backtrace::capture()
        };

        log::error!("thread '{thread_name}' panicked at {location}:\n{message}\nstack backtrace:\n{backtrace}");

        if let Some(logger) = config.logger {
            logger.flush();
        }

        if let Some(original_hook) = &original_hook {
            original_hook(info);
        }
    }));
}