scoped-panic-hook

Crates.ioscoped-panic-hook
lib.rsscoped-panic-hook
version0.1.2
created_at2025-04-15 20:05:06.670281+00
updated_at2025-04-25 17:48:19.818578+00
descriptionAdds scoped, nestable, thread-local hooks for panics and some utilities for capturing and analyzing panics more conveniently
homepage
repositoryhttps://github.com/target-san/scoped-panic-hook
max_upload_size
id1635161
size41,235
Igor (target-san)

documentation

README

Convenient panic catcher and scoped panic hooks infrastructure

This crate provides convenient API for obtaining panic info after unwinding

    let result = catch_panic(|| {
        panic!("Something bad happened!");
    });

    if let Err(panic) = result {
        eprintln!("{}", panic.display_with_backtrace());
    }

This will either produce normal result of closure or or conveniently gathered panic info, which includes panic location, message, raw payload and backtrace

Useful modules

  • hook - raw scoped hook APIs
  • panic - all types and functions relevant to capturing panics, including some advanced features

Development

Project uses cargo-xtask pattern. Run cargo xtask to see available commands

Integration tests note

They're located in a separate unpublished subcrate. This is because most of them need to execute certain test case binary as a separate process and then analyze its output

Nightly features

Crate doesn't have separate feature nightly. Instead, it uses toolchain detection to automatically determine whether to use nightly features or not.

While API remains the same, some internal behaviors are changed

  • Global hook used to support scoped hooks is installed atomically, using update_hook instead of take_hook+set_hook
  • No-unwind panics are handled more correctly. In particular, if no-unwind panic happens as the first one, you'll see panic details anyway.
  • Backtrace print style used inside hook in no-unwind case is taken from std::panic::get_backtrace_style and is not hardcoded to short

These tweaks will be hopefully moved to stable version when related features are stabilized

Commit count: 52

cargo fmt