Improve <vec::IntoIter>::get_unchecked` safety comment

This commit is contained in:
Matthew Jasper 2020-09-25 19:46:06 +01:00
parent 5b9e886403
commit 323a27967a
1 changed files with 8 additions and 2 deletions

View File

@ -2985,8 +2985,14 @@ impl<T> Iterator for IntoIter<T> {
where
Self: TrustedRandomAccess,
{
// SAFETY: the caller must uphold the contract for
// `Iterator::get_unchecked`.
// SAFETY: the caller must guarantee that `i` is in bounds of the
// `Vec<T>`, so `i` cannot overflow an `isize`, and the `self.ptr.add(i)`
// is guaranteed to pointer to an element of the `Vec<T>` and
// thus guaranteed to be valid to dereference.
//
// Also note the implementation of `Self: TrustedRandomAccess` requires
// that `T: Copy` so reading elements from the buffer doesn't invalidate
// them for `Drop`.
unsafe {
if mem::size_of::<T>() == 0 { mem::zeroed() } else { ptr::read(self.ptr.add(i)) }
}