From a55bf34b42143abf3fd180de3c428297712bea43 Mon Sep 17 00:00:00 2001
From: Ralf Jung <post@ralfj.de>
Date: Wed, 11 Sep 2024 08:08:39 +0200
Subject: [PATCH] MaybeUninit::zeroed: mention that padding is not zeroed

---
 core/src/mem/maybe_uninit.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/core/src/mem/maybe_uninit.rs b/core/src/mem/maybe_uninit.rs
index 4be2e5ef1eade..0154caa7c24dd 100644
--- a/core/src/mem/maybe_uninit.rs
+++ b/core/src/mem/maybe_uninit.rs
@@ -351,6 +351,9 @@ impl<T> MaybeUninit<T> {
     /// but `MaybeUninit<&'static i32>::zeroed()` is not because references must not
     /// be null.
     ///
+    /// Note that if `T` has padding bytes, those bytes are *not* preserved when the
+    /// `MaybeUninit<T>` value is returned from this function, so those bytes will *not* be zeroed.
+    ///
     /// Note that dropping a `MaybeUninit<T>` will never call `T`'s drop code.
     /// It is your responsibility to make sure `T` gets dropped if it got initialized.
     ///