From 22342b0959e712f62e65f16e655b949e13781c0e Mon Sep 17 00:00:00 2001 From: xizheyin Date: Sat, 28 Jun 2025 15:30:47 +0800 Subject: [PATCH] doc(std): clarify `NonZero` usage limitation in doc comment Signed-off-by: xizheyin --- library/core/src/num/nonzero.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/library/core/src/num/nonzero.rs b/library/core/src/num/nonzero.rs index 0fa066c8f7e38..11d50e0f89f30 100644 --- a/library/core/src/num/nonzero.rs +++ b/library/core/src/num/nonzero.rs @@ -111,6 +111,15 @@ impl_zeroable_primitive!( /// ``` /// /// [null pointer optimization]: crate::option#representation +/// +/// # Note on generic usage +/// +/// `NonZero` can only be used with some standard library primitive types +/// (such as `u8`, `i32`, and etc.). The type parameter `T` must implement the +/// internal trait [`ZeroablePrimitive`], which is currently permanently unstable +/// and cannot be implemented by users. Therefore, you cannot use `NonZero` +/// with your own types, nor can you implement traits for all `NonZero`, +/// only for concrete types. #[stable(feature = "generic_nonzero", since = "1.79.0")] #[repr(transparent)] #[rustc_nonnull_optimization_guaranteed]