Update safety section

Manishearth · Oct 24, 2023 · 4762e2c · 4762e2c
1 parent e20eca4
commit 4762e2c
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/arc_borrow.rs b/src/arc_borrow.rs
@@ -46,6 +46,8 @@ impl<'a, T> ArcBorrow<'a, T> {
     /// e.g. if we obtain such a reference over FFI
     /// TODO: should from_ref be relaxed to unsized types? It can't be
     /// converted back to an Arc right now for unsized types.
+    /// # Safety
+    /// - The reference to `T` must have come from a Triomphe Arc, UniqueArc, or ArcBorrow.
     #[inline]
     pub unsafe fn from_ref(r: &'a T) -> Self {
         ArcBorrow(r)