Added unsafety documentation to shift_tail

This is just the reverse of shift_head.
This commit is contained in:
Hanif Bin Ariffin 2020-04-25 19:39:40 -04:00
parent 7349f2c6a3
commit 9e8b42c02b

View file

@ -76,6 +76,20 @@ where
F: FnMut(&T, &T) -> bool,
{
let len = v.len();
// SAFETY: As with shift_head, the unsafe operations below involves indexing without a bound check (`get_unchecked` and `get_unchecked_mut`)
// and copying memory (`ptr::copy_nonoverlapping`).
//
// a. Indexing:
// 1. We checked the size of the array to >=2.
// 2. All the indexing that we will do is always between {0 <= index < len-1} at most.
//
// b. Memory copying
// 1. We are obtaining pointers to references which are guaranteed to be valid.
// 2. They cannot overlap because we obtain pointers to difference indices of the slice.
// Namely, `i` and `i+1`.
// 3. FIXME: Guarantees that the elements are properly aligned?
//
// See comments below for further detail.
unsafe {
// If the last two elements are out-of-order...
if len >= 2 && is_less(v.get_unchecked(len - 1), v.get_unchecked(len - 2)) {