Struct core::panic::PanicInfo

1.10.0 · source ·
pub struct PanicInfo<'a> { /* private fields */ }
Expand description

A struct providing information about a panic.

A PanicInfo structure is passed to the panic handler defined by #[panic_handler].

For the type used by the panic hook mechanism in std, see std::panic::PanicHookInfo.

Implementations§

source§

impl<'a> PanicInfo<'a>

1.81.0 · source

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

The message that was given to the panic! macro.

§Example

The type returned by this method implements Display, so it can be passed directly to write!() and similar macros.

#[panic_handler]
fn panic_handler(panic_info: &PanicInfo<'_>) -> ! {
    write!(DEBUG_OUTPUT, "panicked: {}", panic_info.message());
    loop {}
}
1.10.0 · 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");
1.10.0 · source

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

👎Deprecated since 1.81.0: this never returns anything useful

Returns the payload associated with the panic.

On this type, core::panic::PanicInfo, this method never returns anything useful. It only exists because of compatibility with std::panic::PanicHookInfo, which used to be the same type.

See std::panic::PanicHookInfo::payload.

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§

1.10.0 · 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 T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where 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 T
where 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, U> TryFrom<U> for T
where U: Into<T>,

source§

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 T
where U: TryFrom<T>,

source§

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.