Clarify # Safety section on Tagged

hashintel · Jan 3, 2022 · 637ccee · 637ccee
1 parent 53d79e3
commit 637ccee
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/packages/engine/lib/provider/src/internal.rs b/packages/engine/lib/provider/src/internal.rs
@@ -6,7 +6,10 @@ use super::{TypeId, TypeTag};
 ///
 /// # Safety
 ///
-/// This trait must be exclusively implemented by the [`TagValue`] type.
+/// This trait must be exclusively implemented by the [`TagValue`] type as [`Tagged::is`] relies on
+/// `tag_id` and the [`TypeId`] must not be overwritten.
+///
+/// [`Tagged::is`]: #method.is
 pub(super) unsafe trait Tagged<'p>: 'p {
     /// The [`TypeId`] of the [`TypeTag`] this value was tagged with.
     fn tag_id(&self) -> TypeId;