about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJakub Beránek <berykubik@gmail.com>2025-08-13 07:03:50 +0200
committerGitHub <noreply@github.com>2025-08-13 07:03:50 +0200
commita0ed0889bb246b1bf484d70f9561f1c494049458 (patch)
tree8fbf2a72c7ffacf9eaba2ec76905cbb0c78a0701
parent6e14364b5bd5edea9d320874506de7efbd9a4070 (diff)
parentbd44d855f5a2c989b5cc5bef517978c47ddc6779 (diff)
downloadrust-a0ed0889bb246b1bf484d70f9561f1c494049458.tar.gz
rust-a0ed0889bb246b1bf484d70f9561f1c494049458.zip
Rollup merge of #145303 - m-ou-se:payload-as-str-doc, r=jhpratt
Docs: Link to payload_as_str() from payload().
-rw-r--r--library/std/src/panic.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/library/std/src/panic.rs b/library/std/src/panic.rs
index cff4f20b5a8..5e8d2f8e78e 100644
--- a/library/std/src/panic.rs
+++ b/library/std/src/panic.rs
@@ -60,6 +60,7 @@ impl<'a> PanicHookInfo<'a> {
     /// Returns the payload associated with the panic.
     ///
     /// This will commonly, but not always, be a `&'static str` or [`String`].
+    /// If you only care about such payloads, use [`payload_as_str`] instead.
     ///
     /// A invocation of the `panic!()` macro in Rust 2021 or later will always result in a
     /// panic payload of type `&'static str` or `String`.
@@ -69,6 +70,7 @@ impl<'a> PanicHookInfo<'a> {
     /// can result in a panic payload other than a `&'static str` or `String`.
     ///
     /// [`String`]: ../../std/string/struct.String.html
+    /// [`payload_as_str`]: PanicHookInfo::payload_as_str
     ///
     /// # Examples
     ///