Struct `PanicHookInfo`

struct PanicHookInfo<'a> { ... }

A struct providing information about a panic.

PanicHookInfo structure is passed to a panic hook set by the set_hook function.

Examples

use std::panic;

panic::set_hook(Box::new(|panic_info| {
    println!("panic occurred: {panic_info}");
}));

panic!("critical system failure");

Implementations

`impl<'a> PanicHookInfo<'a>`

fn payload(self: &Self) -> &dyn Any + Send

Returns the payload associated with the panic.

This will commonly, but not always, be a &'static str or String. If you only care about such payloads, use payload_as_str instead.

A invocation of the panic!() macro in Rust 2021 or later will always result in a panic payload of type &'static str or String.

Only an invocation of panic_any (or, in Rust 2018 and earlier, panic!(x) where x is something other than a string) can result in a panic payload other than a &'static str or String.

Examples

use std::panic;

panic::set_hook(Box::new(|panic_info| {
    if let Some(s) = panic_info.payload().downcast_ref::<&str>() {
        println!("panic occurred: {s:?}");
    } else if let Some(s) = panic_info.payload().downcast_ref::<String>() {
        println!("panic occurred: {s:?}");
    } else {
        println!("panic occurred");
    }
}));

panic!("Normal panic");

fn payload_as_str(self: &Self) -> Option<&str>

Returns the payload associated with the panic, if it is a string.

This returns the payload if it is of type &'static str or String.

A invocation of the panic!() macro in Rust 2021 or later will always result in a panic payload where payload_as_str returns Some.

Only an invocation of panic_any (or, in Rust 2018 and earlier, panic!(x) where x is something other than a string) can result in a panic payload where payload_as_str returns None.

Example

std::panic::set_hook(Box::new(|panic_info| {
    if let Some(s) = panic_info.payload_as_str() {
        println!("panic occurred: {s:?}");
    } else {
        println!("panic occurred");
    }
}));

panic!("Normal panic");

fn location(self: &Self) -> Option<&Location<'_>>

Returns information about the location from which the panic originated, if available.

This method will currently always return Some, but this may change in future versions.

Examples

use std::panic;

panic::set_hook(Box::new(|panic_info| {
    if let Some(location) = panic_info.location() {
        println!("panic occurred in file '{}' at line {}",
            location.file(),
            location.line(),
        );
    } else {
        println!("panic occurred but can't get location information...");
    }
}));

panic!("Normal panic");

fn can_unwind(self: &Self) -> bool

Returns whether the panic handler is allowed to unwind the stack from the point where the panic occurred.

This is true for most kinds of panics with the exception of panics caused by trying to unwind out of a Drop implementation or a function whose ABI does not support unwinding.

It is safe for a panic handler to unwind even when this function returns false, however this will simply cause the panic handler to be called again.

`impl Display for PanicHookInfo<'_>`

fn fmt(self: &Self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result

`impl<'a> Debug for PanicHookInfo<'a>`

fn fmt(self: &Self, f: &mut $crate::fmt::Formatter<'_>) -> $crate::fmt::Result

`impl<'a> Freeze for PanicHookInfo<'a>`

`impl<'a> RefUnwindSafe for PanicHookInfo<'a>`

`impl<'a> Send for PanicHookInfo<'a>`

`impl<'a> Sync for PanicHookInfo<'a>`

`impl<'a> Unpin for PanicHookInfo<'a>`

`impl<'a> UnwindSafe for PanicHookInfo<'a>`

`impl<T> Any for PanicHookInfo<'a>`

fn type_id(self: &Self) -> TypeId

`impl<T> Borrow for PanicHookInfo<'a>`

fn borrow(self: &Self) -> &T

`impl<T> BorrowMut for PanicHookInfo<'a>`

fn borrow_mut(self: &mut Self) -> &mut T

`impl<T> From for PanicHookInfo<'a>`

fn from(t: T) -> T: Returns the argument unchanged.

`impl<T> ToString for PanicHookInfo<'a>`

fn to_string(self: &Self) -> String

`impl<T, U> Into for PanicHookInfo<'a>`

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

`impl<T, U> TryFrom for PanicHookInfo<'a>`

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

`impl<T, U> TryInto for PanicHookInfo<'a>`

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>