rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

improve drop_in_place docs

Browse Source
This commit is contained in:
Erik Desjardins
2023-05-20 17:46:47 -04:00
parent b2ef9f7223
commit 58c3999949
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -443,8 +443,10 @@ mod mut_ptr;
/// ``` /// ```
/// # struct Foo { x: i32 } /// # struct Foo { x: i32 }
/// unsafe fn drop_in_place(to_drop: *mut Foo) { /// unsafe fn drop_in_place(to_drop: *mut Foo) {
/// let mut value = &mut *to_drop; /// drop_in_place_inner(&mut *to_drop);
/// // ... drop the fields of `value` ... /// unsafe fn drop_in_place_inner(to_drop: &mut Foo) {
/// // ... drop the fields of `value` ...
/// }
/// } /// }
/// ``` /// ```
/// ///
@@ -453,9 +455,9 @@ mod mut_ptr;
/// ///
/// * `to_drop` must be [valid] for both reads and writes. /// * `to_drop` must be [valid] for both reads and writes.
/// ///
/// * `to_drop` must be properly aligned, even if T has size 0. /// * `to_drop` must be properly aligned, even if `T` has size 0.
/// ///
/// * `to_drop` must be nonnull, even if T has size 0. /// * `to_drop` must be nonnull, even if `T` has size 0.
/// ///
/// * The value `to_drop` points to must be valid for dropping, which may mean /// * The value `to_drop` points to must be valid for dropping, which may mean
/// it must uphold additional invariants. These invariants depend on the type /// it must uphold additional invariants. These invariants depend on the type