Skip to content

Commit

Permalink
Document difference between core and std's PanicInfo.
Browse files Browse the repository at this point in the history
  • Loading branch information
m-ou-se committed Jun 11, 2024
1 parent 702405e commit ca0bfeb
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
9 changes: 9 additions & 0 deletions core/src/panic/panic_info.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ use crate::panic::Location;
/// A struct providing information about a panic.
///
/// A `PanicInfo` structure is passed to the panic handler defined by `#[panic_handler]`.
///
/// There two `PanicInfo` types:
/// - `core::panic::PanicInfo`, which is used as an argument to a `#[panic_handler]` in `#![no_std]` programs.
/// - [`std::panic::PanicInfo`], which is used as an argument to a panic hook set by [`std::panic::set_hook`].
///
/// This is the first one.
///
/// [`std::panic::set_hook`]: ../../std/panic/fn.set_hook.html
/// [`std::panic::PanicInfo`]: ../../std/panic/struct.PanicInfo.html
#[lang = "panic_info"]
#[stable(feature = "panic_hooks", since = "1.10.0")]
#[derive(Debug)]
Expand Down
11 changes: 9 additions & 2 deletions std/src/panic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,16 @@ use crate::thread::Result;

/// A struct providing information about a panic.
///
/// `PanicInfo` structure is passed to a panic hook set by the [`set_hook`]
/// function.
/// `PanicInfo` structure is passed to a panic hook set by the [`set_hook`] function.
///
/// [`set_hook`]: ../../std/panic/fn.set_hook.html
///
/// There two `PanicInfo` types:
/// - [`core::panic::PanicInfo`], which is used as an argument to a `#[panic_handler]` in `#![no_std]` programs.
/// - `std::panic::PanicInfo`, which is used as an argument to a panic hook set by [`std::panic::set_hook`].
///
/// This is the second one.
///
/// # Examples
///
/// ```should_panic
Expand All @@ -28,6 +33,8 @@ use crate::thread::Result;
///
/// panic!("critical system failure");
/// ```
///
/// [`core::panic::PanicInfo`]: ../../core/panic/struct.PanicInfo.html
#[stable(feature = "panic_hooks", since = "1.10.0")]
#[derive(Debug)]
pub struct PanicInfo<'a> {
Expand Down

0 comments on commit ca0bfeb

Please sign in to comment.