pub struct PanicInfo<'a> { /* private fields */ }
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| {
if let Some(s) = panic_info.payload().downcast_ref::<&str>() {
println!("panic occurred: {s:?}");
} else {
println!("panic occurred");
}
}));
panic!("Normal panic");
RunImplementations
sourceimpl<'a> PanicInfo<'a>
impl<'a> PanicInfo<'a>
sourcepub fn payload(&self) -> &(dyn Any + Send)
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");
Runsourcepub fn message(&self) -> Option<&Arguments<'_>>
pub fn message(&self) -> Option<&Arguments<'_>>
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
sourcepub fn location(&self) -> Option<&Location<'_>>
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");
Runsourcepub fn can_unwind(&self) -> bool
pub fn can_unwind(&self) -> bool
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 true, however this will simply cause the panic handler to be called again.
Trait Implementations
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more