Auto merge of #50487 - nikic:heap-manually-drop, r=Gankro

Use ManuallyDrop instead of Option in BinaryHeap Hole implementation

The Option is always Some until drop, where it becomes None. Make this more explicit and avoid unwraps by using ManuallyDrop.

This change should be performance-neutral as LLVM already optimizes the unwraps away in the inlined code. However I've seen this pattern copied from here to other crates where it is not optimized away, so I think it would be good to change it.
This commit is contained in:
bors 2018-05-07 12:30:55 +00:00
commit 62889702c9

View File

@ -157,7 +157,7 @@
use core::ops::{Deref, DerefMut};
use core::iter::{FromIterator, FusedIterator};
use core::mem::{swap, size_of};
use core::mem::{swap, size_of, ManuallyDrop};
use core::ptr;
use core::fmt;
@ -864,8 +864,7 @@ impl<T: Ord> BinaryHeap<T> {
/// position with the value that was originally removed.
struct Hole<'a, T: 'a> {
data: &'a mut [T],
/// `elt` is always `Some` from new until drop.
elt: Option<T>,
elt: ManuallyDrop<T>,
pos: usize,
}
@ -879,7 +878,7 @@ impl<'a, T> Hole<'a, T> {
let elt = ptr::read(&data[pos]);
Hole {
data,
elt: Some(elt),
elt: ManuallyDrop::new(elt),
pos,
}
}
@ -892,7 +891,7 @@ impl<'a, T> Hole<'a, T> {
/// Returns a reference to the element removed.
#[inline]
fn element(&self) -> &T {
self.elt.as_ref().unwrap()
&self.elt
}
/// Returns a reference to the element at `index`.
@ -925,7 +924,7 @@ impl<'a, T> Drop for Hole<'a, T> {
// fill the hole again
unsafe {
let pos = self.pos;
ptr::write(self.data.get_unchecked_mut(pos), self.elt.take().unwrap());
ptr::copy_nonoverlapping(&*self.elt, self.data.get_unchecked_mut(pos), 1);
}
}
}