squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

explain unsafe

Browse source
This commit is contained in:
Ralf Jung 2019-02-21 15:33:55 +01:00
parent bcc55e5e79
commit 6b88007473
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/libcore/pin.rs
View file

@ -359,8 +359,8 @@ impl<P: Deref> Pin<P> {
/// This constructor is unsafe because we cannot guarantee that the data
/// pointed to by `pointer` is pinned, meaning that the data will not be moved or
/// its storage invalidated until it gets dropped. If the constructed `Pin<P>` does
/// not guarantee that the data `P` points to is pinned, constructing a
/// `Pin<P>` is unsafe.
/// not guarantee that the data `P` points to is pinned, that is a violation of
/// the API contract and may lead to undefined behavior in later (safe) operations.
///
/// By using this method, you are making a promise about the `P::Deref` and
/// `P::DerefMut` implementations, if they exist. Most importantly, they