Rename panic_box to panic_any.

This commit is contained in:
Mara Bos 2020-10-18 12:29:13 +02:00
parent 01b0aff1df
commit 16201da6a4

View File

@ -23,17 +23,17 @@ pub use crate::panicking::{set_hook, take_hook};
#[stable(feature = "panic_hooks", since = "1.10.0")]
pub use core::panic::{Location, PanicInfo};
/// Panic the current thread, with the given payload as the panic message.
/// Panic the current thread with the given message as the panic payload.
///
/// This supports an arbitrary panic payload, instead of just (formatted) strings.
/// The message can be of any (`Any + Send`) type, not just strings.
///
/// The message is attached as a `Box<'static + Any + Send>`, which can be
/// accessed using [`PanicInfo::payload`].
/// The message is wrapped in a `Box<'static + Any + Send>`, which can be
/// accessed later using [`PanicInfo::payload`].
///
/// See the [`panic!`] macro for more information about panicking.
#[unstable(feature = "panic_box", issue = "none")]
#[inline]
pub fn panic_box<M: Any + Send>(msg: M) -> ! {
pub fn panic_any<M: Any + Send>(msg: M) -> ! {
crate::panicking::begin_panic(msg);
}