]> git.lizzy.rs Git - rust.git/commitdiff
Link the reference about undefined behavior
authorMiguel Ojeda <ojeda@kernel.org>
Mon, 25 Jan 2021 13:53:19 +0000 (14:53 +0100)
committerMiguel Ojeda <ojeda@kernel.org>
Mon, 25 Jan 2021 13:53:19 +0000 (14:53 +0100)
Suggested-by: Mara Bos <m-ou.se@m-ou.se>
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
library/core/src/option.rs
library/core/src/result.rs

index 5d34f5ca155bfe2d9ad4a91d0a3b14ef901866bc..9f89bfd674a74eee8e5f48d2d08d280a820570bb 100644 (file)
@@ -433,7 +433,9 @@ pub fn unwrap_or_else<F: FnOnce() -> T>(self, f: F) -> T {
     ///
     /// # Safety
     ///
-    /// Undefined behavior if the value is [`None`].
+    /// Calling this method on [`None`] is *[undefined behavior]*.
+    ///
+    /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
     ///
     /// # Examples
     ///
index a357750b92f9da464fa2ffdd1cced10a927c9d53..436f4bf20c7e775de5e1cd8aeffffefe1aeb52b5 100644 (file)
@@ -827,7 +827,9 @@ pub fn unwrap_or_else<F: FnOnce(E) -> T>(self, op: F) -> T {
     ///
     /// # Safety
     ///
-    /// Undefined behavior if the value is an [`Err`].
+    /// Calling this method on an [`Err`] is *[undefined behavior]*.
+    ///
+    /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
     ///
     /// # Examples
     ///
@@ -859,7 +861,9 @@ pub unsafe fn unwrap_unchecked(self) -> T {
     ///
     /// # Safety
     ///
-    /// Undefined behavior if the value is an [`Ok`].
+    /// Calling this method on an [`Ok`] is *[undefined behavior]*.
+    ///
+    /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
     ///
     /// # Examples
     ///