about summary refs log tree commit diff
diff options
context:
space:
mode:
authorDylan DPC <99973273+Dylan-DPC@users.noreply.github.com>2022-05-31 07:57:36 +0200
committerGitHub <noreply@github.com>2022-05-31 07:57:36 +0200
commit5885e6d45358139d74c8b2a52df01708fac6bbc8 (patch)
treea238b1166c7d6a2950e4cd64d15664d2874a44d2
parentbf248c82e86f0205d953a04b0ed07e67c7109895 (diff)
parente565bb0326108534fab12aa9cfc7d56f2eb97aec (diff)
downloadrust-5885e6d45358139d74c8b2a52df01708fac6bbc8.tar.gz
rust-5885e6d45358139d74c8b2a52df01708fac6bbc8.zip
Rollup merge of #97565 - lukas-code:patch-1, r=thomcc
Add doc alias `memset` to `write_bytes`

I were looking for `memset` in rust, but the docs only pointed me to `slice::fill`.

With only the old aliases, one might write code like this, which is incorrect if the memory is uninitialized.
``` Rust
core::slice::from_raw_parts(ptr, len).fill(0)
```
-rw-r--r--library/core/src/intrinsics.rs1
-rw-r--r--library/core/src/ptr/mut_ptr.rs1
2 files changed, 2 insertions, 0 deletions
diff --git a/library/core/src/intrinsics.rs b/library/core/src/intrinsics.rs
index 678d00c68c5..0b76790c009 100644
--- a/library/core/src/intrinsics.rs
+++ b/library/core/src/intrinsics.rs
@@ -2287,6 +2287,7 @@ pub const unsafe fn copy<T>(src: *const T, dst: *mut T, count: usize) {
 /// // Now the box is fine
 /// assert_eq!(*v, 42);
 /// ```
+#[doc(alias = "memset")]
 #[stable(feature = "rust1", since = "1.0.0")]
 #[rustc_const_unstable(feature = "const_ptr_write", issue = "86302")]
 #[inline]
diff --git a/library/core/src/ptr/mut_ptr.rs b/library/core/src/ptr/mut_ptr.rs
index 37cf2ef4bfb..1aaa274a054 100644
--- a/library/core/src/ptr/mut_ptr.rs
+++ b/library/core/src/ptr/mut_ptr.rs
@@ -1412,6 +1412,7 @@ impl<T: ?Sized> *mut T {
     /// See [`ptr::write_bytes`] for safety concerns and examples.
     ///
     /// [`ptr::write_bytes`]: crate::ptr::write_bytes()
+    #[doc(alias = "memset")]
     #[stable(feature = "pointer_methods", since = "1.26.0")]
     #[rustc_const_unstable(feature = "const_ptr_write", issue = "86302")]
     #[inline(always)]