Merge pull request #19110 from eagr/panic-context

Simplify panic_context
This commit is contained in:
Lukas Wirth 2025-02-12 13:41:11 +00:00 committed by GitHub
commit aa64a6da0e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,48 +1,44 @@
//! A micro-crate to enhance panic messages with context info.
//!
//! FIXME: upstream to <https://github.com/kriomant/panic-context> ?
use std::{cell::RefCell, panic, sync::Once};
pub fn enter(context: String) -> PanicContext {
static ONCE: Once = Once::new();
ONCE.call_once(PanicContext::init);
with_ctx(|ctx| ctx.push(context));
PanicContext { _priv: () }
}
/// Dummy for leveraging RAII cleanup to pop frames.
#[must_use]
pub struct PanicContext {
// prevent arbitrary construction
_priv: (),
}
impl PanicContext {
#[allow(clippy::print_stderr)]
fn init() {
let default_hook = panic::take_hook();
#[allow(deprecated)]
let hook = move |panic_info: &panic::PanicInfo<'_>| {
with_ctx(|ctx| {
if !ctx.is_empty() {
eprintln!("Panic context:");
for frame in ctx.iter() {
eprintln!("> {frame}\n");
}
}
default_hook(panic_info);
});
};
panic::set_hook(Box::new(hook));
}
}
impl Drop for PanicContext {
fn drop(&mut self) {
with_ctx(|ctx| assert!(ctx.pop().is_some()));
}
}
pub fn enter(frame: String) -> PanicContext {
#[allow(clippy::print_stderr)]
fn set_hook() {
let default_hook = panic::take_hook();
panic::set_hook(Box::new(move |panic_info| {
with_ctx(|ctx| {
if !ctx.is_empty() {
eprintln!("Panic context:");
for frame in ctx.iter() {
eprintln!("> {frame}\n");
}
}
});
default_hook(panic_info);
}));
}
static SET_HOOK: Once = Once::new();
SET_HOOK.call_once(set_hook);
with_ctx(|ctx| ctx.push(frame));
PanicContext { _priv: () }
}
fn with_ctx(f: impl FnOnce(&mut Vec<String>)) {
thread_local! {
static CTX: RefCell<Vec<String>> = const { RefCell::new(Vec::new()) };