summary refs log tree commit diff
diff options
context:
space:
mode:
authorMichael Goulet <michael@errs.io>2023-02-12 01:09:09 +0000
committerMichael Goulet <michael@errs.io>2023-02-12 01:23:02 +0000
commitcca82fd997a8c16a1a790846ceab8717f16cc238 (patch)
tree1977cf96adc27402edaa4dac1655b0b90d0fe1b6
parent2b3f260e74daa487cbaebc7e55a1f42da2568d23 (diff)
downloadrust-cca82fd997a8c16a1a790846ceab8717f16cc238.tar.gz
rust-cca82fd997a8c16a1a790846ceab8717f16cc238.zip
Document PointerLike
-rw-r--r--library/core/src/marker.rs5
1 files changed, 4 insertions, 1 deletions
diff --git a/library/core/src/marker.rs b/library/core/src/marker.rs
index e11bca5962a..07a7d45c7eb 100644
--- a/library/core/src/marker.rs
+++ b/library/core/src/marker.rs
@@ -871,7 +871,10 @@ pub trait Destruct {}
 #[rustc_deny_explicit_impl]
 pub trait Tuple {}
 
-/// A marker for things
+/// A marker for pointer-like types.
+///
+/// All types that have the same size and alignment as a `usize` or
+/// `*const ()` automatically implement this trait.
 #[unstable(feature = "pointer_like_trait", issue = "none")]
 #[cfg_attr(bootstrap, lang = "pointer_sized")]
 #[cfg_attr(not(bootstrap), lang = "pointer_like")]