Skip to main content

alloc/vec/
into_iter.rs

1use core::iter::{
2    FusedIterator, InPlaceIterable, SourceIter, TrustedFused, TrustedLen,
3    TrustedRandomAccessNoCoerce,
4};
5use core::marker::PhantomData;
6use core::mem::{ManuallyDrop, MaybeUninit, SizedTypeProperties};
7use core::num::NonZero;
8#[cfg(not(no_global_oom_handling))]
9use core::ops::Deref;
10use core::panic::UnwindSafe;
11use core::ptr::{self, NonNull};
12use core::{array, fmt, slice};
13
14#[cfg(not(no_global_oom_handling))]
15use super::AsVecIntoIter;
16use crate::alloc::{Allocator, Global};
17#[cfg(not(no_global_oom_handling))]
18use crate::collections::VecDeque;
19use crate::raw_vec::RawVec;
20
21macro non_null {
22    (mut $place:expr, $t:ident) => {{
23        #![allow(unused_unsafe)] // we're sometimes used within an unsafe block
24        // ignore-tidy-undocumented-unsafe
25        unsafe { &mut *((&raw mut $place) as *mut NonNull<$t>) }
26    }},
27    ($place:expr, $t:ident) => {{
28        #![allow(unused_unsafe)] // we're sometimes used within an unsafe block
29        // ignore-tidy-undocumented-unsafe
30        unsafe { *((&raw const $place) as *const NonNull<$t>) }
31    }},
32}
33
34/// An iterator that moves out of a vector.
35///
36/// This `struct` is created by the `into_iter` method on [`Vec`](super::Vec)
37/// (provided by the [`IntoIterator`] trait).
38///
39/// # Example
40///
41/// ```
42/// let v = vec![0, 1, 2];
43/// let iter: std::vec::IntoIter<_> = v.into_iter();
44/// ```
45#[stable(feature = "rust1", since = "1.0.0")]
46#[rustc_insignificant_dtor]
47pub struct IntoIter<
48    T,
49    #[stable(feature = "vec_into_iter_allocator", since = "CURRENT_RUSTC_VERSION")] A: Allocator = Global,
50> {
51    pub(super) buf: NonNull<T>,
52    pub(super) phantom: PhantomData<T>,
53    pub(super) cap: usize,
54    // the drop impl reconstructs a RawVec from buf, cap and alloc
55    // to avoid dropping the allocator twice we need to wrap it into ManuallyDrop
56    pub(super) alloc: ManuallyDrop<A>,
57    pub(super) ptr: NonNull<T>,
58    /// If T is a ZST, this is actually ptr+len. This encoding is picked so that
59    /// ptr == end is a quick test for the Iterator being empty, that works
60    /// for both ZST and non-ZST.
61    /// For non-ZSTs the pointer is treated as `NonNull<T>`
62    pub(super) end: *const T,
63}
64
65// Manually mirroring what `Vec` has,
66// because otherwise we get `T: RefUnwindSafe` from `NonNull`.
67#[stable(feature = "catch_unwind", since = "1.9.0")]
68impl<T: UnwindSafe, A: Allocator + UnwindSafe> UnwindSafe for IntoIter<T, A> {}
69
70#[stable(feature = "vec_intoiter_debug", since = "1.13.0")]
71impl<T: fmt::Debug, A: Allocator> fmt::Debug for IntoIter<T, A> {
72    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
73        f.debug_tuple("IntoIter").field(&self.as_slice()).finish()
74    }
75}
76
77impl<T, A: Allocator> IntoIter<T, A> {
78    /// Returns the remaining items of this iterator as a slice.
79    ///
80    /// # Examples
81    ///
82    /// ```
83    /// let vec = vec!['a', 'b', 'c'];
84    /// let mut into_iter = vec.into_iter();
85    /// assert_eq!(into_iter.as_slice(), &['a', 'b', 'c']);
86    /// let _ = into_iter.next().unwrap();
87    /// assert_eq!(into_iter.as_slice(), &['b', 'c']);
88    /// ```
89    #[stable(feature = "vec_into_iter_as_slice", since = "1.15.0")]
90    pub fn as_slice(&self) -> &[T] {
91        // ignore-tidy-undocumented-unsafe
92        unsafe { slice::from_raw_parts(self.ptr.as_ptr(), self.len()) }
93    }
94
95    /// Returns the remaining items of this iterator as a mutable slice.
96    ///
97    /// # Examples
98    ///
99    /// ```
100    /// let vec = vec!['a', 'b', 'c'];
101    /// let mut into_iter = vec.into_iter();
102    /// assert_eq!(into_iter.as_slice(), &['a', 'b', 'c']);
103    /// into_iter.as_mut_slice()[2] = 'z';
104    /// assert_eq!(into_iter.next().unwrap(), 'a');
105    /// assert_eq!(into_iter.next().unwrap(), 'b');
106    /// assert_eq!(into_iter.next().unwrap(), 'z');
107    /// ```
108    #[stable(feature = "vec_into_iter_as_slice", since = "1.15.0")]
109    pub fn as_mut_slice(&mut self) -> &mut [T] {
110        // ignore-tidy-undocumented-unsafe
111        unsafe { &mut *self.as_raw_mut_slice() }
112    }
113
114    /// Returns a reference to the underlying allocator.
115    #[stable(feature = "vec_into_iter_allocator", since = "CURRENT_RUSTC_VERSION")]
116    #[inline]
117    pub fn allocator(&self) -> &A {
118        &self.alloc
119    }
120
121    fn as_raw_mut_slice(&mut self) -> *mut [T] {
122        self.ptr.as_ptr().cast_slice(self.len())
123    }
124
125    /// Drops remaining elements and relinquishes the backing allocation.
126    ///
127    /// This method guarantees it won't panic before relinquishing the backing
128    /// allocation.
129    ///
130    /// This is roughly equivalent to the following, but more efficient
131    ///
132    /// ```
133    /// # let mut vec = Vec::<u8>::with_capacity(10);
134    /// # let ptr = vec.as_mut_ptr();
135    /// # let mut into_iter = vec.into_iter();
136    /// let mut into_iter = std::mem::replace(&mut into_iter, Vec::new().into_iter());
137    /// (&mut into_iter).for_each(drop);
138    /// std::mem::forget(into_iter);
139    /// # // FIXME(https://github.com/rust-lang/miri/issues/3670):
140    /// # // use -Zmiri-disable-leak-check instead of unleaking in tests meant to leak.
141    /// # drop(unsafe { Vec::<u8>::from_raw_parts(ptr, 0, 10) });
142    /// ```
143    ///
144    /// This method is used by in-place iteration, refer to the vec::in_place_collect
145    /// documentation for an overview.
146    #[cfg(not(no_global_oom_handling))]
147    pub(super) fn forget_allocation_drop_remaining(&mut self) {
148        let remaining = self.as_raw_mut_slice();
149
150        // overwrite the individual fields instead of creating a new
151        // struct and then overwriting &mut self.
152        // this creates less assembly
153        self.cap = 0;
154        self.buf = RawVec::new().non_null();
155        self.ptr = self.buf;
156        self.end = self.buf.as_ptr();
157
158        // Dropping the remaining elements can panic, so this needs to be
159        // done only after updating the other fields.
160        // ignore-tidy-undocumented-unsafe
161        unsafe {
162            ptr::drop_in_place(remaining);
163        }
164    }
165
166    /// Forgets to Drop the remaining elements while still allowing the backing allocation to be freed.
167    ///
168    /// This method does not consume `self`, and leaves deallocation to `impl Drop for IntoIter`.
169    /// If consuming `self` is possible, consider calling
170    /// [`Self::forget_remaining_elements_and_dealloc()`] instead.
171    pub(crate) fn forget_remaining_elements(&mut self) {
172        // For the ZST case, it is crucial that we mutate `end` here, not `ptr`.
173        // `ptr` must stay aligned, while `end` may be unaligned.
174        self.end = self.ptr.as_ptr();
175    }
176
177    /// Forgets to Drop the remaining elements and frees the backing allocation.
178    /// Consuming version of [`Self::forget_remaining_elements()`].
179    ///
180    /// This can be used in place of `drop(self)` when `self` is known to be exhausted,
181    /// to avoid producing a needless `drop_in_place::<[T]>()`.
182    #[inline]
183    pub(crate) fn forget_remaining_elements_and_dealloc(self) {
184        let mut this = ManuallyDrop::new(self);
185        // SAFETY: `this` is in ManuallyDrop, so it will not be double-freed.
186        unsafe {
187            this.dealloc_only();
188        }
189    }
190
191    /// Frees the allocation, without checking or dropping anything else.
192    ///
193    /// The safe version of this method is [`Self::forget_remaining_elements_and_dealloc()`].
194    /// This function exists only to share code between that method and the `impl Drop`.
195    ///
196    /// # Safety
197    ///
198    /// This function must only be called with an [`IntoIter`] that is not going to be dropped
199    /// or otherwise used in any way, either because it is being forgotten or because its `Drop`
200    /// is already executing; otherwise a double-free will occur, and possibly a read from freed
201    /// memory if there are any remaining elements.
202    #[inline]
203    unsafe fn dealloc_only(&mut self) {
204        // SAFETY: our caller promises not to touch `*self` again.
205        let alloc = unsafe { ManuallyDrop::take(&mut self.alloc) };
206        // SAFETY: We're using this to deallocate a preexisting `RawVec`.
207        let _ = unsafe { RawVec::from_nonnull_in(self.buf, self.cap, alloc) };
208    }
209
210    #[cfg(not(no_global_oom_handling))]
211    #[inline]
212    pub(crate) fn into_vecdeque(self) -> VecDeque<T, A> {
213        // Keep our `Drop` impl from dropping the elements and the allocator
214        let mut this = ManuallyDrop::new(self);
215
216        let buf = this.buf.as_ptr();
217        let initialized = if T::IS_ZST || this.len() == 0 {
218            // All the pointers are the same for ZSTs, so it's fine to
219            // say that they're all at the beginning of the "allocation".
220            // For non-ZSTs, we have length 0, so we can choose the (empty)
221            // range to be at the start of the buffer.
222            //
223            // Due to `0` ≤ `this.len()` ≤ `this.cap`, the range is well-formed,
224            // and due to the argument above it spans exactly the elements of
225            // this iterator. Because `init.start` = `0`, it follows that either
226            // `init.start` < `cap` or `cap` = `init.start` = `0`; thus the range
227            // satisfies the requirements of `from_contiguous_raw_parts_in`.
228            0..this.len()
229        } else {
230            // SAFETY: `this.ptr` and `this.end` are created via offsets of `this.buf`,
231            // so they point to the same allocation. We have `this.buf` ≤ `this.ptr` ≤ `this.end`,
232            // so this cannot wrap, and will produce a well-formed range that spans exactly
233            // the elements of this iterator.
234            //
235            // Additionally, due to `end ≤ buf + cap`, we have `init.start` ≤ `init.end` ≤ `cap`.
236            // Due to the length check above, `init.start < cap`, so the range satisfies the
237            // requirements of `from_contiguous_raw_parts_in`.
238            unsafe { this.ptr.offset_from_unsigned(this.buf)..this.end.offset_from_unsigned(buf) }
239        };
240
241        let cap = this.cap;
242        // SAFETY: `this` is forgotten afterwards, so we can move out the allocator.
243        let alloc = unsafe { ManuallyDrop::take(&mut this.alloc) };
244
245        // SAFETY: This allocation originally came from a `Vec`, so it satisfies all
246        // requirements for the `buf` pointer with capacity `cap` allocated in `alloc`.
247        // Correctness of `initialized` was shown above.
248        unsafe { VecDeque::from_contiguous_raw_parts_in(buf, initialized, cap, alloc) }
249    }
250}
251
252#[stable(feature = "vec_intoiter_as_ref", since = "1.46.0")]
253impl<T, A: Allocator> AsRef<[T]> for IntoIter<T, A> {
254    fn as_ref(&self) -> &[T] {
255        self.as_slice()
256    }
257}
258
259#[stable(feature = "rust1", since = "1.0.0")]
260unsafe impl<T: Send, A: Allocator + Send> Send for IntoIter<T, A> {}
261#[stable(feature = "rust1", since = "1.0.0")]
262unsafe impl<T: Sync, A: Allocator + Sync> Sync for IntoIter<T, A> {}
263
264#[stable(feature = "rust1", since = "1.0.0")]
265impl<T, A: Allocator> Iterator for IntoIter<T, A> {
266    type Item = T;
267
268    #[inline]
269    fn next(&mut self) -> Option<T> {
270        let ptr = if T::IS_ZST {
271            if self.ptr.as_ptr() == self.end as *mut T {
272                return None;
273            }
274            // `ptr` has to stay where it is to remain aligned, so we reduce the length by 1 by
275            // reducing the `end`.
276            self.end = self.end.wrapping_byte_sub(1);
277            self.ptr
278        } else {
279            if self.ptr == non_null!(self.end, T) {
280                return None;
281            }
282            let old = self.ptr;
283            // ignore-tidy-undocumented-unsafe
284            self.ptr = unsafe { old.add(1) };
285            old
286        };
287        // ignore-tidy-undocumented-unsafe
288        Some(unsafe { ptr.read() })
289    }
290
291    #[inline]
292    fn size_hint(&self) -> (usize, Option<usize>) {
293        let exact = if T::IS_ZST {
294            self.end.addr().wrapping_sub(self.ptr.as_ptr().addr())
295        } else {
296            // ignore-tidy-undocumented-unsafe
297            unsafe { non_null!(self.end, T).offset_from_unsigned(self.ptr) }
298        };
299        (exact, Some(exact))
300    }
301
302    #[inline]
303    fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>> {
304        let step_size = self.len().min(n);
305        let to_drop = self.ptr.as_ptr().cast_slice(step_size);
306        if T::IS_ZST {
307            // See `next` for why we sub `end` here.
308            self.end = self.end.wrapping_byte_sub(step_size);
309        } else {
310            // SAFETY: the min() above ensures that step_size is in bounds
311            self.ptr = unsafe { self.ptr.add(step_size) };
312        }
313        // SAFETY: the min() above ensures that step_size is in bounds
314        unsafe {
315            ptr::drop_in_place(to_drop);
316        }
317        NonZero::new(n - step_size).map_or(Ok(()), Err)
318    }
319
320    #[inline]
321    fn count(self) -> usize {
322        self.len()
323    }
324
325    #[inline]
326    fn last(mut self) -> Option<T> {
327        self.next_back()
328    }
329
330    #[inline]
331    fn next_chunk<const N: usize>(&mut self) -> Result<[T; N], core::array::IntoIter<T, N>> {
332        let mut raw_ary = [const { MaybeUninit::uninit() }; N];
333
334        let len = self.len();
335
336        if T::IS_ZST {
337            if len < N {
338                self.forget_remaining_elements();
339                // SAFETY: ZSTs can be conjured ex nihilo, only the amount has to be correct
340                return Err(unsafe { array::IntoIter::new_unchecked(raw_ary, 0..len) });
341            }
342
343            self.end = self.end.wrapping_byte_sub(N);
344            // SAFETY: ditto
345            return Ok(unsafe { raw_ary.transpose().assume_init() });
346        }
347
348        if len < N {
349            // SAFETY: `len` indicates that this many elements are available and we
350            // just checked that it fits into the array.
351            unsafe {
352                ptr::copy_nonoverlapping(self.ptr.as_ptr(), raw_ary.as_mut_ptr() as *mut T, len);
353                self.forget_remaining_elements();
354                return Err(array::IntoIter::new_unchecked(raw_ary, 0..len));
355            }
356        }
357
358        // SAFETY: `len` is larger than the array size. Copy a fixed amount here to fully initialize
359        // the array.
360        unsafe {
361            ptr::copy_nonoverlapping(self.ptr.as_ptr(), raw_ary.as_mut_ptr() as *mut T, N);
362            self.ptr = self.ptr.add(N);
363            Ok(raw_ary.transpose().assume_init())
364        }
365    }
366
367    #[inline]
368    fn fold<B, F>(mut self, mut accum: B, mut f: F) -> B
369    where
370        F: FnMut(B, Self::Item) -> B,
371    {
372        if T::IS_ZST {
373            while self.ptr.as_ptr() != self.end.cast_mut() {
374                // SAFETY: we just checked that `self.ptr` is in bounds.
375                let tmp = unsafe { self.ptr.read() };
376                // See `next` for why we subtract from `end` here.
377                self.end = self.end.wrapping_byte_sub(1);
378                accum = f(accum, tmp);
379            }
380        } else {
381            // SAFETY: `self.end` can only be null if `T` is a ZST.
382            while self.ptr != non_null!(self.end, T) {
383                // SAFETY: we just checked that `self.ptr` is in bounds.
384                let tmp = unsafe { self.ptr.read() };
385                // SAFETY: the maximum this can be is `self.end`.
386                // Increment `self.ptr` first to avoid double dropping in the event of a panic.
387                self.ptr = unsafe { self.ptr.add(1) };
388                accum = f(accum, tmp);
389            }
390        }
391
392        // There are in fact no remaining elements to forget, but by doing this we can avoid
393        // potentially generating a needless loop to drop the elements that cannot exist at
394        // this point.
395        self.forget_remaining_elements_and_dealloc();
396
397        accum
398    }
399
400    #[inline]
401    fn try_fold<B, F, R>(&mut self, mut accum: B, mut f: F) -> R
402    where
403        Self: Sized,
404        F: FnMut(B, Self::Item) -> R,
405        R: core::ops::Try<Output = B>,
406    {
407        if T::IS_ZST {
408            while self.ptr.as_ptr() != self.end.cast_mut() {
409                // SAFETY: we just checked that `self.ptr` is in bounds.
410                let tmp = unsafe { self.ptr.read() };
411                // See `next` for why we subtract from `end` here.
412                self.end = self.end.wrapping_byte_sub(1);
413                accum = f(accum, tmp)?;
414            }
415        } else {
416            // SAFETY: `self.end` can only be null if `T` is a ZST.
417            while self.ptr != non_null!(self.end, T) {
418                // SAFETY: we just checked that `self.ptr` is in bounds.
419                let tmp = unsafe { self.ptr.read() };
420                // SAFETY: the maximum this can be is `self.end`.
421                // Increment `self.ptr` first to avoid double dropping in the event of a panic.
422                self.ptr = unsafe { self.ptr.add(1) };
423                accum = f(accum, tmp)?;
424            }
425        }
426        R::from_output(accum)
427    }
428
429    unsafe fn __iterator_get_unchecked(&mut self, i: usize) -> Self::Item
430    where
431        Self: TrustedRandomAccessNoCoerce,
432    {
433        // SAFETY: the caller must guarantee that `i` is in bounds of the
434        // `Vec<T>`, so `i` cannot overflow an `isize`, and the `self.ptr.add(i)`
435        // is guaranteed to pointer to an element of the `Vec<T>` and
436        // thus guaranteed to be valid to dereference.
437        //
438        // Also note the implementation of `Self: TrustedRandomAccess` requires
439        // that `T: Copy` so reading elements from the buffer doesn't invalidate
440        // them for `Drop`.
441        unsafe { self.ptr.add(i).read() }
442    }
443}
444
445#[stable(feature = "rust1", since = "1.0.0")]
446impl<T, A: Allocator> DoubleEndedIterator for IntoIter<T, A> {
447    #[inline]
448    fn next_back(&mut self) -> Option<T> {
449        if T::IS_ZST {
450            if self.ptr.as_ptr() == self.end as *mut _ {
451                return None;
452            }
453            // See above for why 'ptr.offset' isn't used
454            self.end = self.end.wrapping_byte_sub(1);
455            // Note that even though this is next_back() we're reading from `self.ptr`, not
456            // `self.end`. We track our length using the byte offset from `self.ptr` to `self.end`,
457            // so the end pointer may not be suitably aligned for T.
458            // ignore-tidy-undocumented-unsafe
459            Some(unsafe { ptr::read(self.ptr.as_ptr()) })
460        } else {
461            if self.ptr == non_null!(self.end, T) {
462                return None;
463            }
464            // ignore-tidy-undocumented-unsafe
465            unsafe {
466                self.end = self.end.sub(1);
467                Some(ptr::read(self.end))
468            }
469        }
470    }
471
472    #[inline]
473    fn next_chunk_back<const N: usize>(&mut self) -> Result<[T; N], core::array::IntoIter<T, N>> {
474        let mut raw_ary = [const { MaybeUninit::uninit() }; N];
475
476        let len = self.len();
477
478        if T::IS_ZST {
479            if len < N {
480                self.forget_remaining_elements();
481                // SAFETY: ZSTs can be conjured ex nihilo, only the amount has to be correct
482                return Err(unsafe { array::IntoIter::new_unchecked(raw_ary, N - len..N) });
483            }
484
485            self.end = self.end.wrapping_byte_sub(N);
486            // SAFETY: ditto
487            return Ok(unsafe { MaybeUninit::array_assume_init(raw_ary) });
488        }
489
490        if len < N {
491            // SAFETY: `len` indicates that this many elements are available
492            // and we just checked that it fits into the array.
493            unsafe {
494                ptr::copy_nonoverlapping(self.ptr.as_ptr(), raw_ary.as_mut_ptr() as *mut T, len);
495                self.forget_remaining_elements();
496                return Err(array::IntoIter::new_unchecked(raw_ary, 0..len));
497            }
498        }
499
500        // SAFETY: `len` is larger than the array size. Copy a fixed amount here to fully initialize
501        // the array.
502        unsafe {
503            ptr::copy_nonoverlapping(
504                self.ptr.add(len - N).as_ptr(),
505                raw_ary.as_mut_ptr() as *mut T,
506                N,
507            );
508            self.end = self.end.sub(N);
509            Ok(MaybeUninit::array_assume_init(raw_ary))
510        }
511    }
512
513    #[inline]
514    fn advance_back_by(&mut self, n: usize) -> Result<(), NonZero<usize>> {
515        let step_size = self.len().min(n);
516        if T::IS_ZST {
517            // SAFETY: same as for advance_by()
518            self.end = self.end.wrapping_byte_sub(step_size);
519        } else {
520            // SAFETY: same as for advance_by()
521            self.end = unsafe { self.end.sub(step_size) };
522        }
523        let to_drop = if T::IS_ZST {
524            // ZST may cause unalignment
525            ptr::NonNull::<T>::dangling().as_ptr().cast_slice(step_size)
526        } else {
527            self.end.cast::<T>().cast_mut().cast_slice(step_size)
528        };
529        // SAFETY: same as for advance_by()
530        unsafe {
531            ptr::drop_in_place(to_drop);
532        }
533        NonZero::new(n - step_size).map_or(Ok(()), Err)
534    }
535}
536
537#[stable(feature = "rust1", since = "1.0.0")]
538impl<T, A: Allocator> ExactSizeIterator for IntoIter<T, A> {
539    fn is_empty(&self) -> bool {
540        if T::IS_ZST {
541            self.ptr.as_ptr() == self.end as *mut _
542        } else {
543            self.ptr == non_null!(self.end, T)
544        }
545    }
546}
547
548#[stable(feature = "fused", since = "1.26.0")]
549impl<T, A: Allocator> FusedIterator for IntoIter<T, A> {}
550
551#[doc(hidden)]
552#[unstable(issue = "none", feature = "trusted_fused")]
553unsafe impl<T, A: Allocator> TrustedFused for IntoIter<T, A> {}
554
555#[unstable(feature = "trusted_len", issue = "37572")]
556unsafe impl<T, A: Allocator> TrustedLen for IntoIter<T, A> {}
557
558#[stable(feature = "default_iters", since = "1.70.0")]
559impl<T, A> Default for IntoIter<T, A>
560where
561    A: Allocator + Default,
562{
563    /// Creates an empty `vec::IntoIter`.
564    ///
565    /// ```
566    /// # use std::vec;
567    /// let iter: vec::IntoIter<u8> = Default::default();
568    /// assert_eq!(iter.len(), 0);
569    /// assert_eq!(iter.as_slice(), &[]);
570    /// ```
571    fn default() -> Self {
572        super::Vec::new_in(Default::default()).into_iter()
573    }
574}
575
576#[doc(hidden)]
577#[unstable(issue = "none", feature = "std_internals")]
578#[unsafe(rustc_allow_lifetime_dependent_specialization)]
579trait NonDrop {}
580
581// T: Copy as approximation for !Drop since get_unchecked does not advance self.ptr
582// and thus we can't implement drop-handling
583#[unstable(issue = "none", feature = "std_internals")]
584impl<T: Copy> NonDrop for T {}
585
586#[doc(hidden)]
587#[unstable(issue = "none", feature = "std_internals")]
588// TrustedRandomAccess (without NoCoerce) must not be implemented because
589// subtypes/supertypes of `T` might not be `NonDrop`
590unsafe impl<T, A: Allocator> TrustedRandomAccessNoCoerce for IntoIter<T, A>
591where
592    T: NonDrop,
593{
594    const MAY_HAVE_SIDE_EFFECT: bool = false;
595}
596
597#[cfg(not(no_global_oom_handling))]
598#[stable(feature = "vec_into_iter_clone", since = "1.8.0")]
599impl<T: Clone, A: Allocator + Clone> Clone for IntoIter<T, A> {
600    fn clone(&self) -> Self {
601        self.as_slice().to_vec_in(self.alloc.deref().clone()).into_iter()
602    }
603}
604
605#[stable(feature = "rust1", since = "1.0.0")]
606unsafe impl<#[may_dangle] T, A: Allocator> Drop for IntoIter<T, A> {
607    fn drop(&mut self) {
608        struct DropGuard<'a, T, A: Allocator>(&'a mut IntoIter<T, A>);
609
610        impl<T, A: Allocator> Drop for DropGuard<'_, T, A> {
611            fn drop(&mut self) {
612                // ignore-tidy-undocumented-unsafe
613                unsafe {
614                    self.0.dealloc_only();
615                }
616            }
617        }
618
619        let guard = DropGuard(self);
620        // destroy the remaining elements
621        // ignore-tidy-undocumented-unsafe
622        unsafe {
623            ptr::drop_in_place(guard.0.as_raw_mut_slice());
624        }
625        // now `guard` will be dropped and do the rest
626    }
627}
628
629// In addition to the SAFETY invariants of the following three unsafe traits
630// also refer to the vec::in_place_collect module documentation to get an overview
631#[unstable(issue = "none", feature = "inplace_iteration")]
632#[doc(hidden)]
633unsafe impl<T, A: Allocator> InPlaceIterable for IntoIter<T, A> {
634    const EXPAND_BY: Option<NonZero<usize>> = NonZero::new(1);
635    const MERGE_BY: Option<NonZero<usize>> = NonZero::new(1);
636}
637
638#[unstable(issue = "none", feature = "inplace_iteration")]
639#[doc(hidden)]
640unsafe impl<T, A: Allocator> SourceIter for IntoIter<T, A> {
641    type Source = Self;
642
643    #[inline]
644    unsafe fn as_inner(&mut self) -> &mut Self::Source {
645        self
646    }
647}
648
649#[cfg(not(no_global_oom_handling))]
650unsafe impl<T> AsVecIntoIter for IntoIter<T> {
651    type Item = T;
652
653    fn as_into_iter(&mut self) -> &mut IntoIter<Self::Item> {
654        self
655    }
656}