Skip to content

Commit 1329a62

Browse files
authored
Rollup merge of rust-lang#125739 - RalfJung:drop-in-place-docs, r=workingjubilee
drop_in_place: weaken the claim of equivalence with drop(ptr.read()) The two are *not* semantically equivalent in all cases, so let's not be so definite about this. Fixes rust-lang#112015
2 parents 8883bcf + 14d5dcb commit 1329a62

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

core/src/ptr/mod.rs

+6-1
Original file line numberDiff line numberDiff line change
@@ -450,8 +450,13 @@ mod mut_ptr;
450450

451451
/// Executes the destructor (if any) of the pointed-to value.
452452
///
453-
/// This is semantically equivalent to calling [`ptr::read`] and discarding
453+
/// This is almost the same as calling [`ptr::read`] and discarding
454454
/// the result, but has the following advantages:
455+
// FIXME: say something more useful than "almost the same"?
456+
// There are open questions here: `read` requires the value to be fully valid, e.g. if `T` is a
457+
// `bool` it must be 0 or 1, if it is a reference then it must be dereferenceable. `drop_in_place`
458+
// only requires that `*to_drop` be "valid for dropping" and we have not defined what that means. In
459+
// Miri it currently (May 2024) requires nothing at all for types without drop glue.
455460
///
456461
/// * It is *required* to use `drop_in_place` to drop unsized types like
457462
/// trait objects, because they can't be read out onto the stack and

0 commit comments

Comments
 (0)