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

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

    #[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

ⓘThis example panics

    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

## Implementations

### `impl<'a> PanicInfo<'a>`[src]

#### `pub fn payload(&self) -> &(dyn Any + Send)`[src]

Returns the payload associated with the panic.

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

# Examples

ⓘThis example panics

    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

#### `pub fn message(&self) -> Option<&Arguments>`[src]

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

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

ⓘThis example panics

    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<'_> Display for PanicInfo<'_>`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>`

### `impl<'a> Unpin for PanicInfo<'a>`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&Self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&Self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut Self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `fn from(T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(Self) -> U`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.