mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

drop_in_place docs: remove pseudocode-ish implementation details

Browse Source
This commit is contained in:
Erik Desjardins 2023-05-21 11:34:01 -04:00
parent c4d69b717f
commit 340827af9b
1 changed files with 1 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
library/core/src/ptr/mod.rs
View File

@ -437,21 +437,7 @@
///
/// # Safety
///
/// Immediately upon executing, `drop_in_place` takes out a mutable borrow on the
/// pointed-to-value. Effectively, this function is implemented like so:
///
/// ```
/// # struct Foo { x: i32 }
/// unsafe fn drop_in_place(to_drop: *mut Foo) {
/// drop_in_place_inner(&mut *to_drop);
/// unsafe fn drop_in_place_inner(to_drop: &mut Foo) {
/// // ... drop the fields of `value` ...
/// }
/// }
/// ```
///
/// This implies that the behavior is undefined if any of the following
/// conditions are violated:
/// Behavior is undefined if any of the following conditions are violated:
///
/// * `to_drop` must be [valid] for both reads and writes.
///