bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Auto merge of #28965 - bluss:ptr-write-doc, r=huonw

Browse source 
core: Update the safety docs for core::ptr::write

Updated to reflect that not dropping a value is safe (but discouraged).
This commit is contained in:
bors 2015-10-11 11:45:26 +00:00
commit db6c7124b4
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/libcore/ptr.rs
View file

@ -145,9 +145,11 @@ pub unsafe fn read_and_drop<T>(dest: *mut T) -> T {
///
/// # Safety
///
/// Beyond accepting a raw pointer, this operation is unsafe because it does
/// not drop the contents of `dst`. This could leak allocations or resources,
/// so care must be taken not to overwrite an object that should be dropped.
/// This operation is marked unsafe because it accepts a raw pointer.
///
/// It does not drop the contents of `dst`. This is safe, but it could leak
/// allocations or resources, so care must be taken not to overwrite an object
/// that should be dropped.
///
/// This is appropriate for initializing uninitialized memory, or overwriting
/// memory that has previously been `read` from.