Struct std::panic::PanicInfo

#[lang = "panic_info"]
pub struct PanicInfo<'a> where
    'a: 'a,  { /* fields omitted */ }

A struct providing information about a panic.

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

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 {
        println!("panic occurred");
    }
}));

panic!("Normal panic");

Methods

impl<'a> PanicInfo<'a>

pub fn payload(&self) -> &(dyn Any + 'static + Send)

Returns the payload associated with the panic.

This will commonly, but not always, be a &'static str or String.

Examples

use std::panic;

panic::set_hook(Box::new(|panic_info| {
    println!("panic occurred: {:?}", panic_info.payload().downcast_ref::<&str>().unwrap());
}));

panic!("Normal panic");

pub fn message(&self) -> Option<&Arguments>

🔬 This is a nightly-only experimental API. (panic_info_message #44489)

If the panic! macro from the core crate (not from std) was used with a formatting string and some additional arguments, returns that message ready to be used for example with fmt::write

pub fn location(&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");

Trait Implementations

impl<'_> Display for PanicInfo<'_>

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> Debug for PanicInfo<'a>

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.