Struct core::panic::PanicInfo

1.10.0 · source ·
pub struct PanicInfo<'a> {
    payload: &'a (dyn Any + Send),
    message: Option<&'a Arguments<'a>>,
    location: &'a Location<'a>,
    can_unwind: bool,
}
Expand description

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

panic!("critical system failure");
Run

Fields§

§payload: &'a (dyn Any + Send)§message: Option<&'a Arguments<'a>>§location: &'a Location<'a>§can_unwind: bool

Implementations§

source§

impl<'a> PanicInfo<'a>

source

pub fn internal_constructor( message: Option<&'a Arguments<'a>>, location: &'a Location<'a>, can_unwind: bool ) -> Self

🔬This is a nightly-only experimental API. (panic_internals)
source

pub fn set_payload(&mut self, info: &'a (dyn Any + Send))

🔬This is a nightly-only experimental API. (panic_internals)
source

pub fn payload(&self) -> &(dyn Any + 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| {
    if let Some(s) = panic_info.payload().downcast_ref::<&str>() {
        println!("panic occurred: {s:?}");
    } else {
        println!("panic occurred");
    }
}));

panic!("Normal panic");
Run
source

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

🔬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

source

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

pub fn can_unwind(&self) -> bool

🔬This is a nightly-only experimental API. (panic_can_unwind #92988)

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.

Trait Implementations§

source§

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

source§

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

Formats the value using the given formatter. Read more
1.26.0 · source§

impl Display for PanicInfo<'_>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for PanicInfo<'a>

§

impl<'a> !RefUnwindSafe for PanicInfo<'a>

§

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

§

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

§

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

§

impl<'a> !UnwindSafe for PanicInfo<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> SizedTypeProperties for T

source§

const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.