Skip to main content

alloc/vec/
mod.rs

1//! A contiguous growable array type with heap-allocated contents, written
2//! `Vec<T>`.
3//!
4//! Vectors have *O*(1) indexing, amortized *O*(1) push (to the end) and
5//! *O*(1) pop (from the end).
6//!
7//! Vectors ensure they never allocate more than `isize::MAX` bytes.
8//!
9//! # Examples
10//!
11//! You can explicitly create a [`Vec`] with [`Vec::new`]:
12//!
13//! ```
14//! let v: Vec<i32> = Vec::new();
15//! ```
16//!
17//! ...or by using the [`vec!`] macro:
18//!
19//! ```
20//! let v: Vec<i32> = vec![];
21//!
22//! let v = vec![1, 2, 3, 4, 5];
23//!
24//! let v = vec![0; 10]; // ten zeroes
25//! ```
26//!
27//! You can [`push`] values onto the end of a vector (which will grow the vector
28//! as needed):
29//!
30//! ```
31//! let mut v = vec![1, 2];
32//!
33//! v.push(3);
34//! ```
35//!
36//! Popping values works in much the same way:
37//!
38//! ```
39//! let mut v = vec![1, 2];
40//!
41//! let two = v.pop();
42//! ```
43//!
44//! Vectors also support indexing (through the [`Index`] and [`IndexMut`] traits):
45//!
46//! ```
47//! let mut v = vec![1, 2, 3];
48//! let three = v[2];
49//! v[1] = v[1] + 5;
50//! ```
51//!
52//! # Memory layout
53//!
54//! When the type is non-zero-sized and the capacity is nonzero, [`Vec`] uses the [`Global`]
55//! allocator for its allocation. It is valid to convert both ways between such a [`Vec`] and a raw
56//! pointer allocated with the [`Global`] allocator, provided that the [`Layout`] used with the
57//! allocator is correct for a sequence of `capacity` elements of the type, and the first `len`
58//! values pointed to by the raw pointer are valid. More precisely, a `ptr: *mut T` that has been
59//! allocated with the [`Global`] allocator with [`Layout::array::<T>(capacity)`][Layout::array] may
60//! be converted into a vec using
61//! [`Vec::<T>::from_raw_parts(ptr, len, capacity)`](Vec::from_raw_parts). Conversely, the memory
62//! backing a `value: *mut T` obtained from [`Vec::<T>::as_mut_ptr`] may be deallocated using the
63//! [`Global`] allocator with the same layout.
64//!
65//! For zero-sized types (ZSTs), or when the capacity is zero, the `Vec` pointer must be non-null
66//! and sufficiently aligned. The recommended way to build a `Vec` of ZSTs if [`vec!`] cannot be
67//! used is to use [`ptr::NonNull::dangling`].
68//!
69//! [`push`]: Vec::push
70//! [`ptr::NonNull::dangling`]: NonNull::dangling
71//! [`Layout`]: crate::alloc::Layout
72//! [Layout::array]: crate::alloc::Layout::array
73
74#![stable(feature = "rust1", since = "1.0.0")]
75
76#[cfg(not(no_global_oom_handling))]
77use core::clone::TrivialClone;
78use core::cmp::Ordering;
79use core::hash::{Hash, Hasher};
80#[cfg(not(no_global_oom_handling))]
81use core::iter;
82#[cfg(not(no_global_oom_handling))]
83use core::marker::Destruct;
84use core::marker::{Freeze, PhantomData};
85use core::mem::{self, Assume, ManuallyDrop, MaybeUninit, SizedTypeProperties, TransmuteFrom};
86use core::ops::{self, Index, IndexMut, Range, RangeBounds};
87use core::ptr::{self, NonNull};
88use core::slice::{self, SliceIndex};
89use core::{cmp, fmt, hint, intrinsics, ub_checks};
90
91#[stable(feature = "extract_if", since = "1.87.0")]
92pub use self::extract_if::ExtractIf;
93use crate::alloc::{Allocator, Global};
94use crate::borrow::{Cow, ToOwned};
95use crate::boxed::Box;
96use crate::collections::TryReserveError;
97use crate::raw_vec::RawVec;
98
99mod extract_if;
100
101#[cfg(not(no_global_oom_handling))]
102#[stable(feature = "vec_splice", since = "1.21.0")]
103pub use self::splice::Splice;
104
105#[cfg(not(no_global_oom_handling))]
106mod splice;
107
108#[stable(feature = "drain", since = "1.6.0")]
109pub use self::drain::Drain;
110
111mod drain;
112
113#[cfg(not(no_global_oom_handling))]
114mod cow;
115
116#[cfg(not(no_global_oom_handling))]
117pub(crate) use self::in_place_collect::AsVecIntoIter;
118#[stable(feature = "rust1", since = "1.0.0")]
119pub use self::into_iter::IntoIter;
120
121mod into_iter;
122
123#[cfg(not(no_global_oom_handling))]
124use self::is_zero::IsZero;
125
126#[cfg(not(no_global_oom_handling))]
127mod is_zero;
128
129#[cfg(not(no_global_oom_handling))]
130mod in_place_collect;
131
132mod partial_eq;
133
134#[unstable(feature = "vec_peek_mut", issue = "122742")]
135pub use self::peek_mut::PeekMut;
136
137mod peek_mut;
138
139#[cfg(not(no_global_oom_handling))]
140use self::spec_from_elem::SpecFromElem;
141
142#[cfg(not(no_global_oom_handling))]
143mod spec_from_elem;
144
145#[cfg(not(no_global_oom_handling))]
146use self::set_len_on_drop::SetLenOnDrop;
147
148#[cfg(not(no_global_oom_handling))]
149mod set_len_on_drop;
150
151#[cfg(not(no_global_oom_handling))]
152use self::in_place_drop::{InPlaceDrop, InPlaceDstDataSrcBufDrop};
153
154#[cfg(not(no_global_oom_handling))]
155mod in_place_drop;
156
157#[cfg(not(no_global_oom_handling))]
158use self::spec_from_iter_nested::SpecFromIterNested;
159
160#[cfg(not(no_global_oom_handling))]
161mod spec_from_iter_nested;
162
163#[cfg(not(no_global_oom_handling))]
164use self::spec_from_iter::SpecFromIter;
165
166#[cfg(not(no_global_oom_handling))]
167mod spec_from_iter;
168
169#[cfg(not(no_global_oom_handling))]
170use self::spec_extend::SpecExtend;
171
172#[cfg(not(no_global_oom_handling))]
173mod spec_extend;
174
175/// A contiguous growable array type, written as `Vec<T>`, short for 'vector'.
176///
177/// # Examples
178///
179/// ```
180/// let mut vec = Vec::new();
181/// vec.push(1);
182/// vec.push(2);
183///
184/// assert_eq!(vec.len(), 2);
185/// assert_eq!(vec[0], 1);
186///
187/// assert_eq!(vec.pop(), Some(2));
188/// assert_eq!(vec.len(), 1);
189///
190/// vec[0] = 7;
191/// assert_eq!(vec[0], 7);
192///
193/// vec.extend([1, 2, 3]);
194///
195/// for x in &vec {
196///     println!("{x}");
197/// }
198/// assert_eq!(vec, [7, 1, 2, 3]);
199/// ```
200///
201/// The [`vec!`] macro is provided for convenient initialization:
202///
203/// ```
204/// let mut vec1 = vec![1, 2, 3];
205/// vec1.push(4);
206/// let vec2 = Vec::from([1, 2, 3, 4]);
207/// assert_eq!(vec1, vec2);
208/// ```
209///
210/// It can also initialize each element of a `Vec<T>` with a given value.
211/// This may be more efficient than performing allocation and initialization
212/// in separate steps, especially when initializing a vector of zeros:
213///
214/// ```
215/// let vec = vec![0; 5];
216/// assert_eq!(vec, [0, 0, 0, 0, 0]);
217///
218/// // The following is equivalent, but potentially slower:
219/// let mut vec = Vec::with_capacity(5);
220/// vec.resize(5, 0);
221/// assert_eq!(vec, [0, 0, 0, 0, 0]);
222/// ```
223///
224/// For more information, see
225/// [Capacity and Reallocation](#capacity-and-reallocation).
226///
227/// Use a `Vec<T>` as an efficient stack:
228///
229/// ```
230/// let mut stack = Vec::new();
231///
232/// stack.push(1);
233/// stack.push(2);
234/// stack.push(3);
235///
236/// while let Some(top) = stack.pop() {
237///     // Prints 3, 2, 1
238///     println!("{top}");
239/// }
240/// ```
241///
242/// # Indexing
243///
244/// The `Vec` type allows access to values by index, because it implements the
245/// [`Index`] trait. An example will be more explicit:
246///
247/// ```
248/// let v = vec![0, 2, 4, 6];
249/// println!("{}", v[1]); // it will display '2'
250/// ```
251///
252/// However be careful: if you try to access an index which isn't in the `Vec`,
253/// your software will panic! You cannot do this:
254///
255/// ```should_panic
256/// let v = vec![0, 2, 4, 6];
257/// println!("{}", v[6]); // it will panic!
258/// ```
259///
260/// Use [`get`] and [`get_mut`] if you want to check whether the index is in
261/// the `Vec`.
262///
263/// # Slicing
264///
265/// A `Vec` can be mutable. On the other hand, slices are read-only objects.
266/// To get a [slice][prim@slice], use [`&`]. Example:
267///
268/// ```
269/// fn read_slice(slice: &[usize]) {
270///     // ...
271/// }
272///
273/// let v = vec![0, 1];
274/// read_slice(&v);
275///
276/// // ... and that's all!
277/// // you can also do it like this:
278/// let u: &[usize] = &v;
279/// // or like this:
280/// let u: &[_] = &v;
281/// ```
282///
283/// In Rust, it's more common to pass slices as arguments rather than vectors
284/// when you just want to provide read access. The same goes for [`String`] and
285/// [`&str`].
286///
287/// # Capacity and reallocation
288///
289/// The capacity of a vector is the amount of space allocated for any future
290/// elements that will be added onto the vector. This is not to be confused with
291/// the *length* of a vector, which specifies the number of actual elements
292/// within the vector. If a vector's length exceeds its capacity, its capacity
293/// will automatically be increased, but its elements will have to be
294/// reallocated.
295///
296/// For example, a vector with capacity 10 and length 0 would be an empty vector
297/// with space for 10 more elements. Pushing 10 or fewer elements onto the
298/// vector will not change its capacity or cause reallocation to occur. However,
299/// if the vector's length is increased to 11, it will have to reallocate, which
300/// can be slow. For this reason, it is recommended to use [`Vec::with_capacity`]
301/// whenever possible to specify how big the vector is expected to get.
302///
303/// # Guarantees
304///
305/// Due to its incredibly fundamental nature, `Vec` makes a lot of guarantees
306/// about its design. This ensures that it's as low-overhead as possible in
307/// the general case, and can be correctly manipulated in primitive ways
308/// by unsafe code. Note that these guarantees refer to an unqualified `Vec<T>`.
309/// If additional type parameters are added (e.g., to support custom allocators),
310/// overriding their defaults may change the behavior.
311///
312/// Most fundamentally, `Vec` is and always will be a (pointer, capacity, length)
313/// triplet. No more, no less. The order of these fields is completely
314/// unspecified, and you should use the appropriate methods to modify these.
315/// The pointer will never be null, so this type is null-pointer-optimized.
316///
317/// However, the pointer might not actually point to allocated memory. In particular,
318/// if you construct a `Vec` with capacity 0 via [`Vec::new`], [`vec![]`][`vec!`],
319/// [`Vec::with_capacity(0)`][`Vec::with_capacity`], or by calling [`shrink_to_fit`]
320/// on an empty Vec, it will not allocate memory. Similarly, if you store zero-sized
321/// types inside a `Vec`, it will not allocate space for them. *Note that in this case
322/// the `Vec` might not report a [`capacity`] of 0*. `Vec` will allocate if and only
323/// if <code>[size_of::\<T>]\() * [capacity]\() > 0</code>. In general, `Vec`'s allocation
324/// details are very subtle --- if you intend to allocate memory using a `Vec`
325/// and use it for something else (either to pass to unsafe code, or to build your
326/// own memory-backed collection), be sure to deallocate this memory by using
327/// `from_raw_parts` to recover the `Vec` and then dropping it.
328///
329/// If a `Vec` *has* allocated memory, then the memory it points to is on the heap
330/// (as defined by the allocator Rust is configured to use by default), and its
331/// pointer points to [`len`] initialized, contiguous elements in order (what
332/// you would see if you coerced it to a slice), followed by <code>[capacity] - [len]</code>
333/// logically uninitialized, contiguous elements.
334///
335/// A vector containing the elements `'a'` and `'b'` with capacity 4 can be
336/// visualized as below. The top part is the `Vec` struct, it contains a
337/// pointer to the head of the allocation in the heap, length and capacity.
338/// The bottom part is the allocation on the heap, a contiguous memory block.
339///
340/// ```text
341///             ptr      len  capacity
342///        +--------+--------+--------+
343///        | 0x0123 |      2 |      4 |
344///        +--------+--------+--------+
345///             |
346///             v
347/// Heap   +--------+--------+--------+--------+
348///        |    'a' |    'b' | uninit | uninit |
349///        +--------+--------+--------+--------+
350/// ```
351///
352/// - **uninit** represents memory that is not initialized, see [`MaybeUninit`].
353/// - Note: the ABI is not stable and `Vec` makes no guarantees about its memory
354///   layout (including the order of fields).
355///
356/// `Vec` will never perform a "small optimization" where elements are actually
357/// stored on the stack for two reasons:
358///
359/// * It would make it more difficult for unsafe code to correctly manipulate
360///   a `Vec`. The contents of a `Vec` wouldn't have a stable address if it were
361///   only moved, and it would be more difficult to determine if a `Vec` had
362///   actually allocated memory.
363///
364/// * It would penalize the general case, incurring an additional branch
365///   on every access.
366///
367/// `Vec` will never automatically shrink itself, even if completely empty. This
368/// ensures no unnecessary allocations or deallocations occur. Emptying a `Vec`
369/// and then filling it back up to the same [`len`] should incur no calls to
370/// the allocator. If you wish to free up unused memory, use
371/// [`shrink_to_fit`] or [`shrink_to`].
372///
373/// [`push`] and [`insert`] will never (re)allocate if the reported capacity is
374/// sufficient. [`push`] and [`insert`] *will* (re)allocate if
375/// <code>[len] == [capacity]</code>. That is, the reported capacity is completely
376/// accurate, and can be relied on. It can even be used to manually free the memory
377/// allocated by a `Vec` if desired. Bulk insertion methods *may* reallocate, even
378/// when not necessary.
379///
380/// `Vec` does not guarantee any particular growth strategy when reallocating
381/// when full, nor when [`reserve`] is called. The current strategy is basic
382/// and it may prove desirable to use a non-constant growth factor. Whatever
383/// strategy is used will of course guarantee *O*(1) amortized [`push`].
384///
385/// It is guaranteed, in order to respect the intentions of the programmer, that
386/// all of `vec![e_1, e_2, ..., e_n]`, `vec![x; n]`, and [`Vec::with_capacity(n)`] produce a `Vec`
387/// that requests an allocation of the exact size needed for precisely `n` elements from the allocator,
388/// and no other size (such as, for example: a size rounded up to the nearest power of 2).
389/// The allocator will return an allocation that is at least as large as requested, but it may be larger.
390///
391/// It is guaranteed that the [`Vec::capacity`] method returns a value that is at least the requested capacity
392/// and not more than the allocated capacity.
393///
394/// The method [`Vec::shrink_to_fit`] will attempt to discard excess capacity an allocator has given to a `Vec`.
395/// If <code>[len] == [capacity]</code>, then a `Vec<T>` can be converted
396/// to and from a [`Box<[T]>`][owned slice] without reallocating or moving the elements.
397/// `Vec` exploits this fact as much as reasonable when implementing common conversions
398/// such as [`into_boxed_slice`].
399///
400/// `Vec` will not specifically overwrite any data that is removed from it,
401/// but also won't specifically preserve it. Its uninitialized memory is
402/// scratch space that it may use however it wants. It will generally just do
403/// whatever is most efficient or otherwise easy to implement. Do not rely on
404/// removed data to be erased for security purposes. Even if you drop a `Vec`, its
405/// buffer may simply be reused by another allocation. Even if you zero a `Vec`'s memory
406/// first, that might not actually happen because the optimizer does not consider
407/// this a side-effect that must be preserved. There is one case which we will
408/// not break, however: using `unsafe` code to write to the excess capacity,
409/// and then increasing the length to match, is always valid.
410///
411/// Currently, `Vec` does not guarantee the order in which elements are dropped.
412/// The order has changed in the past and may change again.
413///
414/// [`get`]: slice::get
415/// [`get_mut`]: slice::get_mut
416/// [`String`]: crate::string::String
417/// [`&str`]: type@str
418/// [`shrink_to_fit`]: Vec::shrink_to_fit
419/// [`shrink_to`]: Vec::shrink_to
420/// [capacity]: Vec::capacity
421/// [`capacity`]: Vec::capacity
422/// [`Vec::capacity`]: Vec::capacity
423/// [size_of::\<T>]: size_of
424/// [len]: Vec::len
425/// [`len`]: Vec::len
426/// [`push`]: Vec::push
427/// [`insert`]: Vec::insert
428/// [`reserve`]: Vec::reserve
429/// [`Vec::with_capacity(n)`]: Vec::with_capacity
430/// [`MaybeUninit`]: core::mem::MaybeUninit
431/// [owned slice]: Box
432/// [`into_boxed_slice`]: Vec::into_boxed_slice
433#[stable(feature = "rust1", since = "1.0.0")]
434#[rustc_diagnostic_item = "Vec"]
435#[rustc_insignificant_dtor]
436#[doc(alias = "list")]
437#[doc(alias = "vector")]
438pub struct Vec<T, #[unstable(feature = "allocator_api", issue = "32838")] A: Allocator = Global> {
439    buf: RawVec<T, A>,
440    len: usize,
441}
442
443////////////////////////////////////////////////////////////////////////////////
444// Inherent methods
445////////////////////////////////////////////////////////////////////////////////
446
447impl<T> Vec<T> {
448    /// Constructs a new, empty `Vec<T>`.
449    ///
450    /// The vector will not allocate until elements are pushed onto it.
451    ///
452    /// # Examples
453    ///
454    /// ```
455    /// # #![allow(unused_mut)]
456    /// let mut vec: Vec<i32> = Vec::new();
457    /// ```
458    #[inline]
459    #[rustc_const_stable(feature = "const_vec_new", since = "1.39.0")]
460    #[rustc_diagnostic_item = "vec_new"]
461    #[stable(feature = "rust1", since = "1.0.0")]
462    #[must_use]
463    pub const fn new() -> Self {
464        Vec { buf: RawVec::new(), len: 0 }
465    }
466
467    /// Constructs a new, empty `Vec<T>` with at least the specified capacity.
468    ///
469    /// The vector will be able to hold at least `capacity` elements without
470    /// reallocating. This method is allowed to allocate for more elements than
471    /// `capacity`. If `capacity` is zero, the vector will not allocate.
472    ///
473    /// It is important to note that although the returned vector has the
474    /// minimum *capacity* specified, the vector will have a zero *length*. For
475    /// an explanation of the difference between length and capacity, see
476    /// *[Capacity and reallocation]*.
477    ///
478    /// If it is important to know the exact allocated capacity of a `Vec`,
479    /// always use the [`capacity`] method after construction.
480    ///
481    /// For `Vec<T>` where `T` is a zero-sized type, there will be no allocation
482    /// and the capacity will always be `usize::MAX`.
483    ///
484    /// [Capacity and reallocation]: #capacity-and-reallocation
485    /// [`capacity`]: Vec::capacity
486    ///
487    /// # Panics
488    ///
489    /// Panics if the new capacity exceeds `isize::MAX` _bytes_.
490    ///
491    /// # Examples
492    ///
493    /// ```
494    /// let mut vec = Vec::with_capacity(10);
495    ///
496    /// // The vector contains no items, even though it has capacity for more
497    /// assert_eq!(vec.len(), 0);
498    /// assert!(vec.capacity() >= 10);
499    ///
500    /// // These are all done without reallocating...
501    /// for i in 0..10 {
502    ///     vec.push(i);
503    /// }
504    /// assert_eq!(vec.len(), 10);
505    /// assert!(vec.capacity() >= 10);
506    ///
507    /// // ...but this may make the vector reallocate
508    /// vec.push(11);
509    /// assert_eq!(vec.len(), 11);
510    /// assert!(vec.capacity() >= 11);
511    ///
512    /// // A vector of a zero-sized type will always over-allocate, since no
513    /// // allocation is necessary
514    /// let vec_units = Vec::<()>::with_capacity(10);
515    /// assert_eq!(vec_units.capacity(), usize::MAX);
516    /// ```
517    #[cfg(not(no_global_oom_handling))]
518    #[inline]
519    #[stable(feature = "rust1", since = "1.0.0")]
520    #[must_use]
521    #[rustc_diagnostic_item = "vec_with_capacity"]
522    #[rustc_const_unstable(feature = "const_heap", issue = "79597")]
523    pub const fn with_capacity(capacity: usize) -> Self {
524        Self::with_capacity_in(capacity, Global)
525    }
526
527    /// Constructs a new, empty `Vec<T>` with at least the specified capacity.
528    ///
529    /// The vector will be able to hold at least `capacity` elements without
530    /// reallocating. This method is allowed to allocate for more elements than
531    /// `capacity`. If `capacity` is zero, the vector will not allocate.
532    ///
533    /// # Errors
534    ///
535    /// Returns an error if the capacity exceeds `isize::MAX` _bytes_,
536    /// or if the allocator reports allocation failure.
537    #[inline]
538    #[unstable(feature = "try_with_capacity", issue = "91913")]
539    pub fn try_with_capacity(capacity: usize) -> Result<Self, TryReserveError> {
540        Self::try_with_capacity_in(capacity, Global)
541    }
542
543    /// Creates a `Vec<T>` directly from a pointer, a length, and a capacity.
544    ///
545    /// # Safety
546    ///
547    /// This is highly unsafe, due to the number of invariants that aren't
548    /// checked:
549    ///
550    /// * If `T` is not a zero-sized type and the capacity is nonzero, `ptr` must have
551    ///   been allocated using the global allocator, such as via the [`alloc::alloc`]
552    ///   function. If `T` is a zero-sized type or the capacity is zero, `ptr` need
553    ///   only be non-null and aligned.
554    /// * `T` needs to have the same alignment as what `ptr` was allocated with,
555    ///   if the pointer is required to be allocated.
556    ///   (`T` having a less strict alignment is not sufficient, the alignment really
557    ///   needs to be equal to satisfy the [`dealloc`] requirement that memory must be
558    ///   allocated and deallocated with the same layout.)
559    /// * The size of `T` times the `capacity` (i.e. the allocated size in bytes), if
560    ///   nonzero, needs to be the same size as the pointer was allocated with.
561    ///   (Because similar to alignment, [`dealloc`] must be called with the same
562    ///   layout `size`.)
563    /// * `length` needs to be less than or equal to `capacity`.
564    /// * The first `length` values must be properly initialized values of type `T`.
565    /// * `capacity` needs to be the capacity that the pointer was allocated with,
566    ///   if the pointer is required to be allocated.
567    /// * The allocated size in bytes must be no larger than `isize::MAX`.
568    ///   See the safety documentation of [`pointer::offset`].
569    ///
570    /// These requirements are always upheld by any `ptr` that has been allocated
571    /// via `Vec<T>`. Other allocation sources are allowed if the invariants are
572    /// upheld.
573    ///
574    /// Violating these may cause problems like corrupting the allocator's
575    /// internal data structures. For example it is normally **not** safe
576    /// to build a `Vec<u8>` from a pointer to a C `char` array with length
577    /// `size_t`, doing so is only safe if the array was initially allocated by
578    /// a `Vec` or `String`.
579    /// It's also not safe to build one from a `Vec<u16>` and its length, because
580    /// the allocator cares about the alignment, and these two types have different
581    /// alignments. The buffer was allocated with alignment 2 (for `u16`), but after
582    /// turning it into a `Vec<u8>` it'll be deallocated with alignment 1. To avoid
583    /// these issues, it is often preferable to do casting/transmuting using
584    /// [`slice::from_raw_parts`] instead.
585    ///
586    /// The ownership of `ptr` is effectively transferred to the
587    /// `Vec<T>` which may then deallocate, reallocate or change the
588    /// contents of memory pointed to by the pointer at will. Ensure
589    /// that nothing else uses the pointer after calling this
590    /// function.
591    ///
592    /// [`String`]: crate::string::String
593    /// [`alloc::alloc`]: crate::alloc::alloc
594    /// [`dealloc`]: crate::alloc::GlobalAlloc::dealloc
595    ///
596    /// # Examples
597    ///
598    /// ```
599    /// use std::ptr;
600    ///
601    /// let v = vec![1, 2, 3];
602    ///
603    /// // Deconstruct the vector into parts.
604    /// let (p, len, cap) = v.into_raw_parts();
605    ///
606    /// unsafe {
607    ///     // Overwrite memory with 4, 5, 6
608    ///     for i in 0..len {
609    ///         ptr::write(p.add(i), 4 + i);
610    ///     }
611    ///
612    ///     // Put everything back together into a Vec
613    ///     let rebuilt = Vec::from_raw_parts(p, len, cap);
614    ///     assert_eq!(rebuilt, [4, 5, 6]);
615    /// }
616    /// ```
617    ///
618    /// Using memory that was allocated elsewhere:
619    ///
620    /// ```rust
621    /// use std::alloc::{alloc, Layout};
622    ///
623    /// fn main() {
624    ///     let layout = Layout::array::<u32>(16).expect("overflow cannot happen");
625    ///
626    ///     let vec = unsafe {
627    ///         let mem = alloc(layout).cast::<u32>();
628    ///         if mem.is_null() {
629    ///             return;
630    ///         }
631    ///
632    ///         mem.write(1_000_000);
633    ///
634    ///         Vec::from_raw_parts(mem, 1, 16)
635    ///     };
636    ///
637    ///     assert_eq!(vec, &[1_000_000]);
638    ///     assert_eq!(vec.capacity(), 16);
639    /// }
640    /// ```
641    #[inline]
642    #[stable(feature = "rust1", since = "1.0.0")]
643    #[rustc_const_unstable(feature = "const_heap", issue = "79597")]
644    pub const unsafe fn from_raw_parts(ptr: *mut T, length: usize, capacity: usize) -> Self {
645        unsafe { Self::from_raw_parts_in(ptr, length, capacity, Global) }
646    }
647
648    #[doc(alias = "from_non_null_parts")]
649    /// Creates a `Vec<T>` directly from a `NonNull` pointer, a length, and a capacity.
650    ///
651    /// # Safety
652    ///
653    /// This is highly unsafe, due to the number of invariants that aren't
654    /// checked:
655    ///
656    /// * `ptr` must have been allocated using the global allocator, such as via
657    ///   the [`alloc::alloc`] function.
658    /// * `T` needs to have the same alignment as what `ptr` was allocated with.
659    ///   (`T` having a less strict alignment is not sufficient, the alignment really
660    ///   needs to be equal to satisfy the [`dealloc`] requirement that memory must be
661    ///   allocated and deallocated with the same layout.)
662    /// * The size of `T` times the `capacity` (i.e. the allocated size in bytes) needs
663    ///   to be the same size as the pointer was allocated with. (Because similar to
664    ///   alignment, [`dealloc`] must be called with the same layout `size`.)
665    /// * `length` needs to be less than or equal to `capacity`.
666    /// * The first `length` values must be properly initialized values of type `T`.
667    /// * `capacity` needs to be the capacity that the pointer was allocated with.
668    /// * The allocated size in bytes must be no larger than `isize::MAX`.
669    ///   See the safety documentation of [`pointer::offset`].
670    ///
671    /// These requirements are always upheld by any `ptr` that has been allocated
672    /// via `Vec<T>`. Other allocation sources are allowed if the invariants are
673    /// upheld.
674    ///
675    /// Violating these may cause problems like corrupting the allocator's
676    /// internal data structures. For example it is normally **not** safe
677    /// to build a `Vec<u8>` from a pointer to a C `char` array with length
678    /// `size_t`, doing so is only safe if the array was initially allocated by
679    /// a `Vec` or `String`.
680    /// It's also not safe to build one from a `Vec<u16>` and its length, because
681    /// the allocator cares about the alignment, and these two types have different
682    /// alignments. The buffer was allocated with alignment 2 (for `u16`), but after
683    /// turning it into a `Vec<u8>` it'll be deallocated with alignment 1. To avoid
684    /// these issues, it is often preferable to do casting/transmuting using
685    /// [`NonNull::slice_from_raw_parts`] instead.
686    ///
687    /// The ownership of `ptr` is effectively transferred to the
688    /// `Vec<T>` which may then deallocate, reallocate or change the
689    /// contents of memory pointed to by the pointer at will. Ensure
690    /// that nothing else uses the pointer after calling this
691    /// function.
692    ///
693    /// [`String`]: crate::string::String
694    /// [`alloc::alloc`]: crate::alloc::alloc
695    /// [`dealloc`]: crate::alloc::GlobalAlloc::dealloc
696    ///
697    /// # Examples
698    ///
699    /// ```
700    /// #![feature(box_vec_non_null)]
701    ///
702    /// let v = vec![1, 2, 3];
703    ///
704    /// // Deconstruct the vector into parts.
705    /// let (p, len, cap) = v.into_parts();
706    ///
707    /// unsafe {
708    ///     // Overwrite memory with 4, 5, 6
709    ///     for i in 0..len {
710    ///         p.add(i).write(4 + i);
711    ///     }
712    ///
713    ///     // Put everything back together into a Vec
714    ///     let rebuilt = Vec::from_parts(p, len, cap);
715    ///     assert_eq!(rebuilt, [4, 5, 6]);
716    /// }
717    /// ```
718    ///
719    /// Using memory that was allocated elsewhere:
720    ///
721    /// ```rust
722    /// #![feature(box_vec_non_null)]
723    ///
724    /// use std::alloc::{alloc, Layout};
725    /// use std::ptr::NonNull;
726    ///
727    /// fn main() {
728    ///     let layout = Layout::array::<u32>(16).expect("overflow cannot happen");
729    ///
730    ///     let vec = unsafe {
731    ///         let Some(mem) = NonNull::new(alloc(layout).cast::<u32>()) else {
732    ///             return;
733    ///         };
734    ///
735    ///         mem.write(1_000_000);
736    ///
737    ///         Vec::from_parts(mem, 1, 16)
738    ///     };
739    ///
740    ///     assert_eq!(vec, &[1_000_000]);
741    ///     assert_eq!(vec.capacity(), 16);
742    /// }
743    /// ```
744    #[inline]
745    #[unstable(feature = "box_vec_non_null", issue = "130364")]
746    #[rustc_const_unstable(feature = "box_vec_non_null", issue = "130364")]
747    pub const unsafe fn from_parts(ptr: NonNull<T>, length: usize, capacity: usize) -> Self {
748        unsafe { Self::from_parts_in(ptr, length, capacity, Global) }
749    }
750
751    /// Creates a `Vec<T>` where each element is produced by calling `f` with
752    /// that element's index while walking forward through the `Vec<T>`.
753    ///
754    /// This is essentially the same as writing
755    ///
756    /// ```text
757    /// vec![f(0), f(1), f(2), …, f(length - 2), f(length - 1)]
758    /// ```
759    /// and is similar to `(0..i).map(f)`, just for `Vec<T>`s not iterators.
760    ///
761    /// If `length == 0`, this produces an empty `Vec<T>` without ever calling `f`.
762    ///
763    /// # Example
764    ///
765    /// ```rust
766    /// #![feature(vec_from_fn)]
767    ///
768    /// let vec = Vec::from_fn(5, |i| i);
769    ///
770    /// // indexes are:  0  1  2  3  4
771    /// assert_eq!(vec, [0, 1, 2, 3, 4]);
772    ///
773    /// let vec2 = Vec::from_fn(8, |i| i * 2);
774    ///
775    /// // indexes are:   0  1  2  3  4  5   6   7
776    /// assert_eq!(vec2, [0, 2, 4, 6, 8, 10, 12, 14]);
777    ///
778    /// let bool_vec = Vec::from_fn(5, |i| i % 2 == 0);
779    ///
780    /// // indexes are:       0     1      2     3      4
781    /// assert_eq!(bool_vec, [true, false, true, false, true]);
782    /// ```
783    ///
784    /// The `Vec<T>` is generated in ascending index order, starting from the front
785    /// and going towards the back, so you can use closures with mutable state:
786    /// ```
787    /// #![feature(vec_from_fn)]
788    ///
789    /// let mut state = 1;
790    /// let a = Vec::from_fn(6, |_| { let x = state; state *= 2; x });
791    ///
792    /// assert_eq!(a, [1, 2, 4, 8, 16, 32]);
793    /// ```
794    #[cfg(not(no_global_oom_handling))]
795    #[inline]
796    #[unstable(feature = "vec_from_fn", issue = "149698")]
797    pub fn from_fn<F>(length: usize, f: F) -> Self
798    where
799        F: FnMut(usize) -> T,
800    {
801        (0..length).map(f).collect()
802    }
803
804    /// Decomposes a `Vec<T>` into its raw components: `(pointer, length, capacity)`.
805    ///
806    /// Returns the raw pointer to the underlying data, the length of
807    /// the vector (in elements), and the allocated capacity of the
808    /// data (in elements). These are the same arguments in the same
809    /// order as the arguments to [`from_raw_parts`].
810    ///
811    /// After calling this function, the caller is responsible for the
812    /// memory previously managed by the `Vec`. Most often, one does
813    /// this by converting the raw pointer, length, and capacity back
814    /// into a `Vec` with the [`from_raw_parts`] function; more generally,
815    /// if `T` is non-zero-sized and the capacity is nonzero, one may use
816    /// any method that calls [`dealloc`] with a layout of
817    /// `Layout::array::<T>(capacity)`; if `T` is zero-sized or the
818    /// capacity is zero, nothing needs to be done.
819    ///
820    /// [`from_raw_parts`]: Vec::from_raw_parts
821    /// [`dealloc`]: crate::alloc::GlobalAlloc::dealloc
822    ///
823    /// # Examples
824    ///
825    /// ```
826    /// let v: Vec<i32> = vec![-1, 0, 1];
827    ///
828    /// let (ptr, len, cap) = v.into_raw_parts();
829    ///
830    /// let rebuilt = unsafe {
831    ///     // We can now make changes to the components, such as
832    ///     // transmuting the raw pointer to a compatible type.
833    ///     let ptr = ptr as *mut u32;
834    ///
835    ///     Vec::from_raw_parts(ptr, len, cap)
836    /// };
837    /// assert_eq!(rebuilt, [4294967295, 0, 1]);
838    /// ```
839    #[must_use = "losing the pointer will leak memory"]
840    #[stable(feature = "vec_into_raw_parts", since = "1.93.0")]
841    #[rustc_const_unstable(feature = "const_heap", issue = "79597")]
842    pub const fn into_raw_parts(self) -> (*mut T, usize, usize) {
843        let mut me = ManuallyDrop::new(self);
844        (me.as_mut_ptr(), me.len(), me.capacity())
845    }
846
847    #[doc(alias = "into_non_null_parts")]
848    /// Decomposes a `Vec<T>` into its raw components: `(NonNull pointer, length, capacity)`.
849    ///
850    /// Returns the `NonNull` pointer to the underlying data, the length of
851    /// the vector (in elements), and the allocated capacity of the
852    /// data (in elements). These are the same arguments in the same
853    /// order as the arguments to [`from_parts`].
854    ///
855    /// After calling this function, the caller is responsible for the
856    /// memory previously managed by the `Vec`. The only way to do
857    /// this is to convert the `NonNull` pointer, length, and capacity back
858    /// into a `Vec` with the [`from_parts`] function, allowing
859    /// the destructor to perform the cleanup.
860    ///
861    /// [`from_parts`]: Vec::from_parts
862    ///
863    /// # Examples
864    ///
865    /// ```
866    /// #![feature(box_vec_non_null)]
867    ///
868    /// let v: Vec<i32> = vec![-1, 0, 1];
869    ///
870    /// let (ptr, len, cap) = v.into_parts();
871    ///
872    /// let rebuilt = unsafe {
873    ///     // We can now make changes to the components, such as
874    ///     // transmuting the raw pointer to a compatible type.
875    ///     let ptr = ptr.cast::<u32>();
876    ///
877    ///     Vec::from_parts(ptr, len, cap)
878    /// };
879    /// assert_eq!(rebuilt, [4294967295, 0, 1]);
880    /// ```
881    #[must_use = "losing the pointer will leak memory"]
882    #[unstable(feature = "box_vec_non_null", issue = "130364")]
883    #[rustc_const_unstable(feature = "box_vec_non_null", issue = "130364")]
884    pub const fn into_parts(self) -> (NonNull<T>, usize, usize) {
885        let (ptr, len, capacity) = self.into_raw_parts();
886        // SAFETY: A `Vec` always has a non-null pointer.
887        (unsafe { NonNull::new_unchecked(ptr) }, len, capacity)
888    }
889
890    /// Interns the `Vec<T>`, making the underlying memory read-only. This method should be
891    /// called during compile time. (This is a no-op if called during runtime)
892    ///
893    /// This method must be called if the memory used by `Vec` needs to appear in the final
894    /// values of constants.
895    #[unstable(feature = "const_heap", issue = "79597")]
896    #[rustc_const_unstable(feature = "const_heap", issue = "79597")]
897    pub const fn const_make_global(mut self) -> &'static [T]
898    where
899        T: Freeze,
900    {
901        // `const_make_global` requires the pointer to point to the beginning of a heap allocation,
902        // which is not the case when `self.capacity()` is 0, or if `T::IS_ZST`,
903        // which is why we instead return a new slice in this case.
904        if self.capacity() == 0 || T::IS_ZST {
905            let me = ManuallyDrop::new(self);
906            unsafe { slice::from_raw_parts(NonNull::<T>::dangling().as_ptr(), me.len) }
907        } else {
908            unsafe { core::intrinsics::const_make_global(self.as_mut_ptr().cast()) };
909            let me = ManuallyDrop::new(self);
910            unsafe { slice::from_raw_parts(me.as_ptr(), me.len) }
911        }
912    }
913}
914
915#[cfg(not(no_global_oom_handling))]
916#[rustc_const_unstable(feature = "const_heap", issue = "79597")]
917#[rustfmt::skip] // FIXME(fee1-dead): temporary measure before rustfmt is bumped
918const impl<T, A: [const] Allocator + [const] Destruct> Vec<T, A> {
919    /// Constructs a new, empty `Vec<T, A>` with at least the specified capacity
920    /// with the provided allocator.
921    ///
922    /// The vector will be able to hold at least `capacity` elements without
923    /// reallocating. This method is allowed to allocate for more elements than
924    /// `capacity`. If `capacity` is zero, the vector will not allocate.
925    ///
926    /// It is important to note that although the returned vector has the
927    /// minimum *capacity* specified, the vector will have a zero *length*. For
928    /// an explanation of the difference between length and capacity, see
929    /// *[Capacity and reallocation]*.
930    ///
931    /// If it is important to know the exact allocated capacity of a `Vec`,
932    /// always use the [`capacity`] method after construction.
933    ///
934    /// For `Vec<T, A>` where `T` is a zero-sized type, there will be no allocation
935    /// and the capacity will always be `usize::MAX`.
936    ///
937    /// [Capacity and reallocation]: #capacity-and-reallocation
938    /// [`capacity`]: Vec::capacity
939    ///
940    /// # Panics
941    ///
942    /// Panics if the new capacity exceeds `isize::MAX` _bytes_.
943    ///
944    /// # Examples
945    ///
946    /// ```
947    /// #![feature(allocator_api)]
948    ///
949    /// use std::alloc::System;
950    ///
951    /// let mut vec = Vec::with_capacity_in(10, System);
952    ///
953    /// // The vector contains no items, even though it has capacity for more
954    /// assert_eq!(vec.len(), 0);
955    /// assert!(vec.capacity() >= 10);
956    ///
957    /// // These are all done without reallocating...
958    /// for i in 0..10 {
959    ///     vec.push(i);
960    /// }
961    /// assert_eq!(vec.len(), 10);
962    /// assert!(vec.capacity() >= 10);
963    ///
964    /// // ...but this may make the vector reallocate
965    /// vec.push(11);
966    /// assert_eq!(vec.len(), 11);
967    /// assert!(vec.capacity() >= 11);
968    ///
969    /// // A vector of a zero-sized type will always over-allocate, since no
970    /// // allocation is necessary
971    /// let vec_units = Vec::<(), System>::with_capacity_in(10, System);
972    /// assert_eq!(vec_units.capacity(), usize::MAX);
973    /// ```
974    #[inline]
975    #[unstable(feature = "allocator_api", issue = "32838")]
976    pub fn with_capacity_in(capacity: usize, alloc: A) -> Self {
977        Vec { buf: RawVec::with_capacity_in(capacity, alloc), len: 0 }
978    }
979
980    /// Appends an element to the back of a collection.
981    ///
982    /// # Panics
983    ///
984    /// Panics if the new capacity exceeds `isize::MAX` _bytes_.
985    ///
986    /// # Examples
987    ///
988    /// ```
989    /// let mut vec = vec![1, 2];
990    /// vec.push(3);
991    /// assert_eq!(vec, [1, 2, 3]);
992    /// ```
993    ///
994    /// # Time complexity
995    ///
996    /// Takes amortized *O*(1) time. If the vector's length would exceed its
997    /// capacity after the push, *O*(*capacity*) time is taken to copy the
998    /// vector's elements to a larger allocation. This expensive operation is
999    /// offset by the *capacity* *O*(1) insertions it allows.
1000    #[inline]
1001    #[stable(feature = "rust1", since = "1.0.0")]
1002    #[rustc_confusables("push_back", "put", "append")]
1003    pub fn push(&mut self, value: T) {
1004        let _ = self.push_mut(value);
1005    }
1006
1007    /// Appends an element to the back of a collection, returning a reference to it.
1008    ///
1009    /// # Panics
1010    ///
1011    /// Panics if the new capacity exceeds `isize::MAX` _bytes_.
1012    ///
1013    /// # Examples
1014    ///
1015    /// ```
1016    /// let mut vec = vec![1, 2];
1017    /// let last = vec.push_mut(3);
1018    /// assert_eq!(*last, 3);
1019    /// assert_eq!(vec, [1, 2, 3]);
1020    ///
1021    /// let last = vec.push_mut(3);
1022    /// *last += 1;
1023    /// assert_eq!(vec, [1, 2, 3, 4]);
1024    /// ```
1025    ///
1026    /// # Time complexity
1027    ///
1028    /// Takes amortized *O*(1) time. If the vector's length would exceed its
1029    /// capacity after the push, *O*(*capacity*) time is taken to copy the
1030    /// vector's elements to a larger allocation. This expensive operation is
1031    /// offset by the *capacity* *O*(1) insertions it allows.
1032    #[inline]
1033    #[stable(feature = "push_mut", since = "1.95.0")]
1034    #[must_use = "if you don't need a reference to the value, use `Vec::push` instead"]
1035    pub fn push_mut(&mut self, value: T) -> &mut T {
1036        // Inform codegen that the length does not change across grow_one().
1037        let len = self.len;
1038        // This will panic or abort if we would allocate > isize::MAX bytes
1039        // or if the length increment would overflow for zero-sized types.
1040        if len == self.buf.capacity() {
1041            self.buf.grow_one();
1042        }
1043        unsafe {
1044            let end = self.as_mut_ptr().add(len);
1045            ptr::write(end, value);
1046            self.len = len + 1;
1047            // SAFETY: We just wrote a value to the pointer that will live the lifetime of the reference.
1048            &mut *end
1049        }
1050    }
1051}
1052
1053impl<T, A: Allocator> Vec<T, A> {
1054    /// Constructs a new, empty `Vec<T, A>`.
1055    ///
1056    /// The vector will not allocate until elements are pushed onto it.
1057    ///
1058    /// # Examples
1059    ///
1060    /// ```
1061    /// #![feature(allocator_api)]
1062    ///
1063    /// use std::alloc::System;
1064    ///
1065    /// let vec: Vec<i32, System> = Vec::new_in(System);
1066    /// ```
1067    #[inline]
1068    #[unstable(feature = "allocator_api", issue = "32838")]
1069    pub const fn new_in(alloc: A) -> Self {
1070        Vec { buf: RawVec::new_in(alloc), len: 0 }
1071    }
1072
1073    /// Constructs a new, empty `Vec<T, A>` with at least the specified capacity
1074    /// with the provided allocator.
1075    ///
1076    /// The vector will be able to hold at least `capacity` elements without
1077    /// reallocating. This method is allowed to allocate for more elements than
1078    /// `capacity`. If `capacity` is zero, the vector will not allocate.
1079    ///
1080    /// # Errors
1081    ///
1082    /// Returns an error if the capacity exceeds `isize::MAX` _bytes_,
1083    /// or if the allocator reports allocation failure.
1084    #[inline]
1085    #[unstable(feature = "allocator_api", issue = "32838")]
1086    // #[unstable(feature = "try_with_capacity", issue = "91913")]
1087    pub fn try_with_capacity_in(capacity: usize, alloc: A) -> Result<Self, TryReserveError> {
1088        Ok(Vec { buf: RawVec::try_with_capacity_in(capacity, alloc)?, len: 0 })
1089    }
1090
1091    /// Creates a `Vec<T, A>` directly from a pointer, a length, a capacity,
1092    /// and an allocator.
1093    ///
1094    /// # Safety
1095    ///
1096    /// This is highly unsafe, due to the number of invariants that aren't
1097    /// checked:
1098    ///
1099    /// * `ptr` must be [*currently allocated*] via the given allocator `alloc`.
1100    /// * `T` needs to have the same alignment as what `ptr` was allocated with.
1101    ///   (`T` having a less strict alignment is not sufficient, the alignment really
1102    ///   needs to be equal to satisfy the [`dealloc`] requirement that memory must be
1103    ///   allocated and deallocated with the same layout.)
1104    /// * The size of `T` times the `capacity` (i.e. the allocated size in bytes) needs
1105    ///   to be the same size as the pointer was allocated with. (Because similar to
1106    ///   alignment, [`dealloc`] must be called with the same layout `size`.)
1107    /// * `length` needs to be less than or equal to `capacity`.
1108    /// * The first `length` values must be properly initialized values of type `T`.
1109    /// * `capacity` needs to [*fit*] the layout size that the pointer was allocated with.
1110    /// * The allocated size in bytes must be no larger than `isize::MAX`.
1111    ///   See the safety documentation of [`pointer::offset`].
1112    ///
1113    /// These requirements are always upheld by any `ptr` that has been allocated
1114    /// via `Vec<T, A>`. Other allocation sources are allowed if the invariants are
1115    /// upheld.
1116    ///
1117    /// Violating these may cause problems like corrupting the allocator's
1118    /// internal data structures. For example it is **not** safe
1119    /// to build a `Vec<u8>` from a pointer to a C `char` array with length `size_t`.
1120    /// It's also not safe to build one from a `Vec<u16>` and its length, because
1121    /// the allocator cares about the alignment, and these two types have different
1122    /// alignments. The buffer was allocated with alignment 2 (for `u16`), but after
1123    /// turning it into a `Vec<u8>` it'll be deallocated with alignment 1.
1124    ///
1125    /// The ownership of `ptr` is effectively transferred to the
1126    /// `Vec<T>` which may then deallocate, reallocate or change the
1127    /// contents of memory pointed to by the pointer at will. Ensure
1128    /// that nothing else uses the pointer after calling this
1129    /// function.
1130    ///
1131    /// [`String`]: crate::string::String
1132    /// [`dealloc`]: crate::alloc::GlobalAlloc::dealloc
1133    /// [*currently allocated*]: crate::alloc::Allocator#currently-allocated-memory
1134    /// [*fit*]: crate::alloc::Allocator#memory-fitting
1135    ///
1136    /// # Examples
1137    ///
1138    /// ```
1139    /// #![feature(allocator_api)]
1140    ///
1141    /// use std::alloc::System;
1142    ///
1143    /// use std::ptr;
1144    ///
1145    /// let mut v = Vec::with_capacity_in(3, System);
1146    /// v.push(1);
1147    /// v.push(2);
1148    /// v.push(3);
1149    ///
1150    /// // Deconstruct the vector into parts.
1151    /// let (p, len, cap, alloc) = v.into_raw_parts_with_alloc();
1152    ///
1153    /// unsafe {
1154    ///     // Overwrite memory with 4, 5, 6
1155    ///     for i in 0..len {
1156    ///         ptr::write(p.add(i), 4 + i);
1157    ///     }
1158    ///
1159    ///     // Put everything back together into a Vec
1160    ///     let rebuilt = Vec::from_raw_parts_in(p, len, cap, alloc.clone());
1161    ///     assert_eq!(rebuilt, [4, 5, 6]);
1162    /// }
1163    /// ```
1164    ///
1165    /// Using memory that was allocated elsewhere:
1166    ///
1167    /// ```rust
1168    /// #![feature(allocator_api)]
1169    ///
1170    /// use std::alloc::{AllocError, Allocator, Global, Layout};
1171    ///
1172    /// fn main() {
1173    ///     let layout = Layout::array::<u32>(16).expect("overflow cannot happen");
1174    ///
1175    ///     let vec = unsafe {
1176    ///         let mem = match Global.allocate(layout) {
1177    ///             Ok(mem) => mem.cast::<u32>().as_ptr(),
1178    ///             Err(AllocError) => return,
1179    ///         };
1180    ///
1181    ///         mem.write(1_000_000);
1182    ///
1183    ///         Vec::from_raw_parts_in(mem, 1, 16, Global)
1184    ///     };
1185    ///
1186    ///     assert_eq!(vec, &[1_000_000]);
1187    ///     assert_eq!(vec.capacity(), 16);
1188    /// }
1189    /// ```
1190    #[inline]
1191    #[unstable(feature = "allocator_api", issue = "32838")]
1192    #[rustc_const_unstable(feature = "allocator_api", issue = "32838")]
1193    pub const unsafe fn from_raw_parts_in(
1194        ptr: *mut T,
1195        length: usize,
1196        capacity: usize,
1197        alloc: A,
1198    ) -> Self {
1199        ub_checks::assert_unsafe_precondition!(
1200            check_library_ub,
1201            "Vec::from_raw_parts_in requires that length <= capacity",
1202            (length: usize = length, capacity: usize = capacity) => length <= capacity
1203        );
1204        unsafe { Vec { buf: RawVec::from_raw_parts_in(ptr, capacity, alloc), len: length } }
1205    }
1206
1207    #[doc(alias = "from_non_null_parts_in")]
1208    /// Creates a `Vec<T, A>` directly from a `NonNull` pointer, a length, a capacity,
1209    /// and an allocator.
1210    ///
1211    /// # Safety
1212    ///
1213    /// This is highly unsafe, due to the number of invariants that aren't
1214    /// checked:
1215    ///
1216    /// * `ptr` must be [*currently allocated*] via the given allocator `alloc`.
1217    /// * `T` needs to have the same alignment as what `ptr` was allocated with.
1218    ///   (`T` having a less strict alignment is not sufficient, the alignment really
1219    ///   needs to be equal to satisfy the [`dealloc`] requirement that memory must be
1220    ///   allocated and deallocated with the same layout.)
1221    /// * The size of `T` times the `capacity` (i.e. the allocated size in bytes) needs
1222    ///   to be the same size as the pointer was allocated with. (Because similar to
1223    ///   alignment, [`dealloc`] must be called with the same layout `size`.)
1224    /// * `length` needs to be less than or equal to `capacity`.
1225    /// * The first `length` values must be properly initialized values of type `T`.
1226    /// * `capacity` needs to [*fit*] the layout size that the pointer was allocated with.
1227    /// * The allocated size in bytes must be no larger than `isize::MAX`.
1228    ///   See the safety documentation of [`pointer::offset`].
1229    ///
1230    /// These requirements are always upheld by any `ptr` that has been allocated
1231    /// via `Vec<T, A>`. Other allocation sources are allowed if the invariants are
1232    /// upheld.
1233    ///
1234    /// Violating these may cause problems like corrupting the allocator's
1235    /// internal data structures. For example it is **not** safe
1236    /// to build a `Vec<u8>` from a pointer to a C `char` array with length `size_t`.
1237    /// It's also not safe to build one from a `Vec<u16>` and its length, because
1238    /// the allocator cares about the alignment, and these two types have different
1239    /// alignments. The buffer was allocated with alignment 2 (for `u16`), but after
1240    /// turning it into a `Vec<u8>` it'll be deallocated with alignment 1.
1241    ///
1242    /// The ownership of `ptr` is effectively transferred to the
1243    /// `Vec<T>` which may then deallocate, reallocate or change the
1244    /// contents of memory pointed to by the pointer at will. Ensure
1245    /// that nothing else uses the pointer after calling this
1246    /// function.
1247    ///
1248    /// [`String`]: crate::string::String
1249    /// [`dealloc`]: crate::alloc::GlobalAlloc::dealloc
1250    /// [*currently allocated*]: crate::alloc::Allocator#currently-allocated-memory
1251    /// [*fit*]: crate::alloc::Allocator#memory-fitting
1252    ///
1253    /// # Examples
1254    ///
1255    /// ```
1256    /// #![feature(allocator_api)]
1257    ///
1258    /// use std::alloc::System;
1259    ///
1260    /// let mut v = Vec::with_capacity_in(3, System);
1261    /// v.push(1);
1262    /// v.push(2);
1263    /// v.push(3);
1264    ///
1265    /// // Deconstruct the vector into parts.
1266    /// let (p, len, cap, alloc) = v.into_parts_with_alloc();
1267    ///
1268    /// unsafe {
1269    ///     // Overwrite memory with 4, 5, 6
1270    ///     for i in 0..len {
1271    ///         p.add(i).write(4 + i);
1272    ///     }
1273    ///
1274    ///     // Put everything back together into a Vec
1275    ///     let rebuilt = Vec::from_parts_in(p, len, cap, alloc.clone());
1276    ///     assert_eq!(rebuilt, [4, 5, 6]);
1277    /// }
1278    /// ```
1279    ///
1280    /// Using memory that was allocated elsewhere:
1281    ///
1282    /// ```rust
1283    /// #![feature(allocator_api)]
1284    ///
1285    /// use std::alloc::{AllocError, Allocator, Global, Layout};
1286    ///
1287    /// fn main() {
1288    ///     let layout = Layout::array::<u32>(16).expect("overflow cannot happen");
1289    ///
1290    ///     let vec = unsafe {
1291    ///         let mem = match Global.allocate(layout) {
1292    ///             Ok(mem) => mem.cast::<u32>(),
1293    ///             Err(AllocError) => return,
1294    ///         };
1295    ///
1296    ///         mem.write(1_000_000);
1297    ///
1298    ///         Vec::from_parts_in(mem, 1, 16, Global)
1299    ///     };
1300    ///
1301    ///     assert_eq!(vec, &[1_000_000]);
1302    ///     assert_eq!(vec.capacity(), 16);
1303    /// }
1304    /// ```
1305    #[inline]
1306    #[unstable(feature = "allocator_api", issue = "32838")]
1307    #[rustc_const_unstable(feature = "allocator_api", issue = "32838")]
1308    // #[unstable(feature = "box_vec_non_null", issue = "130364")]
1309    pub const unsafe fn from_parts_in(
1310        ptr: NonNull<T>,
1311        length: usize,
1312        capacity: usize,
1313        alloc: A,
1314    ) -> Self {
1315        ub_checks::assert_unsafe_precondition!(
1316            check_library_ub,
1317            "Vec::from_parts_in requires that length <= capacity",
1318            (length: usize = length, capacity: usize = capacity) => length <= capacity
1319        );
1320        unsafe { Vec { buf: RawVec::from_nonnull_in(ptr, capacity, alloc), len: length } }
1321    }
1322
1323    /// Decomposes a `Vec<T>` into its raw components: `(pointer, length, capacity, allocator)`.
1324    ///
1325    /// Returns the raw pointer to the underlying data, the length of the vector (in elements),
1326    /// the allocated capacity of the data (in elements), and the allocator. These are the same
1327    /// arguments in the same order as the arguments to [`from_raw_parts_in`].
1328    ///
1329    /// After calling this function, the caller is responsible for the
1330    /// memory previously managed by the `Vec`. The only way to do
1331    /// this is to convert the raw pointer, length, and capacity back
1332    /// into a `Vec` with the [`from_raw_parts_in`] function, allowing
1333    /// the destructor to perform the cleanup.
1334    ///
1335    /// [`from_raw_parts_in`]: Vec::from_raw_parts_in
1336    ///
1337    /// # Examples
1338    ///
1339    /// ```
1340    /// #![feature(allocator_api)]
1341    ///
1342    /// use std::alloc::System;
1343    ///
1344    /// let mut v: Vec<i32, System> = Vec::new_in(System);
1345    /// v.push(-1);
1346    /// v.push(0);
1347    /// v.push(1);
1348    ///
1349    /// let (ptr, len, cap, alloc) = v.into_raw_parts_with_alloc();
1350    ///
1351    /// let rebuilt = unsafe {
1352    ///     // We can now make changes to the components, such as
1353    ///     // transmuting the raw pointer to a compatible type.
1354    ///     let ptr = ptr as *mut u32;
1355    ///
1356    ///     Vec::from_raw_parts_in(ptr, len, cap, alloc)
1357    /// };
1358    /// assert_eq!(rebuilt, [4294967295, 0, 1]);
1359    /// ```
1360    #[must_use = "losing the pointer will leak memory"]
1361    #[unstable(feature = "allocator_api", issue = "32838")]
1362    #[rustc_const_unstable(feature = "allocator_api", issue = "32838")]
1363    pub const fn into_raw_parts_with_alloc(self) -> (*mut T, usize, usize, A) {
1364        let mut me = ManuallyDrop::new(self);
1365        let len = me.len();
1366        let capacity = me.capacity();
1367        let ptr = me.as_mut_ptr();
1368        let alloc = unsafe { ptr::read(me.allocator()) };
1369        (ptr, len, capacity, alloc)
1370    }
1371
1372    #[doc(alias = "into_non_null_parts_with_alloc")]
1373    /// Decomposes a `Vec<T>` into its raw components: `(NonNull pointer, length, capacity, allocator)`.
1374    ///
1375    /// Returns the `NonNull` pointer to the underlying data, the length of the vector (in elements),
1376    /// the allocated capacity of the data (in elements), and the allocator. These are the same
1377    /// arguments in the same order as the arguments to [`from_parts_in`].
1378    ///
1379    /// After calling this function, the caller is responsible for the
1380    /// memory previously managed by the `Vec`. The only way to do
1381    /// this is to convert the `NonNull` pointer, length, and capacity back
1382    /// into a `Vec` with the [`from_parts_in`] function, allowing
1383    /// the destructor to perform the cleanup.
1384    ///
1385    /// [`from_parts_in`]: Vec::from_parts_in
1386    ///
1387    /// # Examples
1388    ///
1389    /// ```
1390    /// #![feature(allocator_api)]
1391    ///
1392    /// use std::alloc::System;
1393    ///
1394    /// let mut v: Vec<i32, System> = Vec::new_in(System);
1395    /// v.push(-1);
1396    /// v.push(0);
1397    /// v.push(1);
1398    ///
1399    /// let (ptr, len, cap, alloc) = v.into_parts_with_alloc();
1400    ///
1401    /// let rebuilt = unsafe {
1402    ///     // We can now make changes to the components, such as
1403    ///     // transmuting the raw pointer to a compatible type.
1404    ///     let ptr = ptr.cast::<u32>();
1405    ///
1406    ///     Vec::from_parts_in(ptr, len, cap, alloc)
1407    /// };
1408    /// assert_eq!(rebuilt, [4294967295, 0, 1]);
1409    /// ```
1410    #[must_use = "losing the pointer will leak memory"]
1411    #[unstable(feature = "allocator_api", issue = "32838")]
1412    #[rustc_const_unstable(feature = "allocator_api", issue = "32838")]
1413    // #[unstable(feature = "box_vec_non_null", issue = "130364")]
1414    pub const fn into_parts_with_alloc(self) -> (NonNull<T>, usize, usize, A) {
1415        let (ptr, len, capacity, alloc) = self.into_raw_parts_with_alloc();
1416        // SAFETY: A `Vec` always has a non-null pointer.
1417        (unsafe { NonNull::new_unchecked(ptr) }, len, capacity, alloc)
1418    }
1419
1420    /// Returns the total number of elements the vector can hold without
1421    /// reallocating.
1422    ///
1423    /// # Examples
1424    ///
1425    /// ```
1426    /// let mut vec: Vec<i32> = Vec::with_capacity(10);
1427    /// vec.push(42);
1428    /// assert!(vec.capacity() >= 10);
1429    /// ```
1430    ///
1431    /// A vector with zero-sized elements will always have a capacity of usize::MAX:
1432    ///
1433    /// ```
1434    /// #[derive(Clone)]
1435    /// struct ZeroSized;
1436    ///
1437    /// fn main() {
1438    ///     assert_eq!(std::mem::size_of::<ZeroSized>(), 0);
1439    ///     let v = vec![ZeroSized; 0];
1440    ///     assert_eq!(v.capacity(), usize::MAX);
1441    /// }
1442    /// ```
1443    #[inline]
1444    #[stable(feature = "rust1", since = "1.0.0")]
1445    #[rustc_const_stable(feature = "const_vec_string_slice", since = "1.87.0")]
1446    pub const fn capacity(&self) -> usize {
1447        self.buf.capacity()
1448    }
1449
1450    /// Reserves capacity for at least `additional` more elements to be inserted
1451    /// in the given `Vec<T>`. The collection may reserve more space to
1452    /// speculatively avoid frequent reallocations. After calling `reserve`,
1453    /// capacity will be greater than or equal to `self.len() + additional`.
1454    /// Does nothing if capacity is already sufficient.
1455    ///
1456    /// # Panics
1457    ///
1458    /// Panics if the new capacity exceeds `isize::MAX` _bytes_.
1459    ///
1460    /// # Examples
1461    ///
1462    /// ```
1463    /// let mut vec = vec![1];
1464    /// vec.reserve(10);
1465    /// assert!(vec.capacity() >= 11);
1466    /// ```
1467    #[cfg(not(no_global_oom_handling))]
1468    #[stable(feature = "rust1", since = "1.0.0")]
1469    #[rustc_diagnostic_item = "vec_reserve"]
1470    pub fn reserve(&mut self, additional: usize) {
1471        self.buf.reserve(self.len, additional);
1472    }
1473
1474    /// Reserves the minimum capacity for at least `additional` more elements to
1475    /// be inserted in the given `Vec<T>`. Unlike [`reserve`], this will not
1476    /// deliberately over-allocate to speculatively avoid frequent allocations.
1477    /// After calling `reserve_exact`, capacity will be greater than or equal to
1478    /// `self.len() + additional`. Does nothing if the capacity is already
1479    /// sufficient.
1480    ///
1481    /// Note that the allocator may give the collection more space than it
1482    /// requests. Therefore, capacity can not be relied upon to be precisely
1483    /// minimal. Prefer [`reserve`] if future insertions are expected.
1484    ///
1485    /// [`reserve`]: Vec::reserve
1486    ///
1487    /// # Panics
1488    ///
1489    /// Panics if the new capacity exceeds `isize::MAX` _bytes_.
1490    ///
1491    /// # Examples
1492    ///
1493    /// ```
1494    /// let mut vec = vec![1];
1495    /// vec.reserve_exact(10);
1496    /// assert!(vec.capacity() >= 11);
1497    /// ```
1498    #[cfg(not(no_global_oom_handling))]
1499    #[stable(feature = "rust1", since = "1.0.0")]
1500    pub fn reserve_exact(&mut self, additional: usize) {
1501        self.buf.reserve_exact(self.len, additional);
1502    }
1503
1504    /// Tries to reserve capacity for at least `additional` more elements to be inserted
1505    /// in the given `Vec<T>`. The collection may reserve more space to speculatively avoid
1506    /// frequent reallocations. After calling `try_reserve`, capacity will be
1507    /// greater than or equal to `self.len() + additional` if it returns
1508    /// `Ok(())`. Does nothing if capacity is already sufficient. This method
1509    /// preserves the contents even if an error occurs.
1510    ///
1511    /// # Errors
1512    ///
1513    /// If the capacity overflows, or the allocator reports a failure, then an error
1514    /// is returned.
1515    ///
1516    /// # Examples
1517    ///
1518    /// ```
1519    /// use std::collections::TryReserveError;
1520    ///
1521    /// fn process_data(data: &[u32]) -> Result<Vec<u32>, TryReserveError> {
1522    ///     let mut output = Vec::new();
1523    ///
1524    ///     // Pre-reserve the memory, exiting if we can't
1525    ///     output.try_reserve(data.len())?;
1526    ///
1527    ///     // Now we know this can't OOM in the middle of our complex work
1528    ///     output.extend(data.iter().map(|&val| {
1529    ///         val * 2 + 5 // very complicated
1530    ///     }));
1531    ///
1532    ///     Ok(output)
1533    /// }
1534    /// # process_data(&[1, 2, 3]).expect("why is the test harness OOMing on 12 bytes?");
1535    /// ```
1536    #[stable(feature = "try_reserve", since = "1.57.0")]
1537    pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError> {
1538        self.buf.try_reserve(self.len, additional)
1539    }
1540
1541    /// Tries to reserve the minimum capacity for at least `additional`
1542    /// elements to be inserted in the given `Vec<T>`. Unlike [`try_reserve`],
1543    /// this will not deliberately over-allocate to speculatively avoid frequent
1544    /// allocations. After calling `try_reserve_exact`, capacity will be greater
1545    /// than or equal to `self.len() + additional` if it returns `Ok(())`.
1546    /// Does nothing if the capacity is already sufficient.
1547    ///
1548    /// Note that the allocator may give the collection more space than it
1549    /// requests. Therefore, capacity can not be relied upon to be precisely
1550    /// minimal. Prefer [`try_reserve`] if future insertions are expected.
1551    ///
1552    /// [`try_reserve`]: Vec::try_reserve
1553    ///
1554    /// # Errors
1555    ///
1556    /// If the capacity overflows, or the allocator reports a failure, then an error
1557    /// is returned.
1558    ///
1559    /// # Examples
1560    ///
1561    /// ```
1562    /// use std::collections::TryReserveError;
1563    ///
1564    /// fn process_data(data: &[u32]) -> Result<Vec<u32>, TryReserveError> {
1565    ///     let mut output = Vec::new();
1566    ///
1567    ///     // Pre-reserve the memory, exiting if we can't
1568    ///     output.try_reserve_exact(data.len())?;
1569    ///
1570    ///     // Now we know this can't OOM in the middle of our complex work
1571    ///     output.extend(data.iter().map(|&val| {
1572    ///         val * 2 + 5 // very complicated
1573    ///     }));
1574    ///
1575    ///     Ok(output)
1576    /// }
1577    /// # process_data(&[1, 2, 3]).expect("why is the test harness OOMing on 12 bytes?");
1578    /// ```
1579    #[stable(feature = "try_reserve", since = "1.57.0")]
1580    pub fn try_reserve_exact(&mut self, additional: usize) -> Result<(), TryReserveError> {
1581        self.buf.try_reserve_exact(self.len, additional)
1582    }
1583
1584    /// Shrinks the capacity of the vector as much as possible.
1585    ///
1586    /// The behavior of this method depends on the allocator, which may either shrink the vector
1587    /// in-place or reallocate. The resulting vector might still have some excess capacity, just as
1588    /// is the case for [`with_capacity`]. See [`Allocator::shrink`] for more details.
1589    ///
1590    /// [`with_capacity`]: Vec::with_capacity
1591    ///
1592    /// # Examples
1593    ///
1594    /// ```
1595    /// let mut vec = Vec::with_capacity(10);
1596    /// vec.extend([1, 2, 3]);
1597    /// assert!(vec.capacity() >= 10);
1598    /// vec.shrink_to_fit();
1599    /// assert!(vec.capacity() >= 3);
1600    /// ```
1601    #[cfg(not(no_global_oom_handling))]
1602    #[stable(feature = "rust1", since = "1.0.0")]
1603    #[inline]
1604    pub fn shrink_to_fit(&mut self) {
1605        // The capacity is never less than the length, and there's nothing to do when
1606        // they are equal, so we can avoid the panic case in `RawVec::shrink_to_fit`
1607        // by only calling it with a greater capacity.
1608        if self.capacity() > self.len {
1609            self.buf.shrink_to_fit(self.len);
1610        }
1611    }
1612
1613    /// Shrinks the capacity of the vector with a lower bound.
1614    ///
1615    /// The capacity will remain at least as large as both the length
1616    /// and the supplied value.
1617    ///
1618    /// If the current capacity is less than the lower limit, this is a no-op.
1619    ///
1620    /// # Examples
1621    ///
1622    /// ```
1623    /// let mut vec = Vec::with_capacity(10);
1624    /// vec.extend([1, 2, 3]);
1625    /// assert!(vec.capacity() >= 10);
1626    /// vec.shrink_to(4);
1627    /// assert!(vec.capacity() >= 4);
1628    /// vec.shrink_to(0);
1629    /// assert!(vec.capacity() >= 3);
1630    /// ```
1631    #[cfg(not(no_global_oom_handling))]
1632    #[stable(feature = "shrink_to", since = "1.56.0")]
1633    pub fn shrink_to(&mut self, min_capacity: usize) {
1634        if self.capacity() > min_capacity {
1635            self.buf.shrink_to_fit(cmp::max(self.len, min_capacity));
1636        }
1637    }
1638
1639    /// Tries to shrink the capacity of the vector as much as possible
1640    ///
1641    /// The behavior of this method depends on the allocator, which may either shrink the vector
1642    /// in-place or reallocate. The resulting vector might still have some excess capacity, just as
1643    /// is the case for [`with_capacity`]. See [`Allocator::shrink`] for more details.
1644    ///
1645    /// [`with_capacity`]: Vec::with_capacity
1646    ///
1647    /// # Errors
1648    ///
1649    /// This function returns an error if the allocator fails to shrink the allocation,
1650    /// the vector thereafter is still safe to use, the capacity remains unchanged
1651    /// however. See [`Allocator::shrink`].
1652    ///
1653    /// # Examples
1654    ///
1655    /// ```
1656    /// #![feature(vec_fallible_shrink)]
1657    ///
1658    /// let mut vec = Vec::with_capacity(10);
1659    /// vec.extend([1, 2, 3]);
1660    /// assert!(vec.capacity() >= 10);
1661    /// vec.try_shrink_to_fit().expect("why is the test harness failing to shrink to 12 bytes");
1662    /// assert!(vec.capacity() >= 3);
1663    /// ```
1664    #[unstable(feature = "vec_fallible_shrink", issue = "152350")]
1665    #[inline]
1666    pub fn try_shrink_to_fit(&mut self) -> Result<(), TryReserveError> {
1667        if self.capacity() > self.len { self.buf.try_shrink_to_fit(self.len) } else { Ok(()) }
1668    }
1669
1670    /// Shrinks the capacity of the vector with a lower bound.
1671    ///
1672    /// The capacity will remain at least as large as both the length
1673    /// and the supplied value.
1674    ///
1675    /// If the current capacity is less than the lower limit, this is a no-op.
1676    ///
1677    /// # Errors
1678    ///
1679    /// This function returns an error if the allocator fails to shrink the allocation,
1680    /// the vector thereafter is still safe to use, the capacity remains unchanged
1681    /// however. See [`Allocator::shrink`].
1682    ///
1683    /// # Examples
1684    ///
1685    /// ```
1686    /// #![feature(vec_fallible_shrink)]
1687    ///
1688    /// let mut vec = Vec::with_capacity(10);
1689    /// vec.extend([1, 2, 3]);
1690    /// assert!(vec.capacity() >= 10);
1691    /// vec.try_shrink_to(4).expect("why is the test harness failing to shrink to 12 bytes");
1692    /// assert!(vec.capacity() >= 4);
1693    /// vec.try_shrink_to(0).expect("this is a no-op and thus the allocator isn't involved.");
1694    /// assert!(vec.capacity() >= 3);
1695    /// ```
1696    #[unstable(feature = "vec_fallible_shrink", issue = "152350")]
1697    #[inline]
1698    pub fn try_shrink_to(&mut self, min_capacity: usize) -> Result<(), TryReserveError> {
1699        if self.capacity() > min_capacity {
1700            self.buf.try_shrink_to_fit(cmp::max(self.len, min_capacity))
1701        } else {
1702            Ok(())
1703        }
1704    }
1705
1706    /// Converts the vector into [`Box<[T]>`][owned slice].
1707    ///
1708    /// Before doing the conversion, this method discards excess capacity like [`shrink_to_fit`].
1709    ///
1710    /// [owned slice]: Box
1711    /// [`shrink_to_fit`]: Vec::shrink_to_fit
1712    ///
1713    /// # Examples
1714    ///
1715    /// ```
1716    /// let v = vec![1, 2, 3];
1717    ///
1718    /// let slice = v.into_boxed_slice();
1719    /// ```
1720    ///
1721    /// Any excess capacity is removed:
1722    ///
1723    /// ```
1724    /// let mut vec = Vec::with_capacity(10);
1725    /// vec.extend([1, 2, 3]);
1726    ///
1727    /// assert!(vec.capacity() >= 10);
1728    /// let slice = vec.into_boxed_slice();
1729    /// assert_eq!(slice.into_vec().capacity(), 3);
1730    /// ```
1731    #[cfg(not(no_global_oom_handling))]
1732    #[stable(feature = "rust1", since = "1.0.0")]
1733    pub fn into_boxed_slice(mut self) -> Box<[T], A> {
1734        unsafe {
1735            self.shrink_to_fit();
1736            let me = ManuallyDrop::new(self);
1737            let buf = ptr::read(&me.buf);
1738            let len = me.len();
1739            buf.into_box(len).assume_init()
1740        }
1741    }
1742
1743    /// Shortens the vector, keeping the first `len` elements and dropping
1744    /// the rest.
1745    ///
1746    /// If `len` is greater or equal to the vector's current length, this has
1747    /// no effect.
1748    ///
1749    /// The [`drain`] method can emulate `truncate`, but causes the excess
1750    /// elements to be returned instead of dropped.
1751    ///
1752    /// Note that this method has no effect on the allocated capacity
1753    /// of the vector.
1754    ///
1755    /// # Examples
1756    ///
1757    /// Truncating a five element vector to two elements:
1758    ///
1759    /// ```
1760    /// let mut vec = vec![1, 2, 3, 4, 5];
1761    /// vec.truncate(2);
1762    /// assert_eq!(vec, [1, 2]);
1763    /// ```
1764    ///
1765    /// No truncation occurs when `len` is greater than the vector's current
1766    /// length:
1767    ///
1768    /// ```
1769    /// let mut vec = vec![1, 2, 3];
1770    /// vec.truncate(8);
1771    /// assert_eq!(vec, [1, 2, 3]);
1772    /// ```
1773    ///
1774    /// Truncating when `len == 0` is equivalent to calling the [`clear`]
1775    /// method.
1776    ///
1777    /// ```
1778    /// let mut vec = vec![1, 2, 3];
1779    /// vec.truncate(0);
1780    /// assert_eq!(vec, []);
1781    /// ```
1782    ///
1783    /// [`clear`]: Vec::clear
1784    /// [`drain`]: Vec::drain
1785    #[stable(feature = "rust1", since = "1.0.0")]
1786    pub fn truncate(&mut self, len: usize) {
1787        // This is safe because:
1788        //
1789        // * the slice passed to `drop_in_place` is valid; the `len > self.len`
1790        //   case avoids creating an invalid slice, and
1791        // * the `len` of the vector is shrunk before calling `drop_in_place`,
1792        //   such that no value will be dropped twice in case `drop_in_place`
1793        //   were to panic once (if it panics twice, the program aborts).
1794        unsafe {
1795            // Note: It's intentional that this is `>` and not `>=`.
1796            //       Changing it to `>=` has negative performance
1797            //       implications in some cases. See #78884 for more.
1798            if len > self.len {
1799                return;
1800            }
1801            let remaining_len = self.len - len;
1802            let s = ptr::slice_from_raw_parts_mut(self.as_mut_ptr().add(len), remaining_len);
1803            self.len = len;
1804            ptr::drop_in_place(s);
1805        }
1806    }
1807
1808    /// Extracts a slice containing the entire vector.
1809    ///
1810    /// Equivalent to `&s[..]`.
1811    ///
1812    /// # Examples
1813    ///
1814    /// ```
1815    /// use std::io::{self, Write};
1816    /// let buffer = vec![1, 2, 3, 5, 8];
1817    /// io::sink().write(buffer.as_slice()).unwrap();
1818    /// ```
1819    #[inline]
1820    #[stable(feature = "vec_as_slice", since = "1.7.0")]
1821    #[rustc_diagnostic_item = "vec_as_slice"]
1822    #[rustc_const_stable(feature = "const_vec_string_slice", since = "1.87.0")]
1823    pub const fn as_slice(&self) -> &[T] {
1824        // SAFETY: `slice::from_raw_parts` requires pointee is a contiguous, aligned buffer of size
1825        // `len` containing properly-initialized `T`s. Data must not be mutated for the returned
1826        // lifetime. Further, `len * size_of::<T>` <= `isize::MAX`, and allocation does not
1827        // "wrap" through overflowing memory addresses.
1828        //
1829        // * Vec API guarantees that self.buf:
1830        //      * contains only properly-initialized items within 0..len
1831        //      * is aligned, contiguous, and valid for `len` reads
1832        //      * obeys size and address-wrapping constraints
1833        //
1834        // * We only construct `&mut` references to `self.buf` through `&mut self` methods; borrow-
1835        //   check ensures that it is not possible to mutably alias `self.buf` within the
1836        //   returned lifetime.
1837        unsafe {
1838            // normally this would use `slice::from_raw_parts`, but it's
1839            // instantiated often enough that avoiding the UB check is worth it
1840            &*core::intrinsics::aggregate_raw_ptr::<*const [T], _, _>(self.as_ptr(), self.len)
1841        }
1842    }
1843
1844    /// Extracts a mutable slice of the entire vector.
1845    ///
1846    /// Equivalent to `&mut s[..]`.
1847    ///
1848    /// # Examples
1849    ///
1850    /// ```
1851    /// use std::io::{self, Read};
1852    /// let mut buffer = vec![0; 3];
1853    /// io::repeat(0b101).read_exact(buffer.as_mut_slice()).unwrap();
1854    /// ```
1855    #[inline]
1856    #[stable(feature = "vec_as_slice", since = "1.7.0")]
1857    #[rustc_diagnostic_item = "vec_as_mut_slice"]
1858    #[rustc_const_stable(feature = "const_vec_string_slice", since = "1.87.0")]
1859    pub const fn as_mut_slice(&mut self) -> &mut [T] {
1860        // SAFETY: `slice::from_raw_parts_mut` requires pointee is a contiguous, aligned buffer of
1861        // size `len` containing properly-initialized `T`s. Data must not be accessed through any
1862        // other pointer for the returned lifetime. Further, `len * size_of::<T>` <=
1863        // `isize::MAX` and allocation does not "wrap" through overflowing memory addresses.
1864        //
1865        // * Vec API guarantees that self.buf:
1866        //      * contains only properly-initialized items within 0..len
1867        //      * is aligned, contiguous, and valid for `len` reads
1868        //      * obeys size and address-wrapping constraints
1869        //
1870        // * We only construct references to `self.buf` through `&self` and `&mut self` methods;
1871        //   borrow-check ensures that it is not possible to construct a reference to `self.buf`
1872        //   within the returned lifetime.
1873        unsafe {
1874            // normally this would use `slice::from_raw_parts_mut`, but it's
1875            // instantiated often enough that avoiding the UB check is worth it
1876            &mut *core::intrinsics::aggregate_raw_ptr::<*mut [T], _, _>(self.as_mut_ptr(), self.len)
1877        }
1878    }
1879
1880    /// Returns a raw pointer to the vector's buffer, or a dangling raw pointer
1881    /// valid for zero sized reads if the vector didn't allocate.
1882    ///
1883    /// The caller must ensure that the vector outlives the pointer this
1884    /// function returns, or else it will end up dangling.
1885    /// Modifying the vector may cause its buffer to be reallocated,
1886    /// which would also make any pointers to it invalid.
1887    ///
1888    /// The caller must also ensure that the memory the pointer (non-transitively) points to
1889    /// is never written to (except inside an `UnsafeCell`) using this pointer or any pointer
1890    /// derived from it. If you need to mutate the contents of the slice, use [`as_mut_ptr`].
1891    ///
1892    /// This method guarantees that for the purpose of the aliasing model, this method
1893    /// does not materialize a reference to the underlying slice, and thus the returned pointer
1894    /// will remain valid when mixed with other calls to [`as_ptr`], [`as_mut_ptr`],
1895    /// and [`as_non_null`].
1896    /// Note that calling other methods that materialize mutable references to the slice,
1897    /// or mutable references to specific elements you are planning on accessing through this pointer,
1898    /// as well as writing to those elements, may still invalidate this pointer.
1899    /// See the second example below for how this guarantee can be used.
1900    ///
1901    ///
1902    /// # Examples
1903    ///
1904    /// ```
1905    /// let x = vec![1, 2, 4];
1906    /// let x_ptr = x.as_ptr();
1907    ///
1908    /// unsafe {
1909    ///     for i in 0..x.len() {
1910    ///         assert_eq!(*x_ptr.add(i), 1 << i);
1911    ///     }
1912    /// }
1913    /// ```
1914    ///
1915    /// Due to the aliasing guarantee, the following code is legal:
1916    ///
1917    /// ```rust
1918    /// unsafe {
1919    ///     let mut v = vec![0, 1, 2];
1920    ///     let ptr1 = v.as_ptr();
1921    ///     let _ = ptr1.read();
1922    ///     let ptr2 = v.as_mut_ptr().offset(2);
1923    ///     ptr2.write(2);
1924    ///     // Notably, the write to `ptr2` did *not* invalidate `ptr1`
1925    ///     // because it mutated a different element:
1926    ///     let _ = ptr1.read();
1927    /// }
1928    /// ```
1929    ///
1930    /// [`as_mut_ptr`]: Vec::as_mut_ptr
1931    /// [`as_ptr`]: Vec::as_ptr
1932    /// [`as_non_null`]: Vec::as_non_null
1933    #[stable(feature = "vec_as_ptr", since = "1.37.0")]
1934    #[rustc_const_stable(feature = "const_vec_string_slice", since = "1.87.0")]
1935    #[rustc_never_returns_null_ptr]
1936    #[rustc_as_ptr]
1937    #[inline]
1938    pub const fn as_ptr(&self) -> *const T {
1939        // We shadow the slice method of the same name to avoid going through
1940        // `deref`, which creates an intermediate reference.
1941        self.buf.ptr()
1942    }
1943
1944    /// Returns a raw mutable pointer to the vector's buffer, or a dangling
1945    /// raw pointer valid for zero sized reads if the vector didn't allocate.
1946    ///
1947    /// The caller must ensure that the vector outlives the pointer this
1948    /// function returns, or else it will end up dangling.
1949    /// Modifying the vector may cause its buffer to be reallocated,
1950    /// which would also make any pointers to it invalid.
1951    ///
1952    /// This method guarantees that for the purpose of the aliasing model, this method
1953    /// does not materialize a reference to the underlying slice, and thus the returned pointer
1954    /// will remain valid when mixed with other calls to [`as_ptr`], [`as_mut_ptr`],
1955    /// and [`as_non_null`].
1956    /// Note that calling other methods that materialize references to the slice,
1957    /// or references to specific elements you are planning on accessing through this pointer,
1958    /// may still invalidate this pointer.
1959    /// See the second example below for how this guarantee can be used.
1960    ///
1961    /// The method also guarantees that, as long as `T` is not zero-sized and the capacity is
1962    /// nonzero, the pointer may be passed into [`dealloc`] with a layout of
1963    /// `Layout::array::<T>(capacity)` in order to deallocate the backing memory. If this is done,
1964    /// be careful not to run the destructor of the `Vec`, as dropping it will result in
1965    /// double-frees. Wrapping the `Vec` in a [`ManuallyDrop`] is the typical way to achieve this.
1966    ///
1967    /// # Examples
1968    ///
1969    /// ```
1970    /// // Allocate vector big enough for 4 elements.
1971    /// let size = 4;
1972    /// let mut x: Vec<i32> = Vec::with_capacity(size);
1973    /// let x_ptr = x.as_mut_ptr();
1974    ///
1975    /// // Initialize elements via raw pointer writes, then set length.
1976    /// unsafe {
1977    ///     for i in 0..size {
1978    ///         *x_ptr.add(i) = i as i32;
1979    ///     }
1980    ///     x.set_len(size);
1981    /// }
1982    /// assert_eq!(&*x, &[0, 1, 2, 3]);
1983    /// ```
1984    ///
1985    /// Due to the aliasing guarantee, the following code is legal:
1986    ///
1987    /// ```rust
1988    /// unsafe {
1989    ///     let mut v = vec![0];
1990    ///     let ptr1 = v.as_mut_ptr();
1991    ///     ptr1.write(1);
1992    ///     let ptr2 = v.as_mut_ptr();
1993    ///     ptr2.write(2);
1994    ///     // Notably, the write to `ptr2` did *not* invalidate `ptr1`:
1995    ///     ptr1.write(3);
1996    /// }
1997    /// ```
1998    ///
1999    /// Deallocating a vector using [`Box`] (which uses [`dealloc`] internally):
2000    ///
2001    /// ```
2002    /// use std::mem::{ManuallyDrop, MaybeUninit};
2003    ///
2004    /// let mut v = ManuallyDrop::new(vec![0, 1, 2]);
2005    /// let ptr = v.as_mut_ptr();
2006    /// let capacity = v.capacity();
2007    /// let slice_ptr: *mut [MaybeUninit<i32>] =
2008    ///     std::ptr::slice_from_raw_parts_mut(ptr.cast(), capacity);
2009    /// drop(unsafe { Box::from_raw(slice_ptr) });
2010    /// ```
2011    ///
2012    /// [`as_mut_ptr`]: Vec::as_mut_ptr
2013    /// [`as_ptr`]: Vec::as_ptr
2014    /// [`as_non_null`]: Vec::as_non_null
2015    /// [`dealloc`]: crate::alloc::GlobalAlloc::dealloc
2016    /// [`ManuallyDrop`]: core::mem::ManuallyDrop
2017    #[stable(feature = "vec_as_ptr", since = "1.37.0")]
2018    #[rustc_const_stable(feature = "const_vec_string_slice", since = "1.87.0")]
2019    #[rustc_never_returns_null_ptr]
2020    #[rustc_as_ptr]
2021    #[inline]
2022    pub const fn as_mut_ptr(&mut self) -> *mut T {
2023        // We shadow the slice method of the same name to avoid going through
2024        // `deref_mut`, which creates an intermediate reference.
2025        self.buf.ptr()
2026    }
2027
2028    /// Returns a `NonNull` pointer to the vector's buffer, or a dangling
2029    /// `NonNull` pointer valid for zero sized reads if the vector didn't allocate.
2030    ///
2031    /// The caller must ensure that the vector outlives the pointer this
2032    /// function returns, or else it will end up dangling.
2033    /// Modifying the vector may cause its buffer to be reallocated,
2034    /// which would also make any pointers to it invalid.
2035    ///
2036    /// This method guarantees that for the purpose of the aliasing model, this method
2037    /// does not materialize a reference to the underlying slice, and thus the returned pointer
2038    /// will remain valid when mixed with other calls to [`as_ptr`], [`as_mut_ptr`],
2039    /// and [`as_non_null`].
2040    /// Note that calling other methods that materialize references to the slice,
2041    /// or references to specific elements you are planning on accessing through this pointer,
2042    /// may still invalidate this pointer.
2043    /// See the second example below for how this guarantee can be used.
2044    ///
2045    /// # Examples
2046    ///
2047    /// ```
2048    /// #![feature(box_vec_non_null)]
2049    ///
2050    /// // Allocate vector big enough for 4 elements.
2051    /// let size = 4;
2052    /// let mut x: Vec<i32> = Vec::with_capacity(size);
2053    /// let x_ptr = x.as_non_null();
2054    ///
2055    /// // Initialize elements via raw pointer writes, then set length.
2056    /// unsafe {
2057    ///     for i in 0..size {
2058    ///         x_ptr.add(i).write(i as i32);
2059    ///     }
2060    ///     x.set_len(size);
2061    /// }
2062    /// assert_eq!(&*x, &[0, 1, 2, 3]);
2063    /// ```
2064    ///
2065    /// Due to the aliasing guarantee, the following code is legal:
2066    ///
2067    /// ```rust
2068    /// #![feature(box_vec_non_null)]
2069    ///
2070    /// unsafe {
2071    ///     let mut v = vec![0];
2072    ///     let ptr1 = v.as_non_null();
2073    ///     ptr1.write(1);
2074    ///     let ptr2 = v.as_non_null();
2075    ///     ptr2.write(2);
2076    ///     // Notably, the write to `ptr2` did *not* invalidate `ptr1`:
2077    ///     ptr1.write(3);
2078    /// }
2079    /// ```
2080    ///
2081    /// [`as_mut_ptr`]: Vec::as_mut_ptr
2082    /// [`as_ptr`]: Vec::as_ptr
2083    /// [`as_non_null`]: Vec::as_non_null
2084    #[unstable(feature = "box_vec_non_null", issue = "130364")]
2085    #[rustc_const_unstable(feature = "box_vec_non_null", issue = "130364")]
2086    #[inline]
2087    pub const fn as_non_null(&mut self) -> NonNull<T> {
2088        self.buf.non_null()
2089    }
2090
2091    /// Returns a reference to the underlying allocator.
2092    #[unstable(feature = "allocator_api", issue = "32838")]
2093    #[rustc_const_unstable(feature = "const_heap", issue = "79597")]
2094    #[inline]
2095    pub const fn allocator(&self) -> &A {
2096        self.buf.allocator()
2097    }
2098
2099    /// Forces the length of the vector to `new_len`.
2100    ///
2101    /// This is a low-level operation that maintains none of the normal
2102    /// invariants of the type. Normally changing the length of a vector
2103    /// is done using one of the safe operations instead, such as
2104    /// [`truncate`], [`resize`], [`extend`], or [`clear`].
2105    ///
2106    /// [`truncate`]: Vec::truncate
2107    /// [`resize`]: Vec::resize
2108    /// [`extend`]: Extend::extend
2109    /// [`clear`]: Vec::clear
2110    ///
2111    /// # Safety
2112    ///
2113    /// - `new_len` must be less than or equal to [`capacity()`].
2114    /// - The elements at `old_len..new_len` must be initialized.
2115    ///
2116    /// [`capacity()`]: Vec::capacity
2117    ///
2118    /// # Examples
2119    ///
2120    /// See [`spare_capacity_mut()`] for an example with safe
2121    /// initialization of capacity elements and use of this method.
2122    ///
2123    /// `set_len()` can be useful for situations in which the vector
2124    /// is serving as a buffer for other code, particularly over FFI:
2125    ///
2126    /// ```no_run
2127    /// # #![allow(dead_code)]
2128    /// # // This is just a minimal skeleton for the doc example;
2129    /// # // don't use this as a starting point for a real library.
2130    /// # pub struct StreamWrapper { strm: *mut std::ffi::c_void }
2131    /// # const Z_OK: i32 = 0;
2132    /// # unsafe extern "C" {
2133    /// #     fn deflateGetDictionary(
2134    /// #         strm: *mut std::ffi::c_void,
2135    /// #         dictionary: *mut u8,
2136    /// #         dictLength: *mut usize,
2137    /// #     ) -> i32;
2138    /// # }
2139    /// # impl StreamWrapper {
2140    /// pub fn get_dictionary(&self) -> Option<Vec<u8>> {
2141    ///     // Per the FFI method's docs, "32768 bytes is always enough".
2142    ///     let mut dict = Vec::with_capacity(32_768);
2143    ///     let mut dict_length = 0;
2144    ///     // SAFETY: When `deflateGetDictionary` returns `Z_OK`, it holds that:
2145    ///     // 1. `dict_length` elements were initialized.
2146    ///     // 2. `dict_length` <= the capacity (32_768)
2147    ///     // which makes `set_len` safe to call.
2148    ///     unsafe {
2149    ///         // Make the FFI call...
2150    ///         let r = deflateGetDictionary(self.strm, dict.as_mut_ptr(), &mut dict_length);
2151    ///         if r == Z_OK {
2152    ///             // ...and update the length to what was initialized.
2153    ///             dict.set_len(dict_length);
2154    ///             Some(dict)
2155    ///         } else {
2156    ///             None
2157    ///         }
2158    ///     }
2159    /// }
2160    /// # }
2161    /// ```
2162    ///
2163    /// While the following example is sound, there is a memory leak since
2164    /// the inner vectors were not freed prior to the `set_len` call:
2165    ///
2166    /// ```
2167    /// let mut vec = vec![vec![1, 0, 0],
2168    ///                    vec![0, 1, 0],
2169    ///                    vec![0, 0, 1]];
2170    /// // SAFETY:
2171    /// // 1. `old_len..0` is empty so no elements need to be initialized.
2172    /// // 2. `0 <= capacity` always holds whatever `capacity` is.
2173    /// unsafe {
2174    ///     vec.set_len(0);
2175    /// #   // FIXME(https://github.com/rust-lang/miri/issues/3670):
2176    /// #   // use -Zmiri-disable-leak-check instead of unleaking in tests meant to leak.
2177    /// #   vec.set_len(3);
2178    /// }
2179    /// ```
2180    ///
2181    /// Normally, here, one would use [`clear`] instead to correctly drop
2182    /// the contents and thus not leak memory.
2183    ///
2184    /// [`spare_capacity_mut()`]: Vec::spare_capacity_mut
2185    #[inline]
2186    #[stable(feature = "rust1", since = "1.0.0")]
2187    pub unsafe fn set_len(&mut self, new_len: usize) {
2188        ub_checks::assert_unsafe_precondition!(
2189            check_library_ub,
2190            "Vec::set_len requires that new_len <= capacity()",
2191            (new_len: usize = new_len, capacity: usize = self.capacity()) => new_len <= capacity
2192        );
2193
2194        self.len = new_len;
2195    }
2196
2197    /// Removes an element from the vector and returns it.
2198    ///
2199    /// The removed element is replaced by the last element of the vector.
2200    ///
2201    /// This does not preserve ordering of the remaining elements, but is *O*(1).
2202    /// If you need to preserve the element order, use [`remove`] instead.
2203    ///
2204    /// [`remove`]: Vec::remove
2205    ///
2206    /// # Panics
2207    ///
2208    /// Panics if `index` is out of bounds.
2209    ///
2210    /// # Examples
2211    ///
2212    /// ```
2213    /// let mut v = vec!["foo", "bar", "baz", "qux"];
2214    ///
2215    /// assert_eq!(v.swap_remove(1), "bar");
2216    /// assert_eq!(v, ["foo", "qux", "baz"]);
2217    ///
2218    /// assert_eq!(v.swap_remove(0), "foo");
2219    /// assert_eq!(v, ["baz", "qux"]);
2220    /// ```
2221    #[inline]
2222    #[stable(feature = "rust1", since = "1.0.0")]
2223    pub fn swap_remove(&mut self, index: usize) -> T {
2224        #[cold]
2225        #[cfg_attr(not(panic = "immediate-abort"), inline(never))]
2226        #[optimize(size)]
2227        fn assert_failed(index: usize, len: usize) -> ! {
2228            panic!("swap_remove index (is {index}) should be < len (is {len})");
2229        }
2230
2231        let len = self.len();
2232        if index >= len {
2233            assert_failed(index, len);
2234        }
2235        unsafe {
2236            // We replace self[index] with the last element. Note that if the
2237            // bounds check above succeeds there must be a last element (which
2238            // can be self[index] itself).
2239            let value = ptr::read(self.as_ptr().add(index));
2240            let base_ptr = self.as_mut_ptr();
2241            ptr::copy(base_ptr.add(len - 1), base_ptr.add(index), 1);
2242            self.set_len(len - 1);
2243            value
2244        }
2245    }
2246
2247    /// Inserts an element at position `index` within the vector, shifting all
2248    /// elements after it to the right.
2249    ///
2250    /// # Panics
2251    ///
2252    /// Panics if `index > len`.
2253    ///
2254    /// # Examples
2255    ///
2256    /// ```
2257    /// let mut vec = vec!['a', 'b', 'c'];
2258    /// vec.insert(1, 'd');
2259    /// assert_eq!(vec, ['a', 'd', 'b', 'c']);
2260    /// vec.insert(4, 'e');
2261    /// assert_eq!(vec, ['a', 'd', 'b', 'c', 'e']);
2262    /// ```
2263    ///
2264    /// # Time complexity
2265    ///
2266    /// Takes *O*([`Vec::len`]) time. All items after the insertion index must be
2267    /// shifted to the right. In the worst case, all elements are shifted when
2268    /// the insertion index is 0.
2269    #[cfg(not(no_global_oom_handling))]
2270    #[stable(feature = "rust1", since = "1.0.0")]
2271    #[track_caller]
2272    pub fn insert(&mut self, index: usize, element: T) {
2273        let _ = self.insert_mut(index, element);
2274    }
2275
2276    /// Inserts an element at position `index` within the vector, shifting all
2277    /// elements after it to the right, and returning a reference to the new
2278    /// element.
2279    ///
2280    /// # Panics
2281    ///
2282    /// Panics if `index > len`.
2283    ///
2284    /// # Examples
2285    ///
2286    /// ```
2287    /// let mut vec = vec![1, 3, 5, 9];
2288    /// let x = vec.insert_mut(3, 6);
2289    /// *x += 1;
2290    /// assert_eq!(vec, [1, 3, 5, 7, 9]);
2291    /// ```
2292    ///
2293    /// # Time complexity
2294    ///
2295    /// Takes *O*([`Vec::len`]) time. All items after the insertion index must be
2296    /// shifted to the right. In the worst case, all elements are shifted when
2297    /// the insertion index is 0.
2298    #[cfg(not(no_global_oom_handling))]
2299    #[inline]
2300    #[stable(feature = "push_mut", since = "1.95.0")]
2301    #[track_caller]
2302    #[must_use = "if you don't need a reference to the value, use `Vec::insert` instead"]
2303    pub fn insert_mut(&mut self, index: usize, element: T) -> &mut T {
2304        #[cold]
2305        #[cfg_attr(not(panic = "immediate-abort"), inline(never))]
2306        #[track_caller]
2307        #[optimize(size)]
2308        fn assert_failed(index: usize, len: usize) -> ! {
2309            panic!("insertion index (is {index}) should be <= len (is {len})");
2310        }
2311
2312        let len = self.len();
2313        if index > len {
2314            assert_failed(index, len);
2315        }
2316
2317        // space for the new element
2318        if len == self.buf.capacity() {
2319            self.buf.grow_one();
2320        }
2321
2322        unsafe {
2323            // infallible
2324            // The spot to put the new value
2325            let p = self.as_mut_ptr().add(index);
2326            {
2327                if index < len {
2328                    // Shift everything over to make space. (Duplicating the
2329                    // `index`th element into two consecutive places.)
2330                    ptr::copy(p, p.add(1), len - index);
2331                }
2332                // Write it in, overwriting the first copy of the `index`th
2333                // element.
2334                ptr::write(p, element);
2335            }
2336            self.set_len(len + 1);
2337            &mut *p
2338        }
2339    }
2340
2341    /// Removes and returns the element at position `index` within the vector,
2342    /// shifting all elements after it to the left.
2343    ///
2344    /// Note: Because this shifts over the remaining elements, it has a
2345    /// worst-case performance of *O*(*n*). If you don't need the order of elements
2346    /// to be preserved, use [`swap_remove`] instead. If you'd like to remove
2347    /// elements from the beginning of the `Vec`, consider using
2348    /// [`VecDeque::pop_front`] instead.
2349    ///
2350    /// [`swap_remove`]: Vec::swap_remove
2351    /// [`VecDeque::pop_front`]: crate::collections::VecDeque::pop_front
2352    ///
2353    /// # Panics
2354    ///
2355    /// Panics if `index` is out of bounds.
2356    ///
2357    /// # Examples
2358    ///
2359    /// ```
2360    /// let mut v = vec!['a', 'b', 'c'];
2361    /// assert_eq!(v.remove(1), 'b');
2362    /// assert_eq!(v, ['a', 'c']);
2363    /// ```
2364    #[stable(feature = "rust1", since = "1.0.0")]
2365    #[track_caller]
2366    #[rustc_confusables("delete", "take")]
2367    pub fn remove(&mut self, index: usize) -> T {
2368        #[cold]
2369        #[cfg_attr(not(panic = "immediate-abort"), inline(never))]
2370        #[track_caller]
2371        #[optimize(size)]
2372        fn assert_failed(index: usize, len: usize) -> ! {
2373            panic!("removal index (is {index}) should be < len (is {len})");
2374        }
2375
2376        match self.try_remove(index) {
2377            Some(elem) => elem,
2378            None => assert_failed(index, self.len()),
2379        }
2380    }
2381
2382    /// Remove and return the element at position `index` within the vector,
2383    /// shifting all elements after it to the left, or [`None`] if it does not
2384    /// exist.
2385    ///
2386    /// Note: Because this shifts over the remaining elements, it has a
2387    /// worst-case performance of *O*(*n*). If you'd like to remove
2388    /// elements from the beginning of the `Vec`, consider using
2389    /// [`VecDeque::pop_front`] instead.
2390    ///
2391    /// [`VecDeque::pop_front`]: crate::collections::VecDeque::pop_front
2392    ///
2393    /// # Examples
2394    ///
2395    /// ```
2396    /// #![feature(vec_try_remove)]
2397    /// let mut v = vec![1, 2, 3];
2398    /// assert_eq!(v.try_remove(0), Some(1));
2399    /// assert_eq!(v.try_remove(2), None);
2400    /// ```
2401    #[unstable(feature = "vec_try_remove", issue = "146954")]
2402    #[rustc_confusables("delete", "take", "remove")]
2403    pub fn try_remove(&mut self, index: usize) -> Option<T> {
2404        let len = self.len();
2405        if index >= len {
2406            return None;
2407        }
2408        unsafe {
2409            // infallible
2410            let ret;
2411            {
2412                // the place we are taking from.
2413                let ptr = self.as_mut_ptr().add(index);
2414                // copy it out, unsafely having a copy of the value on
2415                // the stack and in the vector at the same time.
2416                ret = ptr::read(ptr);
2417
2418                // Shift everything down to fill in that spot.
2419                ptr::copy(ptr.add(1), ptr, len - index - 1);
2420            }
2421            self.set_len(len - 1);
2422            Some(ret)
2423        }
2424    }
2425
2426    /// Retains only the elements specified by the predicate.
2427    ///
2428    /// In other words, remove all elements `e` for which `f(&e)` returns `false`.
2429    /// This method operates in place, visiting each element exactly once in the
2430    /// original order, and preserves the order of the retained elements.
2431    ///
2432    /// # Examples
2433    ///
2434    /// ```
2435    /// let mut vec = vec![1, 2, 3, 4];
2436    /// vec.retain(|&x| x % 2 == 0);
2437    /// assert_eq!(vec, [2, 4]);
2438    /// ```
2439    ///
2440    /// Because the elements are visited exactly once in the original order,
2441    /// external state may be used to decide which elements to keep.
2442    ///
2443    /// ```
2444    /// let mut vec = vec![1, 2, 3, 4, 5];
2445    /// let keep = [false, true, true, false, true];
2446    /// let mut iter = keep.iter();
2447    /// vec.retain(|_| *iter.next().unwrap());
2448    /// assert_eq!(vec, [2, 3, 5]);
2449    /// ```
2450    #[stable(feature = "rust1", since = "1.0.0")]
2451    pub fn retain<F>(&mut self, mut f: F)
2452    where
2453        F: FnMut(&T) -> bool,
2454    {
2455        self.retain_mut(|elem| f(elem));
2456    }
2457
2458    /// Retains only the elements specified by the predicate, passing a mutable reference to it.
2459    ///
2460    /// In other words, remove all elements `e` such that `f(&mut e)` returns `false`.
2461    /// This method operates in place, visiting each element exactly once in the
2462    /// original order, and preserves the order of the retained elements.
2463    ///
2464    /// # Examples
2465    ///
2466    /// ```
2467    /// let mut vec = vec![1, 2, 3, 4];
2468    /// vec.retain_mut(|x| if *x <= 3 {
2469    ///     *x += 1;
2470    ///     true
2471    /// } else {
2472    ///     false
2473    /// });
2474    /// assert_eq!(vec, [2, 3, 4]);
2475    /// ```
2476    #[stable(feature = "vec_retain_mut", since = "1.61.0")]
2477    pub fn retain_mut<F>(&mut self, mut f: F)
2478    where
2479        F: FnMut(&mut T) -> bool,
2480    {
2481        let original_len = self.len();
2482
2483        if original_len == 0 {
2484            // Empty case: explicit return allows better optimization, vs letting compiler infer it
2485            return;
2486        }
2487
2488        // Vec: [Kept, Kept, Hole, Hole, Hole, Hole, Unchecked, Unchecked]
2489        //      |            ^- write                ^- read             |
2490        //      |<-              original_len                          ->|
2491        // Kept: Elements which predicate returns true on.
2492        // Hole: Moved or dropped element slot.
2493        // Unchecked: Unchecked valid elements.
2494        //
2495        // This drop guard will be invoked when predicate or `drop` of element panicked.
2496        // It shifts unchecked elements to cover holes and `set_len` to the correct length.
2497        // In cases when predicate and `drop` never panick, it will be optimized out.
2498        struct PanicGuard<'a, T, A: Allocator> {
2499            v: &'a mut Vec<T, A>,
2500            read: usize,
2501            write: usize,
2502            original_len: usize,
2503        }
2504
2505        impl<T, A: Allocator> Drop for PanicGuard<'_, T, A> {
2506            #[cold]
2507            fn drop(&mut self) {
2508                let remaining = self.original_len - self.read;
2509                // SAFETY: Trailing unchecked items must be valid since we never touch them.
2510                unsafe {
2511                    ptr::copy(
2512                        self.v.as_ptr().add(self.read),
2513                        self.v.as_mut_ptr().add(self.write),
2514                        remaining,
2515                    );
2516                }
2517                // SAFETY: After filling holes, all items are in contiguous memory.
2518                unsafe {
2519                    self.v.set_len(self.write + remaining);
2520                }
2521            }
2522        }
2523
2524        let mut read = 0;
2525        loop {
2526            // SAFETY: read < original_len
2527            let cur = unsafe { self.get_unchecked_mut(read) };
2528            if hint::unlikely(!f(cur)) {
2529                break;
2530            }
2531            read += 1;
2532            if read == original_len {
2533                // All elements are kept, return early.
2534                return;
2535            }
2536        }
2537
2538        // Critical section starts here and at least one element is going to be removed.
2539        // Advance `g.read` early to avoid double drop if `drop_in_place` panicked.
2540        let mut g = PanicGuard { v: self, read: read + 1, write: read, original_len };
2541        // SAFETY: previous `read` is always less than original_len.
2542        unsafe { ptr::drop_in_place(&mut *g.v.as_mut_ptr().add(read)) };
2543
2544        while g.read < g.original_len {
2545            // SAFETY: `read` is always less than original_len.
2546            let cur = unsafe { &mut *g.v.as_mut_ptr().add(g.read) };
2547            if !f(cur) {
2548                // Advance `read` early to avoid double drop if `drop_in_place` panicked.
2549                g.read += 1;
2550                // SAFETY: We never touch this element again after dropped.
2551                unsafe { ptr::drop_in_place(cur) };
2552            } else {
2553                // SAFETY: `read` > `write`, so the slots don't overlap.
2554                // We use copy for move, and never touch the source element again.
2555                unsafe {
2556                    let hole = g.v.as_mut_ptr().add(g.write);
2557                    ptr::copy_nonoverlapping(cur, hole, 1);
2558                }
2559                g.write += 1;
2560                g.read += 1;
2561            }
2562        }
2563
2564        // We are leaving the critical section and no panic happened,
2565        // Commit the length change and forget the guard.
2566        // SAFETY: `write` is always less than or equal to original_len.
2567        unsafe { g.v.set_len(g.write) };
2568        mem::forget(g);
2569    }
2570
2571    /// Removes all but the first of consecutive elements in the vector that resolve to the same
2572    /// key.
2573    ///
2574    /// If the vector is sorted, this removes all duplicates.
2575    ///
2576    /// # Examples
2577    ///
2578    /// ```
2579    /// let mut vec = vec![10, 20, 21, 30, 20];
2580    ///
2581    /// vec.dedup_by_key(|i| *i / 10);
2582    ///
2583    /// assert_eq!(vec, [10, 20, 30, 20]);
2584    /// ```
2585    #[stable(feature = "dedup_by", since = "1.16.0")]
2586    #[inline]
2587    pub fn dedup_by_key<F, K>(&mut self, mut key: F)
2588    where
2589        F: FnMut(&mut T) -> K,
2590        K: PartialEq,
2591    {
2592        self.dedup_by(|a, b| key(a) == key(b))
2593    }
2594
2595    /// Removes all but the first of consecutive elements in the vector satisfying a given equality
2596    /// relation.
2597    ///
2598    /// The `same_bucket` function is passed references to two elements from the vector and
2599    /// must determine if the elements compare equal. The elements are passed in opposite order
2600    /// from their order in the slice, so if `same_bucket(a, b)` returns `true`, `a` is removed.
2601    ///
2602    /// If the vector is sorted, this removes all duplicates.
2603    ///
2604    /// # Examples
2605    ///
2606    /// ```
2607    /// let mut vec = vec!["foo", "bar", "Bar", "baz", "bar"];
2608    ///
2609    /// vec.dedup_by(|a, b| a.eq_ignore_ascii_case(b));
2610    ///
2611    /// assert_eq!(vec, ["foo", "bar", "baz", "bar"]);
2612    /// ```
2613    #[stable(feature = "dedup_by", since = "1.16.0")]
2614    pub fn dedup_by<F>(&mut self, mut same_bucket: F)
2615    where
2616        F: FnMut(&mut T, &mut T) -> bool,
2617    {
2618        let len = self.len();
2619        if len <= 1 {
2620            return;
2621        }
2622
2623        // Check if we ever want to remove anything.
2624        // This allows to use copy_non_overlapping in next cycle.
2625        // And avoids any memory writes if we don't need to remove anything.
2626        let mut first_duplicate_idx: usize = 1;
2627        let start = self.as_mut_ptr();
2628        while first_duplicate_idx != len {
2629            let found_duplicate = unsafe {
2630                // SAFETY: first_duplicate always in range [1..len)
2631                // Note that we start iteration from 1 so we never overflow.
2632                let prev = start.add(first_duplicate_idx.wrapping_sub(1));
2633                let current = start.add(first_duplicate_idx);
2634                // We explicitly say in docs that references are reversed.
2635                same_bucket(&mut *current, &mut *prev)
2636            };
2637            if found_duplicate {
2638                break;
2639            }
2640            first_duplicate_idx += 1;
2641        }
2642        // Don't need to remove anything.
2643        // We cannot get bigger than len.
2644        if first_duplicate_idx == len {
2645            return;
2646        }
2647
2648        /* INVARIANT: vec.len() > read > write > write-1 >= 0 */
2649        struct FillGapOnDrop<'a, T, A: core::alloc::Allocator> {
2650            /* Offset of the element we want to check if it is duplicate */
2651            read: usize,
2652
2653            /* Offset of the place where we want to place the non-duplicate
2654             * when we find it. */
2655            write: usize,
2656
2657            /* The Vec that would need correction if `same_bucket` panicked */
2658            vec: &'a mut Vec<T, A>,
2659        }
2660
2661        impl<'a, T, A: core::alloc::Allocator> Drop for FillGapOnDrop<'a, T, A> {
2662            fn drop(&mut self) {
2663                /* This code gets executed when `same_bucket` panics */
2664
2665                /* SAFETY: invariant guarantees that `read - write`
2666                 * and `len - read` never overflow and that the copy is always
2667                 * in-bounds. */
2668                unsafe {
2669                    let ptr = self.vec.as_mut_ptr();
2670                    let len = self.vec.len();
2671
2672                    /* How many items were left when `same_bucket` panicked.
2673                     * Basically vec[read..].len() */
2674                    let items_left = len.wrapping_sub(self.read);
2675
2676                    /* Pointer to first item in vec[write..write+items_left] slice */
2677                    let dropped_ptr = ptr.add(self.write);
2678                    /* Pointer to first item in vec[read..] slice */
2679                    let valid_ptr = ptr.add(self.read);
2680
2681                    /* Copy `vec[read..]` to `vec[write..write+items_left]`.
2682                     * The slices can overlap, so `copy_nonoverlapping` cannot be used */
2683                    ptr::copy(valid_ptr, dropped_ptr, items_left);
2684
2685                    /* How many items have been already dropped
2686                     * Basically vec[read..write].len() */
2687                    let dropped = self.read.wrapping_sub(self.write);
2688
2689                    self.vec.set_len(len - dropped);
2690                }
2691            }
2692        }
2693
2694        /* Drop items while going through Vec, it should be more efficient than
2695         * doing slice partition_dedup + truncate */
2696
2697        // Construct gap first and then drop item to avoid memory corruption if `T::drop` panics.
2698        let mut gap =
2699            FillGapOnDrop { read: first_duplicate_idx + 1, write: first_duplicate_idx, vec: self };
2700        unsafe {
2701            // SAFETY: we checked that first_duplicate_idx in bounds before.
2702            // If drop panics, `gap` would remove this item without drop.
2703            ptr::drop_in_place(start.add(first_duplicate_idx));
2704        }
2705
2706        /* SAFETY: Because of the invariant, read_ptr, prev_ptr and write_ptr
2707         * are always in-bounds and read_ptr never aliases prev_ptr */
2708        unsafe {
2709            while gap.read < len {
2710                let read_ptr = start.add(gap.read);
2711                let prev_ptr = start.add(gap.write.wrapping_sub(1));
2712
2713                // We explicitly say in docs that references are reversed.
2714                let found_duplicate = same_bucket(&mut *read_ptr, &mut *prev_ptr);
2715                if found_duplicate {
2716                    // Increase `gap.read` now since the drop may panic.
2717                    gap.read += 1;
2718                    /* We have found duplicate, drop it in-place */
2719                    ptr::drop_in_place(read_ptr);
2720                } else {
2721                    let write_ptr = start.add(gap.write);
2722
2723                    /* read_ptr cannot be equal to write_ptr because at this point
2724                     * we guaranteed to skip at least one element (before loop starts).
2725                     */
2726                    ptr::copy_nonoverlapping(read_ptr, write_ptr, 1);
2727
2728                    /* We have filled that place, so go further */
2729                    gap.write += 1;
2730                    gap.read += 1;
2731                }
2732            }
2733
2734            /* Technically we could let `gap` clean up with its Drop, but
2735             * when `same_bucket` is guaranteed to not panic, this bloats a little
2736             * the codegen, so we just do it manually */
2737            gap.vec.set_len(gap.write);
2738            mem::forget(gap);
2739        }
2740    }
2741
2742    /// Appends an element and returns a reference to it if there is sufficient spare capacity,
2743    /// otherwise an error is returned with the element.
2744    ///
2745    /// Unlike [`push`] this method will not reallocate when there's insufficient capacity.
2746    /// The caller should use [`reserve`] or [`try_reserve`] to ensure that there is enough capacity.
2747    ///
2748    /// [`push`]: Vec::push
2749    /// [`reserve`]: Vec::reserve
2750    /// [`try_reserve`]: Vec::try_reserve
2751    ///
2752    /// # Examples
2753    ///
2754    /// A manual, panic-free alternative to [`FromIterator`]:
2755    ///
2756    /// ```
2757    /// #![feature(vec_push_within_capacity)]
2758    ///
2759    /// use std::collections::TryReserveError;
2760    /// fn from_iter_fallible<T>(iter: impl Iterator<Item=T>) -> Result<Vec<T>, TryReserveError> {
2761    ///     let mut vec = Vec::new();
2762    ///     for value in iter {
2763    ///         if let Err(value) = vec.push_within_capacity(value) {
2764    ///             vec.try_reserve(1)?;
2765    ///             // this cannot fail, the previous line either returned or added at least 1 free slot
2766    ///             let _ = vec.push_within_capacity(value);
2767    ///         }
2768    ///     }
2769    ///     Ok(vec)
2770    /// }
2771    /// assert_eq!(from_iter_fallible(0..100), Ok(Vec::from_iter(0..100)));
2772    /// ```
2773    ///
2774    /// # Time complexity
2775    ///
2776    /// Takes *O*(1) time.
2777    #[inline]
2778    #[unstable(feature = "vec_push_within_capacity", issue = "100486")]
2779    pub fn push_within_capacity(&mut self, value: T) -> Result<&mut T, T> {
2780        if self.len == self.buf.capacity() {
2781            return Err(value);
2782        }
2783
2784        unsafe {
2785            let end = self.as_mut_ptr().add(self.len);
2786            ptr::write(end, value);
2787            self.len += 1;
2788
2789            // SAFETY: We just wrote a value to the pointer that will live the lifetime of the reference.
2790            Ok(&mut *end)
2791        }
2792    }
2793
2794    /// Removes the last element from a vector and returns it, or [`None`] if it
2795    /// is empty.
2796    ///
2797    /// If you'd like to pop the first element, consider using
2798    /// [`VecDeque::pop_front`] instead.
2799    ///
2800    /// [`VecDeque::pop_front`]: crate::collections::VecDeque::pop_front
2801    ///
2802    /// # Examples
2803    ///
2804    /// ```
2805    /// let mut vec = vec![1, 2, 3];
2806    /// assert_eq!(vec.pop(), Some(3));
2807    /// assert_eq!(vec, [1, 2]);
2808    /// ```
2809    ///
2810    /// # Time complexity
2811    ///
2812    /// Takes *O*(1) time.
2813    #[inline]
2814    #[stable(feature = "rust1", since = "1.0.0")]
2815    #[rustc_diagnostic_item = "vec_pop"]
2816    pub fn pop(&mut self) -> Option<T> {
2817        if self.len == 0 {
2818            None
2819        } else {
2820            unsafe {
2821                self.len -= 1;
2822                core::hint::assert_unchecked(self.len < self.capacity());
2823                Some(ptr::read(self.as_ptr().add(self.len())))
2824            }
2825        }
2826    }
2827
2828    /// Removes and returns the last element from a vector if the predicate
2829    /// returns `true`, or [`None`] if the predicate returns false or the vector
2830    /// is empty (the predicate will not be called in that case).
2831    ///
2832    /// # Examples
2833    ///
2834    /// ```
2835    /// let mut vec = vec![1, 2, 3, 4];
2836    /// let pred = |x: &mut i32| *x % 2 == 0;
2837    ///
2838    /// assert_eq!(vec.pop_if(pred), Some(4));
2839    /// assert_eq!(vec, [1, 2, 3]);
2840    /// assert_eq!(vec.pop_if(pred), None);
2841    /// ```
2842    #[stable(feature = "vec_pop_if", since = "1.86.0")]
2843    pub fn pop_if(&mut self, predicate: impl FnOnce(&mut T) -> bool) -> Option<T> {
2844        let last = self.last_mut()?;
2845        if predicate(last) { self.pop() } else { None }
2846    }
2847
2848    /// Returns a mutable reference to the last item in the vector, or
2849    /// `None` if it is empty.
2850    ///
2851    /// # Examples
2852    ///
2853    /// Basic usage:
2854    ///
2855    /// ```
2856    /// #![feature(vec_peek_mut)]
2857    /// let mut vec = Vec::new();
2858    /// assert!(vec.peek_mut().is_none());
2859    ///
2860    /// vec.push(1);
2861    /// vec.push(5);
2862    /// vec.push(2);
2863    /// assert_eq!(vec.last(), Some(&2));
2864    /// if let Some(mut val) = vec.peek_mut() {
2865    ///     *val = 0;
2866    /// }
2867    /// assert_eq!(vec.last(), Some(&0));
2868    /// ```
2869    #[inline]
2870    #[unstable(feature = "vec_peek_mut", issue = "122742")]
2871    pub fn peek_mut(&mut self) -> Option<PeekMut<'_, T, A>> {
2872        PeekMut::new(self)
2873    }
2874
2875    /// Moves all the elements of `other` into `self`, leaving `other` empty.
2876    ///
2877    /// # Panics
2878    ///
2879    /// Panics if the new capacity exceeds `isize::MAX` _bytes_.
2880    ///
2881    /// # Examples
2882    ///
2883    /// ```
2884    /// let mut vec = vec![1, 2, 3];
2885    /// let mut vec2 = vec![4, 5, 6];
2886    /// vec.append(&mut vec2);
2887    /// assert_eq!(vec, [1, 2, 3, 4, 5, 6]);
2888    /// assert_eq!(vec2, []);
2889    /// ```
2890    #[cfg(not(no_global_oom_handling))]
2891    #[inline]
2892    #[stable(feature = "append", since = "1.4.0")]
2893    pub fn append(&mut self, other: &mut Self) {
2894        unsafe {
2895            self.append_elements(other.as_slice() as _);
2896            other.set_len(0);
2897        }
2898    }
2899
2900    /// Appends elements to `self` from other buffer.
2901    #[cfg(not(no_global_oom_handling))]
2902    #[inline]
2903    unsafe fn append_elements(&mut self, other: *const [T]) {
2904        let count = other.len();
2905        self.reserve(count);
2906        let len = self.len();
2907        if count > 0 {
2908            unsafe {
2909                ptr::copy_nonoverlapping(other as *const T, self.as_mut_ptr().add(len), count)
2910            };
2911        }
2912        self.len += count;
2913    }
2914
2915    /// Removes the subslice indicated by the given range from the vector,
2916    /// returning a double-ended iterator over the removed subslice.
2917    ///
2918    /// If the iterator is dropped before being fully consumed,
2919    /// it drops the remaining removed elements.
2920    ///
2921    /// The returned iterator keeps a mutable borrow on the vector to optimize
2922    /// its implementation.
2923    ///
2924    /// # Panics
2925    ///
2926    /// Panics if the range has `start_bound > end_bound`, or, if the range is
2927    /// bounded on either end and past the length of the vector.
2928    ///
2929    /// # Leaking
2930    ///
2931    /// If the returned iterator goes out of scope without being dropped (due to
2932    /// [`mem::forget`], for example), the vector may have lost and leaked
2933    /// elements arbitrarily, including elements outside the range.
2934    ///
2935    /// # Examples
2936    ///
2937    /// ```
2938    /// let mut v = vec![1, 2, 3];
2939    /// let u: Vec<_> = v.drain(1..).collect();
2940    /// assert_eq!(v, &[1]);
2941    /// assert_eq!(u, &[2, 3]);
2942    ///
2943    /// // A full range clears the vector, like `clear()` does
2944    /// v.drain(..);
2945    /// assert_eq!(v, &[]);
2946    /// ```
2947    #[stable(feature = "drain", since = "1.6.0")]
2948    pub fn drain<R>(&mut self, range: R) -> Drain<'_, T, A>
2949    where
2950        R: RangeBounds<usize>,
2951    {
2952        // Memory safety
2953        //
2954        // When the Drain is first created, it shortens the length of
2955        // the source vector to make sure no uninitialized or moved-from elements
2956        // are accessible at all if the Drain's destructor never gets to run.
2957        //
2958        // Drain will ptr::read out the values to remove.
2959        // When finished, remaining tail of the vec is copied back to cover
2960        // the hole, and the vector length is restored to the new length.
2961        //
2962        let len = self.len();
2963        let Range { start, end } = slice::range(range, ..len);
2964
2965        unsafe {
2966            // set self.vec length's to start, to be safe in case Drain is leaked
2967            self.set_len(start);
2968            let range_slice = slice::from_raw_parts(self.as_ptr().add(start), end - start);
2969            Drain {
2970                tail_start: end,
2971                tail_len: len - end,
2972                iter: range_slice.iter(),
2973                vec: NonNull::from(self),
2974            }
2975        }
2976    }
2977
2978    /// Clears the vector, removing all values.
2979    ///
2980    /// Note that this method has no effect on the allocated capacity
2981    /// of the vector.
2982    ///
2983    /// # Examples
2984    ///
2985    /// ```
2986    /// let mut v = vec![1, 2, 3];
2987    ///
2988    /// v.clear();
2989    ///
2990    /// assert!(v.is_empty());
2991    /// ```
2992    #[inline]
2993    #[stable(feature = "rust1", since = "1.0.0")]
2994    pub fn clear(&mut self) {
2995        let elems: *mut [T] = self.as_mut_slice();
2996
2997        // SAFETY:
2998        // - `elems` comes directly from `as_mut_slice` and is therefore valid.
2999        // - Setting `self.len` before calling `drop_in_place` means that,
3000        //   if an element's `Drop` impl panics, the vector's `Drop` impl will
3001        //   do nothing (leaking the rest of the elements) instead of dropping
3002        //   some twice.
3003        unsafe {
3004            self.len = 0;
3005            ptr::drop_in_place(elems);
3006        }
3007    }
3008
3009    /// Returns the number of elements in the vector, also referred to
3010    /// as its 'length'.
3011    ///
3012    /// # Examples
3013    ///
3014    /// ```
3015    /// let a = vec![1, 2, 3];
3016    /// assert_eq!(a.len(), 3);
3017    /// ```
3018    #[inline]
3019    #[stable(feature = "rust1", since = "1.0.0")]
3020    #[rustc_const_stable(feature = "const_vec_string_slice", since = "1.87.0")]
3021    #[rustc_confusables("length", "size")]
3022    pub const fn len(&self) -> usize {
3023        let len = self.len;
3024
3025        // SAFETY: The maximum capacity of `Vec<T>` is `isize::MAX` bytes, so the maximum value can
3026        // be returned is `usize::checked_div(size_of::<T>()).unwrap_or(usize::MAX)`, which
3027        // matches the definition of `T::MAX_SLICE_LEN`.
3028        unsafe { intrinsics::assume(len <= T::MAX_SLICE_LEN) };
3029
3030        len
3031    }
3032
3033    /// Returns `true` if the vector contains no elements.
3034    ///
3035    /// # Examples
3036    ///
3037    /// ```
3038    /// let mut v = Vec::new();
3039    /// assert!(v.is_empty());
3040    ///
3041    /// v.push(1);
3042    /// assert!(!v.is_empty());
3043    /// ```
3044    #[stable(feature = "rust1", since = "1.0.0")]
3045    #[rustc_diagnostic_item = "vec_is_empty"]
3046    #[rustc_const_stable(feature = "const_vec_string_slice", since = "1.87.0")]
3047    pub const fn is_empty(&self) -> bool {
3048        self.len() == 0
3049    }
3050
3051    /// Splits the collection into two at the given index.
3052    ///
3053    /// Returns a newly allocated vector containing the elements in the range
3054    /// `[at, len)`. After the call, the original vector will be left containing
3055    /// the elements `[0, at)` with its previous capacity unchanged.
3056    ///
3057    /// - If you want to take ownership of the entire contents and capacity of
3058    ///   the vector, see [`mem::take`] or [`mem::replace`].
3059    /// - If you don't need the returned vector at all, see [`Vec::truncate`].
3060    /// - If you want to take ownership of an arbitrary subslice, or you don't
3061    ///   necessarily want to store the removed items in a vector, see [`Vec::drain`].
3062    ///
3063    /// # Panics
3064    ///
3065    /// Panics if `at > len`.
3066    ///
3067    /// # Examples
3068    ///
3069    /// ```
3070    /// let mut vec = vec!['a', 'b', 'c'];
3071    /// let vec2 = vec.split_off(1);
3072    /// assert_eq!(vec, ['a']);
3073    /// assert_eq!(vec2, ['b', 'c']);
3074    /// ```
3075    #[cfg(not(no_global_oom_handling))]
3076    #[inline]
3077    #[must_use = "use `.truncate()` if you don't need the other half"]
3078    #[stable(feature = "split_off", since = "1.4.0")]
3079    #[track_caller]
3080    pub fn split_off(&mut self, at: usize) -> Self
3081    where
3082        A: Clone,
3083    {
3084        #[cold]
3085        #[cfg_attr(not(panic = "immediate-abort"), inline(never))]
3086        #[track_caller]
3087        #[optimize(size)]
3088        fn assert_failed(at: usize, len: usize) -> ! {
3089            panic!("`at` split index (is {at}) should be <= len (is {len})");
3090        }
3091
3092        if at > self.len() {
3093            assert_failed(at, self.len());
3094        }
3095
3096        let other_len = self.len - at;
3097        let mut other = Vec::with_capacity_in(other_len, self.allocator().clone());
3098
3099        // Unsafely `set_len` and copy items to `other`.
3100        unsafe {
3101            self.set_len(at);
3102            other.set_len(other_len);
3103
3104            ptr::copy_nonoverlapping(self.as_ptr().add(at), other.as_mut_ptr(), other.len());
3105        }
3106        other
3107    }
3108
3109    /// Resizes the `Vec` in-place so that `len` is equal to `new_len`.
3110    ///
3111    /// If `new_len` is greater than `len`, the `Vec` is extended by the
3112    /// difference, with each additional slot filled with the result of
3113    /// calling the closure `f`. The return values from `f` will end up
3114    /// in the `Vec` in the order they have been generated.
3115    ///
3116    /// If `new_len` is less than `len`, the `Vec` is simply truncated.
3117    ///
3118    /// This method uses a closure to create new values on every push. If
3119    /// you'd rather [`Clone`] a given value, use [`Vec::resize`]. If you
3120    /// want to use the [`Default`] trait to generate values, you can
3121    /// pass [`Default::default`] as the second argument.
3122    ///
3123    /// # Panics
3124    ///
3125    /// Panics if the new capacity exceeds `isize::MAX` _bytes_.
3126    ///
3127    /// # Examples
3128    ///
3129    /// ```
3130    /// let mut vec = vec![1, 2, 3];
3131    /// vec.resize_with(5, Default::default);
3132    /// assert_eq!(vec, [1, 2, 3, 0, 0]);
3133    ///
3134    /// let mut vec = vec![];
3135    /// let mut p = 1;
3136    /// vec.resize_with(4, || { p *= 2; p });
3137    /// assert_eq!(vec, [2, 4, 8, 16]);
3138    /// ```
3139    #[cfg(not(no_global_oom_handling))]
3140    #[stable(feature = "vec_resize_with", since = "1.33.0")]
3141    pub fn resize_with<F>(&mut self, new_len: usize, f: F)
3142    where
3143        F: FnMut() -> T,
3144    {
3145        let len = self.len();
3146        if new_len > len {
3147            self.extend_trusted(iter::repeat_with(f).take(new_len - len));
3148        } else {
3149            self.truncate(new_len);
3150        }
3151    }
3152
3153    /// Consumes and leaks the `Vec`, returning a mutable reference to the contents,
3154    /// `&'a mut [T]`.
3155    ///
3156    /// Note that the type `T` must outlive the chosen lifetime `'a`. If the type
3157    /// has only static references, or none at all, then this may be chosen to be
3158    /// `'static`.
3159    ///
3160    /// As of Rust 1.57, this method does not reallocate or shrink the `Vec`,
3161    /// so the leaked allocation may include unused capacity that is not part
3162    /// of the returned slice.
3163    ///
3164    /// This function is mainly useful for data that lives for the remainder of
3165    /// the program's life. Dropping the returned reference will cause a memory
3166    /// leak.
3167    ///
3168    /// # Examples
3169    ///
3170    /// Simple usage:
3171    ///
3172    /// ```
3173    /// let x = vec![1, 2, 3];
3174    /// let static_ref: &'static mut [usize] = x.leak();
3175    /// static_ref[0] += 1;
3176    /// assert_eq!(static_ref, &[2, 2, 3]);
3177    /// # // FIXME(https://github.com/rust-lang/miri/issues/3670):
3178    /// # // use -Zmiri-disable-leak-check instead of unleaking in tests meant to leak.
3179    /// # drop(unsafe { Box::from_raw(static_ref) });
3180    /// ```
3181    #[stable(feature = "vec_leak", since = "1.47.0")]
3182    #[inline]
3183    pub fn leak<'a>(self) -> &'a mut [T]
3184    where
3185        A: 'a,
3186    {
3187        let mut me = ManuallyDrop::new(self);
3188        unsafe { slice::from_raw_parts_mut(me.as_mut_ptr(), me.len) }
3189    }
3190
3191    /// Returns the remaining spare capacity of the vector as a slice of
3192    /// `MaybeUninit<T>`.
3193    ///
3194    /// The returned slice can be used to fill the vector with data (e.g. by
3195    /// reading from a file) before marking the data as initialized using the
3196    /// [`set_len`] method.
3197    ///
3198    /// [`set_len`]: Vec::set_len
3199    ///
3200    /// # Examples
3201    ///
3202    /// ```
3203    /// // Allocate vector big enough for 10 elements.
3204    /// let mut v = Vec::with_capacity(10);
3205    ///
3206    /// // Fill in the first 3 elements.
3207    /// let uninit = v.spare_capacity_mut();
3208    /// uninit[0].write(0);
3209    /// uninit[1].write(1);
3210    /// uninit[2].write(2);
3211    ///
3212    /// // Mark the first 3 elements of the vector as being initialized.
3213    /// unsafe {
3214    ///     v.set_len(3);
3215    /// }
3216    ///
3217    /// assert_eq!(&v, &[0, 1, 2]);
3218    /// ```
3219    #[stable(feature = "vec_spare_capacity", since = "1.60.0")]
3220    #[inline]
3221    pub fn spare_capacity_mut(&mut self) -> &mut [MaybeUninit<T>] {
3222        // Note:
3223        // This method is not implemented in terms of `split_at_spare_mut`,
3224        // to prevent invalidation of pointers to the buffer.
3225        unsafe {
3226            slice::from_raw_parts_mut(
3227                self.as_mut_ptr().add(self.len) as *mut MaybeUninit<T>,
3228                self.buf.capacity() - self.len,
3229            )
3230        }
3231    }
3232
3233    /// Returns vector content as a slice of `T`, along with the remaining spare
3234    /// capacity of the vector as a slice of `MaybeUninit<T>`.
3235    ///
3236    /// The returned spare capacity slice can be used to fill the vector with data
3237    /// (e.g. by reading from a file) before marking the data as initialized using
3238    /// the [`set_len`] method.
3239    ///
3240    /// [`set_len`]: Vec::set_len
3241    ///
3242    /// Note that this is a low-level API, which should be used with care for
3243    /// optimization purposes. If you need to append data to a `Vec`
3244    /// you can use [`push`], [`extend`], [`extend_from_slice`],
3245    /// [`extend_from_within`], [`insert`], [`append`], [`resize`] or
3246    /// [`resize_with`], depending on your exact needs.
3247    ///
3248    /// [`push`]: Vec::push
3249    /// [`extend`]: Vec::extend
3250    /// [`extend_from_slice`]: Vec::extend_from_slice
3251    /// [`extend_from_within`]: Vec::extend_from_within
3252    /// [`insert`]: Vec::insert
3253    /// [`append`]: Vec::append
3254    /// [`resize`]: Vec::resize
3255    /// [`resize_with`]: Vec::resize_with
3256    ///
3257    /// # Examples
3258    ///
3259    /// ```
3260    /// #![feature(vec_split_at_spare)]
3261    ///
3262    /// let mut v = vec![1, 1, 2];
3263    ///
3264    /// // Reserve additional space big enough for 10 elements.
3265    /// v.reserve(10);
3266    ///
3267    /// let (init, uninit) = v.split_at_spare_mut();
3268    /// let sum = init.iter().copied().sum::<u32>();
3269    ///
3270    /// // Fill in the next 4 elements.
3271    /// uninit[0].write(sum);
3272    /// uninit[1].write(sum * 2);
3273    /// uninit[2].write(sum * 3);
3274    /// uninit[3].write(sum * 4);
3275    ///
3276    /// // Mark the 4 elements of the vector as being initialized.
3277    /// unsafe {
3278    ///     let len = v.len();
3279    ///     v.set_len(len + 4);
3280    /// }
3281    ///
3282    /// assert_eq!(&v, &[1, 1, 2, 4, 8, 12, 16]);
3283    /// ```
3284    #[unstable(feature = "vec_split_at_spare", issue = "81944")]
3285    #[inline]
3286    pub fn split_at_spare_mut(&mut self) -> (&mut [T], &mut [MaybeUninit<T>]) {
3287        // SAFETY:
3288        // - len is ignored and so never changed
3289        let (init, spare, _) = unsafe { self.split_at_spare_mut_with_len() };
3290        (init, spare)
3291    }
3292
3293    /// Safety: changing returned .2 (&mut usize) is considered the same as calling `.set_len(_)`.
3294    ///
3295    /// This method provides unique access to all vec parts at once in `extend_from_within`.
3296    unsafe fn split_at_spare_mut_with_len(
3297        &mut self,
3298    ) -> (&mut [T], &mut [MaybeUninit<T>], &mut usize) {
3299        let ptr = self.as_mut_ptr();
3300        // SAFETY:
3301        // - `ptr` is guaranteed to be valid for `self.len` elements
3302        // - but the allocation extends out to `self.buf.capacity()` elements, possibly
3303        // uninitialized
3304        let spare_ptr = unsafe { ptr.add(self.len) };
3305        let spare_ptr = spare_ptr.cast_uninit();
3306        let spare_len = self.buf.capacity() - self.len;
3307
3308        // SAFETY:
3309        // - `ptr` is guaranteed to be valid for `self.len` elements
3310        // - `spare_ptr` is pointing one element past the buffer, so it doesn't overlap with `initialized`
3311        unsafe {
3312            let initialized = slice::from_raw_parts_mut(ptr, self.len);
3313            let spare = slice::from_raw_parts_mut(spare_ptr, spare_len);
3314
3315            (initialized, spare, &mut self.len)
3316        }
3317    }
3318
3319    /// Groups every `N` elements in the `Vec<T>` into chunks to produce a `Vec<[T; N]>`, dropping
3320    /// elements in the remainder. `N` must be greater than zero.
3321    ///
3322    /// If the capacity is not a multiple of the chunk size, the buffer will shrink down to the
3323    /// nearest multiple with a reallocation or deallocation.
3324    ///
3325    /// This function can be used to reverse [`Vec::into_flattened`].
3326    ///
3327    /// # Examples
3328    ///
3329    /// ```
3330    /// #![feature(vec_into_chunks)]
3331    ///
3332    /// let vec = vec![0, 1, 2, 3, 4, 5, 6, 7];
3333    /// assert_eq!(vec.into_chunks::<3>(), [[0, 1, 2], [3, 4, 5]]);
3334    ///
3335    /// let vec = vec![0, 1, 2, 3];
3336    /// let chunks: Vec<[u8; 10]> = vec.into_chunks();
3337    /// assert!(chunks.is_empty());
3338    ///
3339    /// let flat = vec![0; 8 * 8 * 8];
3340    /// let reshaped: Vec<[[[u8; 8]; 8]; 8]> = flat.into_chunks().into_chunks().into_chunks();
3341    /// assert_eq!(reshaped.len(), 1);
3342    /// ```
3343    #[cfg(not(no_global_oom_handling))]
3344    #[unstable(feature = "vec_into_chunks", issue = "142137")]
3345    pub fn into_chunks<const N: usize>(mut self) -> Vec<[T; N], A> {
3346        const {
3347            assert!(N != 0, "chunk size must be greater than zero");
3348        }
3349
3350        let (len, cap) = (self.len(), self.capacity());
3351
3352        let len_remainder = len % N;
3353        if len_remainder != 0 {
3354            self.truncate(len - len_remainder);
3355        }
3356
3357        let cap_remainder = cap % N;
3358        if !T::IS_ZST && cap_remainder != 0 {
3359            self.buf.shrink_to_fit(cap - cap_remainder);
3360        }
3361
3362        let (ptr, _, _, alloc) = self.into_raw_parts_with_alloc();
3363
3364        // SAFETY:
3365        // - `ptr` and `alloc` were just returned from `self.into_raw_parts_with_alloc()`
3366        // - `[T; N]` has the same alignment as `T`
3367        // - `size_of::<[T; N]>() * cap / N == size_of::<T>() * cap`
3368        // - `len / N <= cap / N` because `len <= cap`
3369        // - the allocated memory consists of `len / N` valid values of type `[T; N]`
3370        // - `cap / N` fits the size of the allocated memory after shrinking
3371        unsafe { Vec::from_raw_parts_in(ptr.cast(), len / N, cap / N, alloc) }
3372    }
3373
3374    /// This clears out this `Vec` and recycles the allocation into a new `Vec`.
3375    /// The item type of the resulting `Vec` needs to have the same size and
3376    /// alignment as the item type of the original `Vec`.
3377    ///
3378    /// # Examples
3379    ///
3380    ///  ```
3381    /// #![feature(vec_recycle, transmutability)]
3382    /// let a: Vec<u8> = vec![0; 100];
3383    /// let capacity = a.capacity();
3384    /// let addr = a.as_ptr().addr();
3385    /// let b: Vec<i8> = a.recycle();
3386    /// assert_eq!(b.len(), 0);
3387    /// assert_eq!(b.capacity(), capacity);
3388    /// assert_eq!(b.as_ptr().addr(), addr);
3389    /// ```
3390    ///
3391    /// The `Recyclable` bound prevents this method from being called when `T` and `U` have different sizes; e.g.:
3392    ///
3393    ///  ```compile_fail,E0277
3394    /// #![feature(vec_recycle, transmutability)]
3395    /// let vec: Vec<[u8; 2]> = Vec::new();
3396    /// let _: Vec<[u8; 1]> = vec.recycle();
3397    /// ```
3398    /// ...or different alignments:
3399    ///
3400    ///  ```compile_fail,E0277
3401    /// #![feature(vec_recycle, transmutability)]
3402    /// let vec: Vec<[u16; 0]> = Vec::new();
3403    /// let _: Vec<[u8; 0]> = vec.recycle();
3404    /// ```
3405    ///
3406    /// However, due to temporary implementation limitations of `Recyclable`,
3407    /// this method is not yet callable when `T` or `U` are slices, trait objects,
3408    /// or other exotic types; e.g.:
3409    ///
3410    /// ```compile_fail,E0277
3411    /// #![feature(vec_recycle, transmutability)]
3412    /// # let inputs = ["a b c", "d e f"];
3413    /// # fn process(_: &[&str]) {}
3414    /// let mut storage: Vec<&[&str]> = Vec::new();
3415    ///
3416    /// for input in inputs {
3417    ///     let mut buffer: Vec<&str> = storage.recycle();
3418    ///     buffer.extend(input.split(" "));
3419    ///     process(&buffer);
3420    ///     storage = buffer.recycle();
3421    /// }
3422    /// ```
3423    #[unstable(feature = "vec_recycle", issue = "148227")]
3424    #[expect(private_bounds)]
3425    pub fn recycle<U>(mut self) -> Vec<U, A>
3426    where
3427        U: Recyclable<T>,
3428    {
3429        self.clear();
3430        const {
3431            // FIXME(const-hack, 146097): compare `Layout`s
3432            assert!(size_of::<T>() == size_of::<U>());
3433            assert!(align_of::<T>() == align_of::<U>());
3434        };
3435        let (ptr, length, capacity, alloc) = self.into_parts_with_alloc();
3436        debug_assert_eq!(length, 0);
3437        // SAFETY:
3438        // - `ptr` and `alloc` were just returned from `self.into_raw_parts_with_alloc()`
3439        // - `T` & `U` have the same layout, so `capacity` does not need to be changed and we can safely use `alloc.dealloc` later
3440        // - the original vector was cleared, so there is no problem with "transmuting" the stored values
3441        unsafe { Vec::from_parts_in(ptr.cast::<U>(), length, capacity, alloc) }
3442    }
3443}
3444
3445/// Denotes that an allocation of `From` can be recycled into an allocation of `Self`.
3446///
3447/// # Safety
3448///
3449/// `Self` is `Recyclable<From>` if `Layout::new::<Self>() == Layout::new::<From>()`.
3450unsafe trait Recyclable<From: Sized>: Sized {}
3451
3452#[unstable_feature_bound(transmutability)]
3453// SAFETY: enforced by `TransmuteFrom`
3454unsafe impl<From, To> Recyclable<From> for To
3455where
3456    for<'a> &'a MaybeUninit<To>: TransmuteFrom<&'a MaybeUninit<From>, { Assume::SAFETY }>,
3457    for<'a> &'a MaybeUninit<From>: TransmuteFrom<&'a MaybeUninit<To>, { Assume::SAFETY }>,
3458{
3459}
3460
3461impl<T: Clone, A: Allocator> Vec<T, A> {
3462    /// Resizes the `Vec` in-place so that `len` is equal to `new_len`.
3463    ///
3464    /// If `new_len` is greater than `len`, the `Vec` is extended by the
3465    /// difference, with each additional slot filled with `value`.
3466    /// If `new_len` is less than `len`, the `Vec` is simply truncated.
3467    ///
3468    /// This method requires `T` to implement [`Clone`],
3469    /// in order to be able to clone the passed value.
3470    /// If you need more flexibility (or want to rely on [`Default`] instead of
3471    /// [`Clone`]), use [`Vec::resize_with`].
3472    /// If you only need to resize to a smaller size, use [`Vec::truncate`].
3473    ///
3474    /// # Panics
3475    ///
3476    /// Panics if the new capacity exceeds `isize::MAX` _bytes_.
3477    ///
3478    /// # Examples
3479    ///
3480    /// ```
3481    /// let mut vec = vec!["hello"];
3482    /// vec.resize(3, "world");
3483    /// assert_eq!(vec, ["hello", "world", "world"]);
3484    ///
3485    /// let mut vec = vec!['a', 'b', 'c', 'd'];
3486    /// vec.resize(2, '_');
3487    /// assert_eq!(vec, ['a', 'b']);
3488    /// ```
3489    #[cfg(not(no_global_oom_handling))]
3490    #[stable(feature = "vec_resize", since = "1.5.0")]
3491    pub fn resize(&mut self, new_len: usize, value: T) {
3492        let len = self.len();
3493
3494        if new_len > len {
3495            self.extend_with(new_len - len, value)
3496        } else {
3497            self.truncate(new_len);
3498        }
3499    }
3500
3501    /// Clones and appends all elements in a slice to the `Vec`.
3502    ///
3503    /// Iterates over the slice `other`, clones each element, and then appends
3504    /// it to this `Vec`. The `other` slice is traversed in-order.
3505    ///
3506    /// Note that this function is the same as [`extend`],
3507    /// except that it also works with slice elements that are Clone but not Copy.
3508    /// If Rust gets specialization this function may be deprecated.
3509    ///
3510    /// # Panics
3511    ///
3512    /// Panics if the new capacity exceeds `isize::MAX` _bytes_.
3513    ///
3514    /// # Examples
3515    ///
3516    /// ```
3517    /// let mut vec = vec![1];
3518    /// vec.extend_from_slice(&[2, 3, 4]);
3519    /// assert_eq!(vec, [1, 2, 3, 4]);
3520    /// ```
3521    ///
3522    /// [`extend`]: Vec::extend
3523    #[cfg(not(no_global_oom_handling))]
3524    #[stable(feature = "vec_extend_from_slice", since = "1.6.0")]
3525    pub fn extend_from_slice(&mut self, other: &[T]) {
3526        self.spec_extend(other.iter())
3527    }
3528
3529    /// Given a range `src`, clones a slice of elements in that range and appends it to the end.
3530    ///
3531    /// `src` must be a range that can form a valid subslice of the `Vec`.
3532    ///
3533    /// # Panics
3534    ///
3535    /// Panics if starting index is greater than the end index, if the index is
3536    /// greater than the length of the vector, or if the new capacity exceeds
3537    /// `isize::MAX` _bytes_.
3538    ///
3539    /// # Examples
3540    ///
3541    /// ```
3542    /// let mut characters = vec!['a', 'b', 'c', 'd', 'e'];
3543    /// characters.extend_from_within(2..);
3544    /// assert_eq!(characters, ['a', 'b', 'c', 'd', 'e', 'c', 'd', 'e']);
3545    ///
3546    /// let mut numbers = vec![0, 1, 2, 3, 4];
3547    /// numbers.extend_from_within(..2);
3548    /// assert_eq!(numbers, [0, 1, 2, 3, 4, 0, 1]);
3549    ///
3550    /// let mut strings = vec![String::from("hello"), String::from("world"), String::from("!")];
3551    /// strings.extend_from_within(1..=2);
3552    /// assert_eq!(strings, ["hello", "world", "!", "world", "!"]);
3553    /// ```
3554    #[cfg(not(no_global_oom_handling))]
3555    #[stable(feature = "vec_extend_from_within", since = "1.53.0")]
3556    pub fn extend_from_within<R>(&mut self, src: R)
3557    where
3558        R: RangeBounds<usize>,
3559    {
3560        let range = slice::range(src, ..self.len());
3561        self.reserve(range.len());
3562
3563        // SAFETY:
3564        // - `slice::range` guarantees that the given range is valid for indexing self
3565        unsafe {
3566            self.spec_extend_from_within(range);
3567        }
3568    }
3569}
3570
3571impl<T, A: Allocator, const N: usize> Vec<[T; N], A> {
3572    /// Takes a `Vec<[T; N]>` and flattens it into a `Vec<T>`.
3573    ///
3574    /// # Panics
3575    ///
3576    /// Panics if the length of the resulting vector would overflow a `usize`.
3577    ///
3578    /// This is only possible when flattening a vector of arrays of zero-sized
3579    /// types, and thus tends to be irrelevant in practice. If
3580    /// `size_of::<T>() > 0`, this will never panic.
3581    ///
3582    /// # Examples
3583    ///
3584    /// ```
3585    /// let mut vec = vec![[1, 2, 3], [4, 5, 6], [7, 8, 9]];
3586    /// assert_eq!(vec.pop(), Some([7, 8, 9]));
3587    ///
3588    /// let mut flattened = vec.into_flattened();
3589    /// assert_eq!(flattened.pop(), Some(6));
3590    /// ```
3591    #[stable(feature = "slice_flatten", since = "1.80.0")]
3592    pub fn into_flattened(self) -> Vec<T, A> {
3593        let (ptr, len, cap, alloc) = self.into_raw_parts_with_alloc();
3594        let (new_len, new_cap) = if T::IS_ZST {
3595            (len.checked_mul(N).expect("vec len overflow"), usize::MAX)
3596        } else {
3597            // SAFETY:
3598            // - `cap * N` cannot overflow because the allocation is already in
3599            // the address space.
3600            // - Each `[T; N]` has `N` valid elements, so there are `len * N`
3601            // valid elements in the allocation.
3602            unsafe { (len.unchecked_mul(N), cap.unchecked_mul(N)) }
3603        };
3604        // SAFETY:
3605        // - `ptr` was allocated by `self`
3606        // - `ptr` is well-aligned because `[T; N]` has the same alignment as `T`.
3607        // - `new_cap` refers to the same sized allocation as `cap` because
3608        // `new_cap * size_of::<T>()` == `cap * size_of::<[T; N]>()`
3609        // - `len` <= `cap`, so `len * N` <= `cap * N`.
3610        unsafe { Vec::<T, A>::from_raw_parts_in(ptr.cast(), new_len, new_cap, alloc) }
3611    }
3612}
3613
3614impl<T: Clone, A: Allocator> Vec<T, A> {
3615    #[cfg(not(no_global_oom_handling))]
3616    /// Extend the vector by `n` clones of value.
3617    fn extend_with(&mut self, n: usize, value: T) {
3618        self.reserve(n);
3619
3620        unsafe {
3621            let mut ptr = self.as_mut_ptr().add(self.len());
3622            // Use SetLenOnDrop to work around bug where compiler
3623            // might not realize the store through `ptr` through self.set_len()
3624            // don't alias.
3625            let mut local_len = SetLenOnDrop::new(&mut self.len);
3626
3627            // Write all elements except the last one
3628            for _ in 1..n {
3629                ptr::write(ptr, value.clone());
3630                ptr = ptr.add(1);
3631                // Increment the length in every step in case clone() panics
3632                local_len.increment_len(1);
3633            }
3634
3635            if n > 0 {
3636                // We can write the last element directly without cloning needlessly
3637                ptr::write(ptr, value);
3638                local_len.increment_len(1);
3639            }
3640
3641            // len set by scope guard
3642        }
3643    }
3644}
3645
3646impl<T: PartialEq, A: Allocator> Vec<T, A> {
3647    /// Removes consecutive repeated elements in the vector according to the
3648    /// [`PartialEq`] trait implementation.
3649    ///
3650    /// If the vector is sorted, this removes all duplicates.
3651    ///
3652    /// # Examples
3653    ///
3654    /// ```
3655    /// let mut vec = vec![1, 2, 2, 3, 2];
3656    ///
3657    /// vec.dedup();
3658    ///
3659    /// assert_eq!(vec, [1, 2, 3, 2]);
3660    /// ```
3661    #[stable(feature = "rust1", since = "1.0.0")]
3662    #[inline]
3663    pub fn dedup(&mut self) {
3664        self.dedup_by(|a, b| a == b)
3665    }
3666}
3667
3668////////////////////////////////////////////////////////////////////////////////
3669// Internal methods and functions
3670////////////////////////////////////////////////////////////////////////////////
3671
3672#[doc(hidden)]
3673#[cfg(not(no_global_oom_handling))]
3674#[stable(feature = "rust1", since = "1.0.0")]
3675#[rustc_diagnostic_item = "vec_from_elem"]
3676pub fn from_elem<T: Clone>(elem: T, n: usize) -> Vec<T> {
3677    <T as SpecFromElem>::from_elem(elem, n, Global)
3678}
3679
3680#[doc(hidden)]
3681#[cfg(not(no_global_oom_handling))]
3682#[unstable(feature = "allocator_api", issue = "32838")]
3683pub fn from_elem_in<T: Clone, A: Allocator>(elem: T, n: usize, alloc: A) -> Vec<T, A> {
3684    <T as SpecFromElem>::from_elem(elem, n, alloc)
3685}
3686
3687#[cfg(not(no_global_oom_handling))]
3688trait ExtendFromWithinSpec {
3689    /// # Safety
3690    ///
3691    /// - `src` needs to be valid index
3692    /// - `self.capacity() - self.len()` must be `>= src.len()`
3693    unsafe fn spec_extend_from_within(&mut self, src: Range<usize>);
3694}
3695
3696#[cfg(not(no_global_oom_handling))]
3697impl<T: Clone, A: Allocator> ExtendFromWithinSpec for Vec<T, A> {
3698    default unsafe fn spec_extend_from_within(&mut self, src: Range<usize>) {
3699        // SAFETY:
3700        // - len is increased only after initializing elements
3701        let (this, spare, len) = unsafe { self.split_at_spare_mut_with_len() };
3702
3703        // SAFETY:
3704        // - caller guarantees that src is a valid index
3705        let to_clone = unsafe { this.get_unchecked(src) };
3706
3707        iter::zip(to_clone, spare)
3708            .map(|(src, dst)| dst.write(src.clone()))
3709            // Note:
3710            // - Element was just initialized with `MaybeUninit::write`, so it's ok to increase len
3711            // - len is increased after each element to prevent leaks (see issue #82533)
3712            .for_each(|_| *len += 1);
3713    }
3714}
3715
3716#[cfg(not(no_global_oom_handling))]
3717impl<T: TrivialClone, A: Allocator> ExtendFromWithinSpec for Vec<T, A> {
3718    unsafe fn spec_extend_from_within(&mut self, src: Range<usize>) {
3719        let count = src.len();
3720        {
3721            let (init, spare) = self.split_at_spare_mut();
3722
3723            // SAFETY:
3724            // - caller guarantees that `src` is a valid index
3725            let source = unsafe { init.get_unchecked(src) };
3726
3727            // SAFETY:
3728            // - Both pointers are created from unique slice references (`&mut [_]`)
3729            //   so they are valid and do not overlap.
3730            // - Elements implement `TrivialClone` so this is equivalent to calling
3731            //   `clone` on every one of them.
3732            // - `count` is equal to the len of `source`, so source is valid for
3733            //   `count` reads
3734            // - `.reserve(count)` guarantees that `spare.len() >= count` so spare
3735            //   is valid for `count` writes
3736            unsafe { ptr::copy_nonoverlapping(source.as_ptr(), spare.as_mut_ptr() as _, count) };
3737        }
3738
3739        // SAFETY:
3740        // - The elements were just initialized by `copy_nonoverlapping`
3741        self.len += count;
3742    }
3743}
3744
3745////////////////////////////////////////////////////////////////////////////////
3746// Common trait implementations for Vec
3747////////////////////////////////////////////////////////////////////////////////
3748
3749#[stable(feature = "rust1", since = "1.0.0")]
3750impl<T, A: Allocator> ops::Deref for Vec<T, A> {
3751    type Target = [T];
3752
3753    #[inline]
3754    fn deref(&self) -> &[T] {
3755        self.as_slice()
3756    }
3757}
3758
3759#[stable(feature = "rust1", since = "1.0.0")]
3760impl<T, A: Allocator> ops::DerefMut for Vec<T, A> {
3761    #[inline]
3762    fn deref_mut(&mut self) -> &mut [T] {
3763        self.as_mut_slice()
3764    }
3765}
3766
3767#[unstable(feature = "deref_pure_trait", issue = "87121")]
3768unsafe impl<T, A: Allocator> ops::DerefPure for Vec<T, A> {}
3769
3770#[cfg(not(no_global_oom_handling))]
3771#[stable(feature = "rust1", since = "1.0.0")]
3772impl<T: Clone, A: Allocator + Clone> Clone for Vec<T, A> {
3773    fn clone(&self) -> Self {
3774        let alloc = self.allocator().clone();
3775        <[T]>::to_vec_in(&**self, alloc)
3776    }
3777
3778    /// Overwrites the contents of `self` with a clone of the contents of `source`.
3779    ///
3780    /// This method is preferred over simply assigning `source.clone()` to `self`,
3781    /// as it avoids reallocation if possible. Additionally, if the element type
3782    /// `T` overrides `clone_from()`, this will reuse the resources of `self`'s
3783    /// elements as well.
3784    ///
3785    /// # Examples
3786    ///
3787    /// ```
3788    /// let x = vec![5, 6, 7];
3789    /// let mut y = vec![8, 9, 10];
3790    /// let yp: *const i32 = y.as_ptr();
3791    ///
3792    /// y.clone_from(&x);
3793    ///
3794    /// // The value is the same
3795    /// assert_eq!(x, y);
3796    ///
3797    /// // And no reallocation occurred
3798    /// assert_eq!(yp, y.as_ptr());
3799    /// ```
3800    fn clone_from(&mut self, source: &Self) {
3801        crate::slice::SpecCloneIntoVec::clone_into(source.as_slice(), self);
3802    }
3803}
3804
3805/// The hash of a vector is the same as that of the corresponding slice,
3806/// as required by the `core::borrow::Borrow` implementation.
3807///
3808/// ```
3809/// use std::hash::BuildHasher;
3810///
3811/// let b = std::hash::RandomState::new();
3812/// let v: Vec<u8> = vec![0xa8, 0x3c, 0x09];
3813/// let s: &[u8] = &[0xa8, 0x3c, 0x09];
3814/// assert_eq!(b.hash_one(v), b.hash_one(s));
3815/// ```
3816#[stable(feature = "rust1", since = "1.0.0")]
3817impl<T: Hash, A: Allocator> Hash for Vec<T, A> {
3818    #[inline]
3819    fn hash<H: Hasher>(&self, state: &mut H) {
3820        Hash::hash(&**self, state)
3821    }
3822}
3823
3824#[stable(feature = "rust1", since = "1.0.0")]
3825impl<T, I: SliceIndex<[T]>, A: Allocator> Index<I> for Vec<T, A> {
3826    type Output = I::Output;
3827
3828    #[inline]
3829    fn index(&self, index: I) -> &Self::Output {
3830        Index::index(&**self, index)
3831    }
3832}
3833
3834#[stable(feature = "rust1", since = "1.0.0")]
3835impl<T, I: SliceIndex<[T]>, A: Allocator> IndexMut<I> for Vec<T, A> {
3836    #[inline]
3837    fn index_mut(&mut self, index: I) -> &mut Self::Output {
3838        IndexMut::index_mut(&mut **self, index)
3839    }
3840}
3841
3842/// Collects an iterator into a Vec, commonly called via [`Iterator::collect()`]
3843///
3844/// # Allocation behavior
3845///
3846/// In general `Vec` does not guarantee any particular growth or allocation strategy.
3847/// That also applies to this trait impl.
3848///
3849/// **Note:** This section covers implementation details and is therefore exempt from
3850/// stability guarantees.
3851///
3852/// Vec may use any or none of the following strategies,
3853/// depending on the supplied iterator:
3854///
3855/// * preallocate based on [`Iterator::size_hint()`]
3856///   * and panic if the number of items is outside the provided lower/upper bounds
3857/// * use an amortized growth strategy similar to `pushing` one item at a time
3858/// * perform the iteration in-place on the original allocation backing the iterator
3859///
3860/// The last case warrants some attention. It is an optimization that in many cases reduces peak memory
3861/// consumption and improves cache locality. But when big, short-lived allocations are created,
3862/// only a small fraction of their items get collected, no further use is made of the spare capacity
3863/// and the resulting `Vec` is moved into a longer-lived structure, then this can lead to the large
3864/// allocations having their lifetimes unnecessarily extended which can result in increased memory
3865/// footprint.
3866///
3867/// In cases where this is an issue, the excess capacity can be discarded with [`Vec::shrink_to()`],
3868/// [`Vec::shrink_to_fit()`] or by collecting into [`Box<[T]>`][owned slice] instead, which additionally reduces
3869/// the size of the long-lived struct.
3870///
3871/// [owned slice]: Box
3872///
3873/// ```rust
3874/// # use std::sync::Mutex;
3875/// static LONG_LIVED: Mutex<Vec<Vec<u16>>> = Mutex::new(Vec::new());
3876///
3877/// for i in 0..10 {
3878///     let big_temporary: Vec<u16> = (0..1024).collect();
3879///     // discard most items
3880///     let mut result: Vec<_> = big_temporary.into_iter().filter(|i| i % 100 == 0).collect();
3881///     // without this a lot of unused capacity might be moved into the global
3882///     result.shrink_to_fit();
3883///     LONG_LIVED.lock().unwrap().push(result);
3884/// }
3885/// ```
3886#[cfg(not(no_global_oom_handling))]
3887#[stable(feature = "rust1", since = "1.0.0")]
3888impl<T> FromIterator<T> for Vec<T> {
3889    #[inline]
3890    fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Vec<T> {
3891        <Self as SpecFromIter<T, I::IntoIter>>::from_iter(iter.into_iter())
3892    }
3893}
3894
3895#[stable(feature = "rust1", since = "1.0.0")]
3896impl<T, A: Allocator> IntoIterator for Vec<T, A> {
3897    type Item = T;
3898    type IntoIter = IntoIter<T, A>;
3899
3900    /// Creates a consuming iterator, that is, one that moves each value out of
3901    /// the vector (from start to end). The vector cannot be used after calling
3902    /// this.
3903    ///
3904    /// # Examples
3905    ///
3906    /// ```
3907    /// let v = vec!["a".to_string(), "b".to_string()];
3908    /// let mut v_iter = v.into_iter();
3909    ///
3910    /// let first_element: Option<String> = v_iter.next();
3911    ///
3912    /// assert_eq!(first_element, Some("a".to_string()));
3913    /// assert_eq!(v_iter.next(), Some("b".to_string()));
3914    /// assert_eq!(v_iter.next(), None);
3915    /// ```
3916    #[inline]
3917    fn into_iter(self) -> Self::IntoIter {
3918        unsafe {
3919            let me = ManuallyDrop::new(self);
3920            let alloc = ManuallyDrop::new(ptr::read(me.allocator()));
3921            let buf = me.buf.non_null();
3922            let begin = buf.as_ptr();
3923            let end = if T::IS_ZST {
3924                begin.wrapping_byte_add(me.len())
3925            } else {
3926                begin.add(me.len()) as *const T
3927            };
3928            let cap = me.buf.capacity();
3929            IntoIter { buf, phantom: PhantomData, cap, alloc, ptr: buf, end }
3930        }
3931    }
3932}
3933
3934#[stable(feature = "rust1", since = "1.0.0")]
3935impl<'a, T, A: Allocator> IntoIterator for &'a Vec<T, A> {
3936    type Item = &'a T;
3937    type IntoIter = slice::Iter<'a, T>;
3938
3939    fn into_iter(self) -> Self::IntoIter {
3940        self.iter()
3941    }
3942}
3943
3944#[stable(feature = "rust1", since = "1.0.0")]
3945impl<'a, T, A: Allocator> IntoIterator for &'a mut Vec<T, A> {
3946    type Item = &'a mut T;
3947    type IntoIter = slice::IterMut<'a, T>;
3948
3949    fn into_iter(self) -> Self::IntoIter {
3950        self.iter_mut()
3951    }
3952}
3953
3954#[cfg(not(no_global_oom_handling))]
3955#[stable(feature = "rust1", since = "1.0.0")]
3956impl<T, A: Allocator> Extend<T> for Vec<T, A> {
3957    #[inline]
3958    fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
3959        <Self as SpecExtend<T, I::IntoIter>>::spec_extend(self, iter.into_iter())
3960    }
3961
3962    #[inline]
3963    fn extend_one(&mut self, item: T) {
3964        self.push(item);
3965    }
3966
3967    #[inline]
3968    fn extend_reserve(&mut self, additional: usize) {
3969        self.reserve(additional);
3970    }
3971
3972    #[inline]
3973    unsafe fn extend_one_unchecked(&mut self, item: T) {
3974        // SAFETY: Our preconditions ensure the space has been reserved, and `extend_reserve` is implemented correctly.
3975        unsafe {
3976            let len = self.len();
3977            ptr::write(self.as_mut_ptr().add(len), item);
3978            self.set_len(len + 1);
3979        }
3980    }
3981}
3982
3983impl<T, A: Allocator> Vec<T, A> {
3984    // leaf method to which various SpecFrom/SpecExtend implementations delegate when
3985    // they have no further optimizations to apply
3986    #[cfg(not(no_global_oom_handling))]
3987    fn extend_desugared<I: Iterator<Item = T>>(&mut self, mut iterator: I) {
3988        // This is the case for a general iterator.
3989        //
3990        // This function should be the moral equivalent of:
3991        //
3992        //      for item in iterator {
3993        //          self.push(item);
3994        //      }
3995        while let Some(element) = iterator.next() {
3996            let len = self.len();
3997            if len == self.capacity() {
3998                let (lower, _) = iterator.size_hint();
3999                self.reserve(lower.saturating_add(1));
4000            }
4001            unsafe {
4002                ptr::write(self.as_mut_ptr().add(len), element);
4003                // Since next() executes user code which can panic we have to bump the length
4004                // after each step.
4005                // NB can't overflow since we would have had to alloc the address space
4006                self.set_len(len + 1);
4007            }
4008        }
4009    }
4010
4011    // specific extend for `TrustedLen` iterators, called both by the specializations
4012    // and internal places where resolving specialization makes compilation slower
4013    #[cfg(not(no_global_oom_handling))]
4014    fn extend_trusted(&mut self, iterator: impl iter::TrustedLen<Item = T>) {
4015        let (low, high) = iterator.size_hint();
4016        if let Some(additional) = high {
4017            debug_assert_eq!(
4018                low,
4019                additional,
4020                "TrustedLen iterator's size hint is not exact: {:?}",
4021                (low, high)
4022            );
4023            self.reserve(additional);
4024            unsafe {
4025                let ptr = self.as_mut_ptr();
4026                let mut local_len = SetLenOnDrop::new(&mut self.len);
4027                iterator.for_each(move |element| {
4028                    ptr::write(ptr.add(local_len.current_len()), element);
4029                    // Since the loop executes user code which can panic we have to update
4030                    // the length every step to correctly drop what we've written.
4031                    // NB can't overflow since we would have had to alloc the address space
4032                    local_len.increment_len(1);
4033                });
4034            }
4035        } else {
4036            // Per TrustedLen contract a `None` upper bound means that the iterator length
4037            // truly exceeds usize::MAX, which would eventually lead to a capacity overflow anyway.
4038            // Since the other branch already panics eagerly (via `reserve()`) we do the same here.
4039            // This avoids additional codegen for a fallback code path which would eventually
4040            // panic anyway.
4041            panic!("capacity overflow");
4042        }
4043    }
4044
4045    /// Creates a splicing iterator that replaces the specified range in the vector
4046    /// with the given `replace_with` iterator and yields the removed items.
4047    /// `replace_with` does not need to be the same length as `range`.
4048    ///
4049    /// `range` is removed even if the `Splice` iterator is not consumed before it is dropped.
4050    ///
4051    /// It is unspecified how many elements are removed from the vector
4052    /// if the `Splice` value is leaked.
4053    ///
4054    /// The input iterator `replace_with` is only consumed when the `Splice` value is dropped.
4055    ///
4056    /// This is optimal if:
4057    ///
4058    /// * The tail (elements in the vector after `range`) is empty,
4059    /// * or `replace_with` yields fewer or equal elements than `range`'s length
4060    /// * or the lower bound of its `size_hint()` is exact.
4061    ///
4062    /// Otherwise, a temporary vector is allocated and the tail is moved twice.
4063    ///
4064    /// # Panics
4065    ///
4066    /// Panics if the range has `start_bound > end_bound`, or, if the range is
4067    /// bounded on either end and past the length of the vector.
4068    ///
4069    /// # Examples
4070    ///
4071    /// ```
4072    /// let mut v = vec![1, 2, 3, 4];
4073    /// let new = [7, 8, 9];
4074    /// let u: Vec<_> = v.splice(1..3, new).collect();
4075    /// assert_eq!(v, [1, 7, 8, 9, 4]);
4076    /// assert_eq!(u, [2, 3]);
4077    /// ```
4078    ///
4079    /// Using `splice` to insert new items into a vector efficiently at a specific position
4080    /// indicated by an empty range:
4081    ///
4082    /// ```
4083    /// let mut v = vec![1, 5];
4084    /// let new = [2, 3, 4];
4085    /// v.splice(1..1, new);
4086    /// assert_eq!(v, [1, 2, 3, 4, 5]);
4087    /// ```
4088    #[cfg(not(no_global_oom_handling))]
4089    #[inline]
4090    #[stable(feature = "vec_splice", since = "1.21.0")]
4091    pub fn splice<R, I>(&mut self, range: R, replace_with: I) -> Splice<'_, I::IntoIter, A>
4092    where
4093        R: RangeBounds<usize>,
4094        I: IntoIterator<Item = T>,
4095    {
4096        Splice { drain: self.drain(range), replace_with: replace_with.into_iter() }
4097    }
4098
4099    /// Creates an iterator which uses a closure to determine if an element in the range should be removed.
4100    ///
4101    /// If the closure returns `true`, the element is removed from the vector
4102    /// and yielded. If the closure returns `false`, or panics, the element
4103    /// remains in the vector and will not be yielded.
4104    ///
4105    /// Only elements that fall in the provided range are considered for extraction, but any elements
4106    /// after the range will still have to be moved if any element has been extracted.
4107    ///
4108    /// If the returned `ExtractIf` is not exhausted, e.g. because it is dropped without iterating
4109    /// or the iteration short-circuits, then the remaining elements will be retained.
4110    /// Use `extract_if().for_each(drop)` if you do not need the returned iterator,
4111    /// or [`retain_mut`] with a negated predicate if you also do not need to restrict the range.
4112    ///
4113    /// [`retain_mut`]: Vec::retain_mut
4114    ///
4115    /// Using this method is equivalent to the following code:
4116    ///
4117    /// ```
4118    /// # let some_predicate = |x: &mut i32| { *x % 2 == 1 };
4119    /// # let mut vec = vec![0, 1, 2, 3, 4, 5, 6];
4120    /// # let mut vec2 = vec.clone();
4121    /// # let range = 1..5;
4122    /// let mut i = range.start;
4123    /// let end_items = vec.len() - range.end;
4124    /// # let mut extracted = vec![];
4125    ///
4126    /// while i < vec.len() - end_items {
4127    ///     if some_predicate(&mut vec[i]) {
4128    ///         let val = vec.remove(i);
4129    ///         // your code here
4130    /// #         extracted.push(val);
4131    ///     } else {
4132    ///         i += 1;
4133    ///     }
4134    /// }
4135    ///
4136    /// # let extracted2: Vec<_> = vec2.extract_if(range, some_predicate).collect();
4137    /// # assert_eq!(vec, vec2);
4138    /// # assert_eq!(extracted, extracted2);
4139    /// ```
4140    ///
4141    /// But `extract_if` is easier to use. `extract_if` is also more efficient,
4142    /// because it can backshift the elements of the array in bulk.
4143    ///
4144    /// The iterator also lets you mutate the value of each element in the
4145    /// closure, regardless of whether you choose to keep or remove it.
4146    ///
4147    /// # Panics
4148    ///
4149    /// If `range` is out of bounds.
4150    ///
4151    /// # Examples
4152    ///
4153    /// Splitting a vector into even and odd values, reusing the original vector:
4154    ///
4155    /// ```
4156    /// let mut numbers = vec![1, 2, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15];
4157    ///
4158    /// let evens = numbers.extract_if(.., |x| *x % 2 == 0).collect::<Vec<_>>();
4159    /// let odds = numbers;
4160    ///
4161    /// assert_eq!(evens, vec![2, 4, 6, 8, 14]);
4162    /// assert_eq!(odds, vec![1, 3, 5, 9, 11, 13, 15]);
4163    /// ```
4164    ///
4165    /// Using the range argument to only process a part of the vector:
4166    ///
4167    /// ```
4168    /// let mut items = vec![0, 0, 0, 0, 0, 0, 0, 1, 2, 1, 2, 1, 2];
4169    /// let ones = items.extract_if(7.., |x| *x == 1).collect::<Vec<_>>();
4170    /// assert_eq!(items, vec![0, 0, 0, 0, 0, 0, 0, 2, 2, 2]);
4171    /// assert_eq!(ones.len(), 3);
4172    /// ```
4173    #[stable(feature = "extract_if", since = "1.87.0")]
4174    pub fn extract_if<F, R>(&mut self, range: R, filter: F) -> ExtractIf<'_, T, F, A>
4175    where
4176        F: FnMut(&mut T) -> bool,
4177        R: RangeBounds<usize>,
4178    {
4179        ExtractIf::new(self, filter, range)
4180    }
4181}
4182
4183/// Extend implementation that copies elements out of references before pushing them onto the Vec.
4184///
4185/// This implementation is specialized for slice iterators, where it uses [`copy_from_slice`] to
4186/// append the entire slice at once.
4187///
4188/// [`copy_from_slice`]: slice::copy_from_slice
4189#[cfg(not(no_global_oom_handling))]
4190#[stable(feature = "extend_ref", since = "1.2.0")]
4191impl<'a, T: Copy + 'a, A: Allocator> Extend<&'a T> for Vec<T, A> {
4192    fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I) {
4193        self.spec_extend(iter.into_iter())
4194    }
4195
4196    #[inline]
4197    fn extend_one(&mut self, &item: &'a T) {
4198        self.push(item);
4199    }
4200
4201    #[inline]
4202    fn extend_reserve(&mut self, additional: usize) {
4203        self.reserve(additional);
4204    }
4205
4206    #[inline]
4207    unsafe fn extend_one_unchecked(&mut self, &item: &'a T) {
4208        // SAFETY: Our preconditions ensure the space has been reserved, and `extend_reserve` is implemented correctly.
4209        unsafe {
4210            let len = self.len();
4211            ptr::write(self.as_mut_ptr().add(len), item);
4212            self.set_len(len + 1);
4213        }
4214    }
4215}
4216
4217/// Implements comparison of vectors, [lexicographically](Ord#lexicographical-comparison).
4218#[stable(feature = "rust1", since = "1.0.0")]
4219impl<T, A1, A2> PartialOrd<Vec<T, A2>> for Vec<T, A1>
4220where
4221    T: PartialOrd,
4222    A1: Allocator,
4223    A2: Allocator,
4224{
4225    #[inline]
4226    fn partial_cmp(&self, other: &Vec<T, A2>) -> Option<Ordering> {
4227        PartialOrd::partial_cmp(&**self, &**other)
4228    }
4229}
4230
4231#[stable(feature = "rust1", since = "1.0.0")]
4232impl<T: Eq, A: Allocator> Eq for Vec<T, A> {}
4233
4234/// Implements ordering of vectors, [lexicographically](Ord#lexicographical-comparison).
4235#[stable(feature = "rust1", since = "1.0.0")]
4236impl<T: Ord, A: Allocator> Ord for Vec<T, A> {
4237    #[inline]
4238    fn cmp(&self, other: &Self) -> Ordering {
4239        Ord::cmp(&**self, &**other)
4240    }
4241}
4242
4243#[stable(feature = "rust1", since = "1.0.0")]
4244unsafe impl<#[may_dangle] T, A: Allocator> Drop for Vec<T, A> {
4245    fn drop(&mut self) {
4246        unsafe {
4247            // use drop for [T]
4248            // use a raw slice to refer to the elements of the vector as weakest necessary type;
4249            // could avoid questions of validity in certain cases
4250            ptr::drop_in_place(ptr::slice_from_raw_parts_mut(self.as_mut_ptr(), self.len))
4251        }
4252        // RawVec handles deallocation
4253    }
4254}
4255
4256#[stable(feature = "rust1", since = "1.0.0")]
4257#[rustc_const_unstable(feature = "const_default", issue = "143894")]
4258impl<T> const Default for Vec<T> {
4259    /// Creates an empty `Vec<T>`.
4260    ///
4261    /// The vector will not allocate until elements are pushed onto it.
4262    fn default() -> Vec<T> {
4263        Vec::new()
4264    }
4265}
4266
4267#[stable(feature = "rust1", since = "1.0.0")]
4268impl<T: fmt::Debug, A: Allocator> fmt::Debug for Vec<T, A> {
4269    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4270        fmt::Debug::fmt(&**self, f)
4271    }
4272}
4273
4274#[stable(feature = "rust1", since = "1.0.0")]
4275impl<T, A: Allocator> AsRef<Vec<T, A>> for Vec<T, A> {
4276    fn as_ref(&self) -> &Vec<T, A> {
4277        self
4278    }
4279}
4280
4281#[stable(feature = "vec_as_mut", since = "1.5.0")]
4282impl<T, A: Allocator> AsMut<Vec<T, A>> for Vec<T, A> {
4283    fn as_mut(&mut self) -> &mut Vec<T, A> {
4284        self
4285    }
4286}
4287
4288#[stable(feature = "rust1", since = "1.0.0")]
4289impl<T, A: Allocator> AsRef<[T]> for Vec<T, A> {
4290    fn as_ref(&self) -> &[T] {
4291        self
4292    }
4293}
4294
4295#[stable(feature = "vec_as_mut", since = "1.5.0")]
4296impl<T, A: Allocator> AsMut<[T]> for Vec<T, A> {
4297    fn as_mut(&mut self) -> &mut [T] {
4298        self
4299    }
4300}
4301
4302#[cfg(not(no_global_oom_handling))]
4303#[stable(feature = "rust1", since = "1.0.0")]
4304impl<T: Clone> From<&[T]> for Vec<T> {
4305    /// Allocates a `Vec<T>` and fills it by cloning `s`'s items.
4306    ///
4307    /// # Examples
4308    ///
4309    /// ```
4310    /// assert_eq!(Vec::from(&[1, 2, 3][..]), vec![1, 2, 3]);
4311    /// ```
4312    fn from(s: &[T]) -> Vec<T> {
4313        s.to_vec()
4314    }
4315}
4316
4317#[cfg(not(no_global_oom_handling))]
4318#[stable(feature = "vec_from_mut", since = "1.19.0")]
4319impl<T: Clone> From<&mut [T]> for Vec<T> {
4320    /// Allocates a `Vec<T>` and fills it by cloning `s`'s items.
4321    ///
4322    /// # Examples
4323    ///
4324    /// ```
4325    /// assert_eq!(Vec::from(&mut [1, 2, 3][..]), vec![1, 2, 3]);
4326    /// ```
4327    fn from(s: &mut [T]) -> Vec<T> {
4328        s.to_vec()
4329    }
4330}
4331
4332#[cfg(not(no_global_oom_handling))]
4333#[stable(feature = "vec_from_array_ref", since = "1.74.0")]
4334impl<T: Clone, const N: usize> From<&[T; N]> for Vec<T> {
4335    /// Allocates a `Vec<T>` and fills it by cloning `s`'s items.
4336    ///
4337    /// # Examples
4338    ///
4339    /// ```
4340    /// assert_eq!(Vec::from(&[1, 2, 3]), vec![1, 2, 3]);
4341    /// ```
4342    fn from(s: &[T; N]) -> Vec<T> {
4343        Self::from(s.as_slice())
4344    }
4345}
4346
4347#[cfg(not(no_global_oom_handling))]
4348#[stable(feature = "vec_from_array_ref", since = "1.74.0")]
4349impl<T: Clone, const N: usize> From<&mut [T; N]> for Vec<T> {
4350    /// Allocates a `Vec<T>` and fills it by cloning `s`'s items.
4351    ///
4352    /// # Examples
4353    ///
4354    /// ```
4355    /// assert_eq!(Vec::from(&mut [1, 2, 3]), vec![1, 2, 3]);
4356    /// ```
4357    fn from(s: &mut [T; N]) -> Vec<T> {
4358        Self::from(s.as_mut_slice())
4359    }
4360}
4361
4362#[cfg(not(no_global_oom_handling))]
4363#[stable(feature = "vec_from_array", since = "1.44.0")]
4364impl<T, const N: usize> From<[T; N]> for Vec<T> {
4365    /// Allocates a `Vec<T>` and moves `s`'s items into it.
4366    ///
4367    /// # Examples
4368    ///
4369    /// ```
4370    /// assert_eq!(Vec::from([1, 2, 3]), vec![1, 2, 3]);
4371    /// ```
4372    fn from(s: [T; N]) -> Vec<T> {
4373        <[T]>::into_vec(Box::new(s))
4374    }
4375}
4376
4377#[stable(feature = "vec_from_cow_slice", since = "1.14.0")]
4378impl<'a, T> From<Cow<'a, [T]>> for Vec<T>
4379where
4380    [T]: ToOwned<Owned = Vec<T>>,
4381{
4382    /// Converts a clone-on-write slice into a vector.
4383    ///
4384    /// If `s` already owns a `Vec<T>`, it will be returned directly.
4385    /// If `s` is borrowing a slice, a new `Vec<T>` will be allocated and
4386    /// filled by cloning `s`'s items into it.
4387    ///
4388    /// # Examples
4389    ///
4390    /// ```
4391    /// # use std::borrow::Cow;
4392    /// let o: Cow<'_, [i32]> = Cow::Owned(vec![1, 2, 3]);
4393    /// let b: Cow<'_, [i32]> = Cow::Borrowed(&[1, 2, 3]);
4394    /// assert_eq!(Vec::from(o), Vec::from(b));
4395    /// ```
4396    fn from(s: Cow<'a, [T]>) -> Vec<T> {
4397        s.into_owned()
4398    }
4399}
4400
4401// note: test pulls in std, which causes errors here
4402#[stable(feature = "vec_from_box", since = "1.18.0")]
4403impl<T, A: Allocator> From<Box<[T], A>> for Vec<T, A> {
4404    /// Converts a boxed slice into a vector by transferring ownership of
4405    /// the existing heap allocation.
4406    ///
4407    /// # Examples
4408    ///
4409    /// ```
4410    /// let b: Box<[i32]> = vec![1, 2, 3].into_boxed_slice();
4411    /// assert_eq!(Vec::from(b), vec![1, 2, 3]);
4412    /// ```
4413    fn from(s: Box<[T], A>) -> Self {
4414        s.into_vec()
4415    }
4416}
4417
4418// note: test pulls in std, which causes errors here
4419#[cfg(not(no_global_oom_handling))]
4420#[stable(feature = "box_from_vec", since = "1.20.0")]
4421impl<T, A: Allocator> From<Vec<T, A>> for Box<[T], A> {
4422    /// Converts a vector into a boxed slice.
4423    ///
4424    /// Before doing the conversion, this method discards excess capacity like [`Vec::shrink_to_fit`].
4425    ///
4426    /// [owned slice]: Box
4427    /// [`Vec::shrink_to_fit`]: Vec::shrink_to_fit
4428    ///
4429    /// # Examples
4430    ///
4431    /// ```
4432    /// assert_eq!(Box::from(vec![1, 2, 3]), vec![1, 2, 3].into_boxed_slice());
4433    /// ```
4434    ///
4435    /// Any excess capacity is removed:
4436    /// ```
4437    /// let mut vec = Vec::with_capacity(10);
4438    /// vec.extend([1, 2, 3]);
4439    ///
4440    /// assert_eq!(Box::from(vec), vec![1, 2, 3].into_boxed_slice());
4441    /// ```
4442    fn from(v: Vec<T, A>) -> Self {
4443        v.into_boxed_slice()
4444    }
4445}
4446
4447#[cfg(not(no_global_oom_handling))]
4448#[stable(feature = "rust1", since = "1.0.0")]
4449impl From<&str> for Vec<u8> {
4450    /// Allocates a `Vec<u8>` and fills it with a UTF-8 string.
4451    ///
4452    /// # Examples
4453    ///
4454    /// ```
4455    /// assert_eq!(Vec::from("123"), vec![b'1', b'2', b'3']);
4456    /// ```
4457    fn from(s: &str) -> Vec<u8> {
4458        From::from(s.as_bytes())
4459    }
4460}
4461
4462#[stable(feature = "array_try_from_vec", since = "1.48.0")]
4463impl<T, A: Allocator, const N: usize> TryFrom<Vec<T, A>> for [T; N] {
4464    type Error = Vec<T, A>;
4465
4466    /// Gets the entire contents of the `Vec<T>` as an array,
4467    /// if its size exactly matches that of the requested array.
4468    ///
4469    /// # Examples
4470    ///
4471    /// ```
4472    /// assert_eq!(vec![1, 2, 3].try_into(), Ok([1, 2, 3]));
4473    /// assert_eq!(<Vec<i32>>::new().try_into(), Ok([]));
4474    /// ```
4475    ///
4476    /// If the length doesn't match, the input comes back in `Err`:
4477    /// ```
4478    /// let r: Result<[i32; 4], _> = (0..10).collect::<Vec<_>>().try_into();
4479    /// assert_eq!(r, Err(vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9]));
4480    /// ```
4481    ///
4482    /// If you're fine with just getting a prefix of the `Vec<T>`,
4483    /// you can call [`.truncate(N)`](Vec::truncate) first.
4484    /// ```
4485    /// let mut v = String::from("hello world").into_bytes();
4486    /// v.sort();
4487    /// v.truncate(2);
4488    /// let [a, b]: [_; 2] = v.try_into().unwrap();
4489    /// assert_eq!(a, b' ');
4490    /// assert_eq!(b, b'd');
4491    /// ```
4492    fn try_from(mut vec: Vec<T, A>) -> Result<[T; N], Vec<T, A>> {
4493        if vec.len() != N {
4494            return Err(vec);
4495        }
4496
4497        // SAFETY: `.set_len(0)` is always sound.
4498        unsafe { vec.set_len(0) };
4499
4500        // SAFETY: A `Vec`'s pointer is always aligned properly, and
4501        // the alignment the array needs is the same as the items.
4502        // We checked earlier that we have sufficient items.
4503        // The items will not double-drop as the `set_len`
4504        // tells the `Vec` not to also drop them.
4505        let array = unsafe { ptr::read(vec.as_ptr() as *const [T; N]) };
4506        Ok(array)
4507    }
4508}