Simplify array::IntoIter

- Initialization can use `transmute_copy` to do the bitwise copy.
- `as_slice` can use `get_unchecked` and `MaybeUninit::slice_get_ref`,
  and `as_mut_slice` can do similar.
- `next` and `next_back` can use the corresponding `Range` methods.
- `Clone` doesn't need any unsafety, and we can dynamically update the
  new range to get partial drops if `T::clone` panics.
This commit is contained in:
Josh Stone 2020-08-07 13:51:46 -07:00
parent 4d4342347b
commit a2cfc74c5f

View File

@ -56,38 +56,34 @@ impl<T, const N: usize> IntoIter<T, N> {
// FIXME(LukasKalbertodt): actually use `mem::transmute` here, once it // FIXME(LukasKalbertodt): actually use `mem::transmute` here, once it
// works with const generics: // works with const generics:
// `mem::transmute::<[T; {N}], [MaybeUninit<T>; {N}]>(array)` // `mem::transmute::<[T; N], [MaybeUninit<T>; N]>(array)`
// //
// Until then, we do it manually here. We first create a bitwise copy // Until then, we can use `mem::transmute_copy` to create a bitwise copy
// but cast the pointer so that it is treated as a different type. Then // as a different type, then forget `array` so that it is not dropped.
// we forget `array` so that it is not dropped. unsafe {
let data = unsafe { let iter = Self { data: mem::transmute_copy(&array), alive: 0..N };
let data = ptr::read(&array as *const [T; N] as *const [MaybeUninit<T>; N]);
mem::forget(array); mem::forget(array);
data iter
}; }
Self { data, alive: 0..N }
} }
/// Returns an immutable slice of all elements that have not been yielded /// Returns an immutable slice of all elements that have not been yielded
/// yet. /// yet.
fn as_slice(&self) -> &[T] { fn as_slice(&self) -> &[T] {
let slice = &self.data[self.alive.clone()]; // SAFETY: We know that all elements within `alive` are properly initialized.
// SAFETY: This transmute is safe. As mentioned in `new`, `MaybeUninit` retains unsafe {
// the size and alignment of `T`. Furthermore, we know that all let slice = self.data.get_unchecked(self.alive.clone());
// elements within `alive` are properly initialized. MaybeUninit::slice_get_ref(slice)
unsafe { mem::transmute::<&[MaybeUninit<T>], &[T]>(slice) } }
} }
/// Returns a mutable slice of all elements that have not been yielded yet. /// Returns a mutable slice of all elements that have not been yielded yet.
fn as_mut_slice(&mut self) -> &mut [T] { fn as_mut_slice(&mut self) -> &mut [T] {
// This transmute is safe, same as in `as_slice` above. // SAFETY: We know that all elements within `alive` are properly initialized.
let slice = &mut self.data[self.alive.clone()]; unsafe {
// SAFETY: This transmute is safe. As mentioned in `new`, `MaybeUninit` retains let slice = self.data.get_unchecked_mut(self.alive.clone());
// the size and alignment of `T`. Furthermore, we know that all MaybeUninit::slice_get_mut(slice)
// elements within `alive` are properly initialized. }
unsafe { mem::transmute::<&mut [MaybeUninit<T>], &mut [T]>(slice) }
} }
} }
@ -95,30 +91,20 @@ impl<T, const N: usize> IntoIter<T, N> {
impl<T, const N: usize> Iterator for IntoIter<T, N> { impl<T, const N: usize> Iterator for IntoIter<T, N> {
type Item = T; type Item = T;
fn next(&mut self) -> Option<Self::Item> { fn next(&mut self) -> Option<Self::Item> {
if self.alive.start == self.alive.end { // Get the next index from the front.
return None;
}
// Bump start index.
// //
// From the check above we know that `alive.start != alive.end`. // Increasing `alive.start` by 1 maintains the invariant regarding
// Combine this with the invariant `alive.start <= alive.end`, we know // `alive`. However, due to this change, for a short time, the alive
// that `alive.start < alive.end`. Increasing `alive.start` by 1 // zone is not `data[alive]` anymore, but `data[idx..alive.end]`.
// maintains the invariant regarding `alive`. However, due to this self.alive.next().map(|idx| {
// change, for a short time, the alive zone is not `data[alive]` // Read the element from the array.
// anymore, but `data[idx..alive.end]`. // SAFETY: `idx` is an index into the former "alive" region of the
let idx = self.alive.start; // array. Reading this element means that `data[idx]` is regarded as
self.alive.start += 1; // dead now (i.e. do not touch). As `idx` was the start of the
// alive-zone, the alive zone is now `data[alive]` again, restoring
// Read the element from the array. // all invariants.
// SAFETY: This is safe: `idx` is an index unsafe { self.data.get_unchecked(idx).read() }
// into the "alive" region of the array. Reading this element means })
// that `data[idx]` is regarded as dead now (i.e. do not touch). As
// `idx` was the start of the alive-zone, the alive zone is now
// `data[alive]` again, restoring all invariants.
let out = unsafe { self.data.get_unchecked(idx).read() };
Some(out)
} }
fn size_hint(&self) -> (usize, Option<usize>) { fn size_hint(&self) -> (usize, Option<usize>) {
@ -138,33 +124,20 @@ impl<T, const N: usize> Iterator for IntoIter<T, N> {
#[stable(feature = "array_value_iter_impls", since = "1.40.0")] #[stable(feature = "array_value_iter_impls", since = "1.40.0")]
impl<T, const N: usize> DoubleEndedIterator for IntoIter<T, N> { impl<T, const N: usize> DoubleEndedIterator for IntoIter<T, N> {
fn next_back(&mut self) -> Option<Self::Item> { fn next_back(&mut self) -> Option<Self::Item> {
if self.alive.start == self.alive.end { // Get the next index from the back.
return None;
}
// Decrease end index.
// //
// From the check above we know that `alive.start != alive.end`. // Decreasing `alive.end` by 1 maintains the invariant regarding
// Combine this with the invariant `alive.start <= alive.end`, we know // `alive`. However, due to this change, for a short time, the alive
// that `alive.start < alive.end`. As `alive.start` cannot be negative, // zone is not `data[alive]` anymore, but `data[alive.start..=idx]`.
// `alive.end` is at least 1, meaning that we can safely decrement it self.alive.next_back().map(|idx| {
// by one. This also maintains the invariant `alive.start <= // Read the element from the array.
// alive.end`. However, due to this change, for a short time, the alive // SAFETY: `idx` is an index into the former "alive" region of the
// zone is not `data[alive]` anymore, but `data[alive.start..alive.end // array. Reading this element means that `data[idx]` is regarded as
// + 1]`. // dead now (i.e. do not touch). As `idx` was the end of the
self.alive.end -= 1; // alive-zone, the alive zone is now `data[alive]` again, restoring
// all invariants.
// Read the element from the array. unsafe { self.data.get_unchecked(idx).read() }
// SAFETY: This is safe: `alive.end` is an })
// index into the "alive" region of the array. Compare the previous
// comment that states that the alive region is
// `data[alive.start..alive.end + 1]`. Reading this element means that
// `data[alive.end]` is regarded as dead now (i.e. do not touch). As
// `alive.end` was the end of the alive-zone, the alive zone is now
// `data[alive]` again, restoring all invariants.
let out = unsafe { self.data.get_unchecked(self.alive.end).read() };
Some(out)
} }
} }
@ -203,26 +176,19 @@ unsafe impl<T, const N: usize> TrustedLen for IntoIter<T, N> {}
#[stable(feature = "array_value_iter_impls", since = "1.40.0")] #[stable(feature = "array_value_iter_impls", since = "1.40.0")]
impl<T: Clone, const N: usize> Clone for IntoIter<T, N> { impl<T: Clone, const N: usize> Clone for IntoIter<T, N> {
fn clone(&self) -> Self { fn clone(&self) -> Self {
// SAFETY: each point of unsafety is documented inside the unsafe block // Note, we don't really need to match the exact same alive range, so
unsafe { // we can just clone into offset 0 regardless of where `self` is.
// This creates a new uninitialized array. Note that the `assume_init` let mut new = Self { data: MaybeUninit::uninit_array(), alive: 0..0 };
// refers to the array, not the individual elements. And it is Ok if
// the array is in an uninitialized state as all elements may be
// uninitialized (all bit patterns are valid). Compare the
// `MaybeUninit` docs for more information.
let mut new_data: [MaybeUninit<T>; N] = MaybeUninit::uninit().assume_init();
// Clone all alive elements. // Clone all alive elements.
for idx in self.alive.clone() { for (src, dst) in self.as_slice().iter().zip(&mut new.data) {
// The element at `idx` in the old array is alive, so we can // Write a clone into the new array, then update its alive range.
// safely call `get_ref()`. We then clone it, and write the // If cloning panics, we'll correctly drop the previous items.
// clone into the new array. dst.write(src.clone());
let clone = self.data.get_unchecked(idx).get_ref().clone(); new.alive.end += 1;
new_data.get_unchecked_mut(idx).write(clone);
}
Self { data: new_data, alive: self.alive.clone() }
} }
new
} }
} }