about summary refs log tree commit diff
path: root/src/libcore/any.rs
diff options
context:
space:
mode:
authorMark Rousskov <mark.simulacrum@gmail.com>2019-12-22 07:54:18 -0500
committerMark Rousskov <mark.simulacrum@gmail.com>2019-12-22 08:12:55 -0500
commit687891309659fd2942f4c8bc8f9fd2feaf85d864 (patch)
tree1e98670dfd6c670c9abbacb8d694220e051b0253 /src/libcore/any.rs
parent3982d3514efbb65b3efac6bb006b3fa496d16663 (diff)
downloadrust-687891309659fd2942f4c8bc8f9fd2feaf85d864.tar.gz
rust-687891309659fd2942f4c8bc8f9fd2feaf85d864.zip
Document why Any is not an unsafe trait
Diffstat (limited to 'src/libcore/any.rs')
-rw-r--r--src/libcore/any.rs10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/libcore/any.rs b/src/libcore/any.rs
index a2aa6b3fea5..5126fe01a3f 100644
--- a/src/libcore/any.rs
+++ b/src/libcore/any.rs
@@ -74,6 +74,16 @@ use crate::intrinsics;
 /// See the [module-level documentation][mod] for more details.
 ///
 /// [mod]: index.html
+// This trait is not unsafe, though we rely on the specifics of it's sole impl's
+// `type_id` function in unsafe code (e.g., `downcast`). Normally, that would be
+// a problem, but because the only impl of `Any` is a blanket implementation, no
+// other code can implement `Any`.
+//
+// We could plausibly make this trait unsafe -- it would not cause breakage,
+// since we control all the implementations -- but we choose not to as that's
+// both not really necessary and may confuse users about the distinction of
+// unsafe traits and unsafe methods (i.e., `type_id` would still be safe to call,
+// but we would likely want to indicate as such in documentation).
 #[stable(feature = "rust1", since = "1.0.0")]
 pub trait Any: 'static {
     /// Gets the `TypeId` of `self`.