core::panic::PanicInfo - Rust
Description: API documentation for the Rust `PanicInfo` struct in crate `core`.
Keywords: rust, rustlang, rust-lang, PanicInfo

# Struct core::panic::PanicInfo 1.10.0[−][src]

    #[lang = "panic_info"]
    pub struct PanicInfo<'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");Run

## Methods

###

`impl<'a> PanicInfo<'a>`

[src]

####

`pub fn payload(&self) -> &(Any + Send)`

[src]

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");Run

####

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

[src]

🔬 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>`

[src]

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");Run

## Trait Implementations

###

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

[src]

####

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

[src]

Formats the value using the given formatter. Read more

###

`impl<'a> Display for PanicInfo<'a>`

1.26.0
[src]

####

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

[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

###

`impl<'a> !Send for PanicInfo<'a>`

###

`impl<'a> !Sync for PanicInfo<'a>`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)