Docs. Last commit before removing tuple_tree and all related tuple internal macro machinery

Author: peter-lyons-kehl

README.md

@@ -259,6 +259,7 @@ let _ = unsafe_mut!(pt);
 let mut b: bool = true;
 let pt: *mut bool = &mut b as *mut bool;
 
+let _: &mut dyn Display = unsafe_mut!(pt);
 let _: &dyn Display = unsafe_mut!(pt);
 ```
 

src/lib.rs

@@ -150,6 +150,9 @@ macro_rules! unsafe_fn {
         // 1. the result can be used as a value in an outer expression, and
         // 2. local variables don't conflict with the outer scope
         {
+            //@TODO remove accessors. Instead:
+            // - if false {...}: assign the tuple. Then unreachable!();
+            // - else {...}: original full call.
             let (tuple_tree, fun) = ($crate::unsafe_fn_internal_build_tuple_tree!{ $($arg),+ }, $fn);
 
             $crate::unsafe_fn_internal_build_accessors_and_call! {
@@ -408,8 +411,10 @@ macro_rules! unsafe_mut {
     }};
 }
 
-#[doc(hidden)]
 /// This is an "early" type check for [unsafe_val], so that the user knows to use [unsafe_val] with [core::marker::Copy] types only.
+///
+/// NOT a part of public API!
+#[doc(hidden)]
 pub const fn expect_copy_ptr<T: Copy>(_: *const T) {}
 
 /// Get a (copy of) value from where the pointer points. For [core::marker::Copy] types only.