Document Pin memory layout

This commit is contained in:
Jules Bertholet 2023-05-18 01:30:12 -04:00
parent 77fb0cd3aa
commit f16acbeef6
No known key found for this signature in database
GPG Key ID: 32034DAFC38C1BFC

View File

@ -393,6 +393,8 @@ use crate::ops::{CoerceUnsized, Deref, DerefMut, DispatchFromDyn, Receiver};
/// value in place, preventing the value referenced by that pointer from being moved
/// unless it implements [`Unpin`].
///
/// `Pin<P>` is guaranteed to have the same memory layout and ABI as `P`.
///
/// *See the [`pin` module] documentation for an explanation of pinning.*
///
/// [`pin` module]: self