library/alloc/src/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 //! [`push`]: Vec::push
  53
  54 #![stable(feature = "rust1", since = "1.0.0")]
  55
  56 #[cfg(not(no_global_oom_handling))]
  57 use core::cmp;
  58 use core::cmp::Ordering;
  59 use core::convert::TryFrom;
  60 use core::fmt;
  61 use core::hash::{Hash, Hasher};
  62 use core::intrinsics::{arith_offset, assume};
  63 use core::iter;
  64 #[cfg(not(no_global_oom_handling))]
  65 use core::iter::FromIterator;
  66 use core::marker::PhantomData;
  67 use core::mem::{self, ManuallyDrop, MaybeUninit};
  68 use core::ops::{self, Index, IndexMut, Range, RangeBounds};
  69 use core::ptr::{self, NonNull};
  70 use core::slice::{self, SliceIndex};
  71
  72 use crate::alloc::{Allocator, Global};
  73 use crate::borrow::{Cow, ToOwned};
  74 use crate::boxed::Box;
  75 use crate::collections::TryReserveError;
  76 use crate::raw_vec::RawVec;
  77
  78 #[unstable(feature = "drain_filter", reason = "recently added", issue = "43244")]
  79 pub use self::drain_filter::DrainFilter;
  80
  81 mod drain_filter;
  82
  83 #[cfg(not(no_global_oom_handling))]
  84 #[stable(feature = "vec_splice", since = "1.21.0")]
  85 pub use self::splice::Splice;
  86
  87 #[cfg(not(no_global_oom_handling))]
  88 mod splice;
  89
  90 #[stable(feature = "drain", since = "1.6.0")]
  91 pub use self::drain::Drain;
  92
  93 mod drain;
  94
  95 #[cfg(not(no_global_oom_handling))]
  96 mod cow;
  97
  98 #[cfg(not(no_global_oom_handling))]
  99 pub(crate) use self::into_iter::AsIntoIter;
 100 #[stable(feature = "rust1", since = "1.0.0")]
 101 pub use self::into_iter::IntoIter;
 102
 103 mod into_iter;
 104
 105 #[cfg(not(no_global_oom_handling))]
 106 use self::is_zero::IsZero;
 107
 108 mod is_zero;
 109
 110 #[cfg(not(no_global_oom_handling))]
 111 mod source_iter_marker;
 112
 113 mod partial_eq;
 114
 115 #[cfg(not(no_global_oom_handling))]
 116 use self::spec_from_elem::SpecFromElem;
 117
 118 #[cfg(not(no_global_oom_handling))]
 119 mod spec_from_elem;
 120
 121 #[cfg(not(no_global_oom_handling))]
 122 use self::set_len_on_drop::SetLenOnDrop;
 123
 124 #[cfg(not(no_global_oom_handling))]
 125 mod set_len_on_drop;
 126
 127 #[cfg(not(no_global_oom_handling))]
 128 use self::in_place_drop::InPlaceDrop;
 129
 130 #[cfg(not(no_global_oom_handling))]
 131 mod in_place_drop;
 132
 133 #[cfg(not(no_global_oom_handling))]
 134 use self::spec_from_iter_nested::SpecFromIterNested;
 135
 136 #[cfg(not(no_global_oom_handling))]
 137 mod spec_from_iter_nested;
 138
 139 #[cfg(not(no_global_oom_handling))]
 140 use self::spec_from_iter::SpecFromIter;
 141
 142 #[cfg(not(no_global_oom_handling))]
 143 mod spec_from_iter;
 144
 145 #[cfg(not(no_global_oom_handling))]
 146 use self::spec_extend::SpecExtend;
 147
 148 #[cfg(not(no_global_oom_handling))]
 149 mod spec_extend;
 150
 151 /// A contiguous growable array type, written as `Vec<T>`, short for 'vector'.
 152 ///
 153 /// # Examples
 154 ///
 155 /// ```
 156 /// let mut vec = Vec::new();
 157 /// vec.push(1);
 158 /// vec.push(2);
 159 ///
 160 /// assert_eq!(vec.len(), 2);
 161 /// assert_eq!(vec[0], 1);
 162 ///
 163 /// assert_eq!(vec.pop(), Some(2));
 164 /// assert_eq!(vec.len(), 1);
 165 ///
 166 /// vec[0] = 7;
 167 /// assert_eq!(vec[0], 7);
 168 ///
 169 /// vec.extend([1, 2, 3].iter().copied());
 170 ///
 171 /// for x in &vec {
 172 ///     println!("{x}");
 173 /// }
 174 /// assert_eq!(vec, [7, 1, 2, 3]);
 175 /// ```
 176 ///
 177 /// The [`vec!`] macro is provided for convenient initialization:
 178 ///
 179 /// ```
 180 /// let mut vec1 = vec![1, 2, 3];
 181 /// vec1.push(4);
 182 /// let vec2 = Vec::from([1, 2, 3, 4]);
 183 /// assert_eq!(vec1, vec2);
 184 /// ```
 185 ///
 186 /// It can also initialize each element of a `Vec<T>` with a given value.
 187 /// This may be more efficient than performing allocation and initialization
 188 /// in separate steps, especially when initializing a vector of zeros:
 189 ///
 190 /// ```
 191 /// let vec = vec![0; 5];
 192 /// assert_eq!(vec, [0, 0, 0, 0, 0]);
 193 ///
 194 /// // The following is equivalent, but potentially slower:
 195 /// let mut vec = Vec::with_capacity(5);
 196 /// vec.resize(5, 0);
 197 /// assert_eq!(vec, [0, 0, 0, 0, 0]);
 198 /// ```
 199 ///
 200 /// For more information, see
 201 /// [Capacity and Reallocation](#capacity-and-reallocation).
 202 ///
 203 /// Use a `Vec<T>` as an efficient stack:
 204 ///
 205 /// ```
 206 /// let mut stack = Vec::new();
 207 ///
 208 /// stack.push(1);
 209 /// stack.push(2);
 210 /// stack.push(3);
 211 ///
 212 /// while let Some(top) = stack.pop() {
 213 ///     // Prints 3, 2, 1
 214 ///     println!("{top}");
 215 /// }
 216 /// ```
 217 ///
 218 /// # Indexing
 219 ///
 220 /// The `Vec` type allows to access values by index, because it implements the
 221 /// [`Index`] trait. An example will be more explicit:
 222 ///
 223 /// ```
 224 /// let v = vec![0, 2, 4, 6];
 225 /// println!("{}", v[1]); // it will display '2'
 226 /// ```
 227 ///
 228 /// However be careful: if you try to access an index which isn't in the `Vec`,
 229 /// your software will panic! You cannot do this:
 230 ///
 231 /// ```should_panic
 232 /// let v = vec![0, 2, 4, 6];
 233 /// println!("{}", v[6]); // it will panic!
 234 /// ```
 235 ///
 236 /// Use [`get`] and [`get_mut`] if you want to check whether the index is in
 237 /// the `Vec`.
 238 ///
 239 /// # Slicing
 240 ///
 241 /// A `Vec` can be mutable. On the other hand, slices are read-only objects.
 242 /// To get a [slice][prim@slice], use [`&`]. Example:
 243 ///
 244 /// ```
 245 /// fn read_slice(slice: &[usize]) {
 246 ///     // ...
 247 /// }
 248 ///
 249 /// let v = vec![0, 1];
 250 /// read_slice(&v);
 251 ///
 252 /// // ... and that's all!
 253 /// // you can also do it like this:
 254 /// let u: &[usize] = &v;
 255 /// // or like this:
 256 /// let u: &[_] = &v;
 257 /// ```
 258 ///
 259 /// In Rust, it's more common to pass slices as arguments rather than vectors
 260 /// when you just want to provide read access. The same goes for [`String`] and
 261 /// [`&str`].
 262 ///
 263 /// # Capacity and reallocation
 264 ///
 265 /// The capacity of a vector is the amount of space allocated for any future
 266 /// elements that will be added onto the vector. This is not to be confused with
 267 /// the *length* of a vector, which specifies the number of actual elements
 268 /// within the vector. If a vector's length exceeds its capacity, its capacity
 269 /// will automatically be increased, but its elements will have to be
 270 /// reallocated.
 271 ///
 272 /// For example, a vector with capacity 10 and length 0 would be an empty vector
 273 /// with space for 10 more elements. Pushing 10 or fewer elements onto the
 274 /// vector will not change its capacity or cause reallocation to occur. However,
 275 /// if the vector's length is increased to 11, it will have to reallocate, which
 276 /// can be slow. For this reason, it is recommended to use [`Vec::with_capacity`]
 277 /// whenever possible to specify how big the vector is expected to get.
 278 ///
 279 /// # Guarantees
 280 ///
 281 /// Due to its incredibly fundamental nature, `Vec` makes a lot of guarantees
 282 /// about its design. This ensures that it's as low-overhead as possible in
 283 /// the general case, and can be correctly manipulated in primitive ways
 284 /// by unsafe code. Note that these guarantees refer to an unqualified `Vec<T>`.
 285 /// If additional type parameters are added (e.g., to support custom allocators),
 286 /// overriding their defaults may change the behavior.
 287 ///
 288 /// Most fundamentally, `Vec` is and always will be a (pointer, capacity, length)
 289 /// triplet. No more, no less. The order of these fields is completely
 290 /// unspecified, and you should use the appropriate methods to modify these.
 291 /// The pointer will never be null, so this type is null-pointer-optimized.
 292 ///
 293 /// However, the pointer might not actually point to allocated memory. In particular,
 294 /// if you construct a `Vec` with capacity 0 via [`Vec::new`], [`vec![]`][`vec!`],
 295 /// [`Vec::with_capacity(0)`][`Vec::with_capacity`], or by calling [`shrink_to_fit`]
 296 /// on an empty Vec, it will not allocate memory. Similarly, if you store zero-sized
 297 /// types inside a `Vec`, it will not allocate space for them. *Note that in this case
 298 /// the `Vec` might not report a [`capacity`] of 0*. `Vec` will allocate if and only
 299 /// if <code>[mem::size_of::\<T>]\() * [capacity]\() > 0</code>. In general, `Vec`'s allocation
 300 /// details are very subtle --- if you intend to allocate memory using a `Vec`
 301 /// and use it for something else (either to pass to unsafe code, or to build your
 302 /// own memory-backed collection), be sure to deallocate this memory by using
 303 /// `from_raw_parts` to recover the `Vec` and then dropping it.
 304 ///
 305 /// If a `Vec` *has* allocated memory, then the memory it points to is on the heap
 306 /// (as defined by the allocator Rust is configured to use by default), and its
 307 /// pointer points to [`len`] initialized, contiguous elements in order (what
 308 /// you would see if you coerced it to a slice), followed by <code>[capacity] - [len]</code>
 309 /// logically uninitialized, contiguous elements.
 310 ///
 311 /// A vector containing the elements `'a'` and `'b'` with capacity 4 can be
 312 /// visualized as below. The top part is the `Vec` struct, it contains a
 313 /// pointer to the head of the allocation in the heap, length and capacity.
 314 /// The bottom part is the allocation on the heap, a contiguous memory block.
 315 ///
 316 /// ```text
 317 ///             ptr      len  capacity
 318 ///        +--------+--------+--------+
 319 ///        | 0x0123 |      2 |      4 |
 320 ///        +--------+--------+--------+
 321 ///             |
 322 ///             v
 323 /// Heap   +--------+--------+--------+--------+
 324 ///        |    'a' |    'b' | uninit | uninit |
 325 ///        +--------+--------+--------+--------+
 326 /// ```
 327 ///
 328 /// - **uninit** represents memory that is not initialized, see [`MaybeUninit`].
 329 /// - Note: the ABI is not stable and `Vec` makes no guarantees about its memory
 330 ///   layout (including the order of fields).
 331 ///
 332 /// `Vec` will never perform a "small optimization" where elements are actually
 333 /// stored on the stack for two reasons:
 334 ///
 335 /// * It would make it more difficult for unsafe code to correctly manipulate
 336 ///   a `Vec`. The contents of a `Vec` wouldn't have a stable address if it were
 337 ///   only moved, and it would be more difficult to determine if a `Vec` had
 338 ///   actually allocated memory.
 339 ///
 340 /// * It would penalize the general case, incurring an additional branch
 341 ///   on every access.
 342 ///
 343 /// `Vec` will never automatically shrink itself, even if completely empty. This
 344 /// ensures no unnecessary allocations or deallocations occur. Emptying a `Vec`
 345 /// and then filling it back up to the same [`len`] should incur no calls to
 346 /// the allocator. If you wish to free up unused memory, use
 347 /// [`shrink_to_fit`] or [`shrink_to`].
 348 ///
 349 /// [`push`] and [`insert`] will never (re)allocate if the reported capacity is
 350 /// sufficient. [`push`] and [`insert`] *will* (re)allocate if
 351 /// <code>[len] == [capacity]</code>. That is, the reported capacity is completely
 352 /// accurate, and can be relied on. It can even be used to manually free the memory
 353 /// allocated by a `Vec` if desired. Bulk insertion methods *may* reallocate, even
 354 /// when not necessary.
 355 ///
 356 /// `Vec` does not guarantee any particular growth strategy when reallocating
 357 /// when full, nor when [`reserve`] is called. The current strategy is basic
 358 /// and it may prove desirable to use a non-constant growth factor. Whatever
 359 /// strategy is used will of course guarantee *O*(1) amortized [`push`].
 360 ///
 361 /// `vec![x; n]`, `vec![a, b, c, d]`, and
 362 /// [`Vec::with_capacity(n)`][`Vec::with_capacity`], will all produce a `Vec`
 363 /// with exactly the requested capacity. If <code>[len] == [capacity]</code>,
 364 /// (as is the case for the [`vec!`] macro), then a `Vec<T>` can be converted to
 365 /// and from a [`Box<[T]>`][owned slice] without reallocating or moving the elements.
 366 ///
 367 /// `Vec` will not specifically overwrite any data that is removed from it,
 368 /// but also won't specifically preserve it. Its uninitialized memory is
 369 /// scratch space that it may use however it wants. It will generally just do
 370 /// whatever is most efficient or otherwise easy to implement. Do not rely on
 371 /// removed data to be erased for security purposes. Even if you drop a `Vec`, its
 372 /// buffer may simply be reused by another allocation. Even if you zero a `Vec`'s memory
 373 /// first, that might not actually happen because the optimizer does not consider
 374 /// this a side-effect that must be preserved. There is one case which we will
 375 /// not break, however: using `unsafe` code to write to the excess capacity,
 376 /// and then increasing the length to match, is always valid.
 377 ///
 378 /// Currently, `Vec` does not guarantee the order in which elements are dropped.
 379 /// The order has changed in the past and may change again.
 380 ///
 381 /// [`get`]: ../../std/vec/struct.Vec.html#method.get
 382 /// [`get_mut`]: ../../std/vec/struct.Vec.html#method.get_mut
 383 /// [`String`]: crate::string::String
 384 /// [`&str`]: type@str
 385 /// [`shrink_to_fit`]: Vec::shrink_to_fit
 386 /// [`shrink_to`]: Vec::shrink_to
 387 /// [capacity]: Vec::capacity
 388 /// [`capacity`]: Vec::capacity
 389 /// [mem::size_of::\<T>]: core::mem::size_of
 390 /// [len]: Vec::len
 391 /// [`len`]: Vec::len
 392 /// [`push`]: Vec::push
 393 /// [`insert`]: Vec::insert
 394 /// [`reserve`]: Vec::reserve
 395 /// [`MaybeUninit`]: core::mem::MaybeUninit
 396 /// [owned slice]: Box
 397 #[stable(feature = "rust1", since = "1.0.0")]
 398 #[cfg_attr(not(test), rustc_diagnostic_item = "Vec")]
 399 #[rustc_insignificant_dtor]
 400 pub struct Vec<T, #[unstable(feature = "allocator_api", issue = "32838")] A: Allocator = Global> {
 401     buf: RawVec<T, A>,
 402     len: usize,
 403 }
 404
 405 ////////////////////////////////////////////////////////////////////////////////
 406 // Inherent methods
 407 ////////////////////////////////////////////////////////////////////////////////
 408
 409 impl<T> Vec<T> {
 410     /// Constructs a new, empty `Vec<T>`.
 411     ///
 412     /// The vector will not allocate until elements are pushed onto it.
 413     ///
 414     /// # Examples
 415     ///
 416     /// ```
 417     /// # #![allow(unused_mut)]
 418     /// let mut vec: Vec<i32> = Vec::new();
 419     /// ```
 420     #[inline]
 421     #[rustc_const_stable(feature = "const_vec_new", since = "1.39.0")]
 422     #[stable(feature = "rust1", since = "1.0.0")]
 423     #[must_use]
 424     pub const fn new() -> Self {
 425         Vec { buf: RawVec::NEW, len: 0 }
 426     }
 427
 428     /// Constructs a new, empty `Vec<T>` with the specified capacity.
 429     ///
 430     /// The vector will be able to hold exactly `capacity` elements without
 431     /// reallocating. If `capacity` is 0, the vector will not allocate.
 432     ///
 433     /// It is important to note that although the returned vector has the
 434     /// *capacity* specified, the vector will have a zero *length*. For an
 435     /// explanation of the difference between length and capacity, see
 436     /// *[Capacity and reallocation]*.
 437     ///
 438     /// [Capacity and reallocation]: #capacity-and-reallocation
 439     ///
 440     /// # Panics
 441     ///
 442     /// Panics if the new capacity exceeds `isize::MAX` bytes.
 443     ///
 444     /// # Examples
 445     ///
 446     /// ```
 447     /// let mut vec = Vec::with_capacity(10);
 448     ///
 449     /// // The vector contains no items, even though it has capacity for more
 450     /// assert_eq!(vec.len(), 0);
 451     /// assert_eq!(vec.capacity(), 10);
 452     ///
 453     /// // These are all done without reallocating...
 454     /// for i in 0..10 {
 455     ///     vec.push(i);
 456     /// }
 457     /// assert_eq!(vec.len(), 10);
 458     /// assert_eq!(vec.capacity(), 10);
 459     ///
 460     /// // ...but this may make the vector reallocate
 461     /// vec.push(11);
 462     /// assert_eq!(vec.len(), 11);
 463     /// assert!(vec.capacity() >= 11);
 464     /// ```
 465     #[cfg(not(no_global_oom_handling))]
 466     #[inline]
 467     #[stable(feature = "rust1", since = "1.0.0")]
 468     #[must_use]
 469     pub fn with_capacity(capacity: usize) -> Self {
 470         Self::with_capacity_in(capacity, Global)
 471     }
 472
 473     /// Creates a `Vec<T>` directly from the raw components of another vector.
 474     ///
 475     /// # Safety
 476     ///
 477     /// This is highly unsafe, due to the number of invariants that aren't
 478     /// checked:
 479     ///
 480     /// * `ptr` needs to have been previously allocated via [`String`]/`Vec<T>`
 481     ///   (at least, it's highly likely to be incorrect if it wasn't).
 482     /// * `T` needs to have the same size and alignment as what `ptr` was allocated with.
 483     ///   (`T` having a less strict alignment is not sufficient, the alignment really
 484     ///   needs to be equal to satisfy the [`dealloc`] requirement that memory must be
 485     ///   allocated and deallocated with the same layout.)
 486     /// * `length` needs to be less than or equal to `capacity`.
 487     /// * `capacity` needs to be the capacity that the pointer was allocated with.
 488     ///
 489     /// Violating these may cause problems like corrupting the allocator's
 490     /// internal data structures. For example it is **not** safe
 491     /// to build a `Vec<u8>` from a pointer to a C `char` array with length `size_t`.
 492     /// It's also not safe to build one from a `Vec<u16>` and its length, because
 493     /// the allocator cares about the alignment, and these two types have different
 494     /// alignments. The buffer was allocated with alignment 2 (for `u16`), but after
 495     /// turning it into a `Vec<u8>` it'll be deallocated with alignment 1.
 496     ///
 497     /// The ownership of `ptr` is effectively transferred to the
 498     /// `Vec<T>` which may then deallocate, reallocate or change the
 499     /// contents of memory pointed to by the pointer at will. Ensure
 500     /// that nothing else uses the pointer after calling this
 501     /// function.
 502     ///
 503     /// [`String`]: crate::string::String
 504     /// [`dealloc`]: crate::alloc::GlobalAlloc::dealloc
 505     ///
 506     /// # Examples
 507     ///
 508     /// ```
 509     /// use std::ptr;
 510     /// use std::mem;
 511     ///
 512     /// let v = vec![1, 2, 3];
 513     ///
 514     // FIXME Update this when vec_into_raw_parts is stabilized
 515     /// // Prevent running `v`'s destructor so we are in complete control
 516     /// // of the allocation.
 517     /// let mut v = mem::ManuallyDrop::new(v);
 518     ///
 519     /// // Pull out the various important pieces of information about `v`
 520     /// let p = v.as_mut_ptr();
 521     /// let len = v.len();
 522     /// let cap = v.capacity();
 523     ///
 524     /// unsafe {
 525     ///     // Overwrite memory with 4, 5, 6
 526     ///     for i in 0..len as isize {
 527     ///         ptr::write(p.offset(i), 4 + i);
 528     ///     }
 529     ///
 530     ///     // Put everything back together into a Vec
 531     ///     let rebuilt = Vec::from_raw_parts(p, len, cap);
 532     ///     assert_eq!(rebuilt, [4, 5, 6]);
 533     /// }
 534     /// ```
 535     #[inline]
 536     #[stable(feature = "rust1", since = "1.0.0")]
 537     pub unsafe fn from_raw_parts(ptr: *mut T, length: usize, capacity: usize) -> Self {
 538         unsafe { Self::from_raw_parts_in(ptr, length, capacity, Global) }
 539     }
 540 }
 541
 542 impl<T, A: Allocator> Vec<T, A> {
 543     /// Constructs a new, empty `Vec<T, A>`.
 544     ///
 545     /// The vector will not allocate until elements are pushed onto it.
 546     ///
 547     /// # Examples
 548     ///
 549     /// ```
 550     /// #![feature(allocator_api)]
 551     ///
 552     /// use std::alloc::System;
 553     ///
 554     /// # #[allow(unused_mut)]
 555     /// let mut vec: Vec<i32, _> = Vec::new_in(System);
 556     /// ```
 557     #[inline]
 558     #[unstable(feature = "allocator_api", issue = "32838")]
 559     pub const fn new_in(alloc: A) -> Self {
 560         Vec { buf: RawVec::new_in(alloc), len: 0 }
 561     }
 562
 563     /// Constructs a new, empty `Vec<T, A>` with the specified capacity with the provided
 564     /// allocator.
 565     ///
 566     /// The vector will be able to hold exactly `capacity` elements without
 567     /// reallocating. If `capacity` is 0, the vector will not allocate.
 568     ///
 569     /// It is important to note that although the returned vector has the
 570     /// *capacity* specified, the vector will have a zero *length*. For an
 571     /// explanation of the difference between length and capacity, see
 572     /// *[Capacity and reallocation]*.
 573     ///
 574     /// [Capacity and reallocation]: #capacity-and-reallocation
 575     ///
 576     /// # Panics
 577     ///
 578     /// Panics if the new capacity exceeds `isize::MAX` bytes.
 579     ///
 580     /// # Examples
 581     ///
 582     /// ```
 583     /// #![feature(allocator_api)]
 584     ///
 585     /// use std::alloc::System;
 586     ///
 587     /// let mut vec = Vec::with_capacity_in(10, System);
 588     ///
 589     /// // The vector contains no items, even though it has capacity for more
 590     /// assert_eq!(vec.len(), 0);
 591     /// assert_eq!(vec.capacity(), 10);
 592     ///
 593     /// // These are all done without reallocating...
 594     /// for i in 0..10 {
 595     ///     vec.push(i);
 596     /// }
 597     /// assert_eq!(vec.len(), 10);
 598     /// assert_eq!(vec.capacity(), 10);
 599     ///
 600     /// // ...but this may make the vector reallocate
 601     /// vec.push(11);
 602     /// assert_eq!(vec.len(), 11);
 603     /// assert!(vec.capacity() >= 11);
 604     /// ```
 605     #[cfg(not(no_global_oom_handling))]
 606     #[inline]
 607     #[unstable(feature = "allocator_api", issue = "32838")]
 608     pub fn with_capacity_in(capacity: usize, alloc: A) -> Self {
 609         Vec { buf: RawVec::with_capacity_in(capacity, alloc), len: 0 }
 610     }
 611
 612     /// Creates a `Vec<T, A>` directly from the raw components of another vector.
 613     ///
 614     /// # Safety
 615     ///
 616     /// This is highly unsafe, due to the number of invariants that aren't
 617     /// checked:
 618     ///
 619     /// * `ptr` needs to have been previously allocated via [`String`]/`Vec<T>`
 620     ///   (at least, it's highly likely to be incorrect if it wasn't).
 621     /// * `T` needs to have the same size and alignment as what `ptr` was allocated with.
 622     ///   (`T` having a less strict alignment is not sufficient, the alignment really
 623     ///   needs to be equal to satisfy the [`dealloc`] requirement that memory must be
 624     ///   allocated and deallocated with the same layout.)
 625     /// * `length` needs to be less than or equal to `capacity`.
 626     /// * `capacity` needs to be the capacity that the pointer was allocated with.
 627     ///
 628     /// Violating these may cause problems like corrupting the allocator's
 629     /// internal data structures. For example it is **not** safe
 630     /// to build a `Vec<u8>` from a pointer to a C `char` array with length `size_t`.
 631     /// It's also not safe to build one from a `Vec<u16>` and its length, because
 632     /// the allocator cares about the alignment, and these two types have different
 633     /// alignments. The buffer was allocated with alignment 2 (for `u16`), but after
 634     /// turning it into a `Vec<u8>` it'll be deallocated with alignment 1.
 635     ///
 636     /// The ownership of `ptr` is effectively transferred to the
 637     /// `Vec<T>` which may then deallocate, reallocate or change the
 638     /// contents of memory pointed to by the pointer at will. Ensure
 639     /// that nothing else uses the pointer after calling this
 640     /// function.
 641     ///
 642     /// [`String`]: crate::string::String
 643     /// [`dealloc`]: crate::alloc::GlobalAlloc::dealloc
 644     ///
 645     /// # Examples
 646     ///
 647     /// ```
 648     /// #![feature(allocator_api)]
 649     ///
 650     /// use std::alloc::System;
 651     ///
 652     /// use std::ptr;
 653     /// use std::mem;
 654     ///
 655     /// let mut v = Vec::with_capacity_in(3, System);
 656     /// v.push(1);
 657     /// v.push(2);
 658     /// v.push(3);
 659     ///
 660     // FIXME Update this when vec_into_raw_parts is stabilized
 661     /// // Prevent running `v`'s destructor so we are in complete control
 662     /// // of the allocation.
 663     /// let mut v = mem::ManuallyDrop::new(v);
 664     ///
 665     /// // Pull out the various important pieces of information about `v`
 666     /// let p = v.as_mut_ptr();
 667     /// let len = v.len();
 668     /// let cap = v.capacity();
 669     /// let alloc = v.allocator();
 670     ///
 671     /// unsafe {
 672     ///     // Overwrite memory with 4, 5, 6
 673     ///     for i in 0..len as isize {
 674     ///         ptr::write(p.offset(i), 4 + i);
 675     ///     }
 676     ///
 677     ///     // Put everything back together into a Vec
 678     ///     let rebuilt = Vec::from_raw_parts_in(p, len, cap, alloc.clone());
 679     ///     assert_eq!(rebuilt, [4, 5, 6]);
 680     /// }
 681     /// ```
 682     #[inline]
 683     #[unstable(feature = "allocator_api", issue = "32838")]
 684     pub unsafe fn from_raw_parts_in(ptr: *mut T, length: usize, capacity: usize, alloc: A) -> Self {
 685         unsafe { Vec { buf: RawVec::from_raw_parts_in(ptr, capacity, alloc), len: length } }
 686     }
 687
 688     /// Decomposes a `Vec<T>` into its raw components.
 689     ///
 690     /// Returns the raw pointer to the underlying data, the length of
 691     /// the vector (in elements), and the allocated capacity of the
 692     /// data (in elements). These are the same arguments in the same
 693     /// order as the arguments to [`from_raw_parts`].
 694     ///
 695     /// After calling this function, the caller is responsible for the
 696     /// memory previously managed by the `Vec`. The only way to do
 697     /// this is to convert the raw pointer, length, and capacity back
 698     /// into a `Vec` with the [`from_raw_parts`] function, allowing
 699     /// the destructor to perform the cleanup.
 700     ///
 701     /// [`from_raw_parts`]: Vec::from_raw_parts
 702     ///
 703     /// # Examples
 704     ///
 705     /// ```
 706     /// #![feature(vec_into_raw_parts)]
 707     /// let v: Vec<i32> = vec![-1, 0, 1];
 708     ///
 709     /// let (ptr, len, cap) = v.into_raw_parts();
 710     ///
 711     /// let rebuilt = unsafe {
 712     ///     // We can now make changes to the components, such as
 713     ///     // transmuting the raw pointer to a compatible type.
 714     ///     let ptr = ptr as *mut u32;
 715     ///
 716     ///     Vec::from_raw_parts(ptr, len, cap)
 717     /// };
 718     /// assert_eq!(rebuilt, [4294967295, 0, 1]);
 719     /// ```
 720     #[unstable(feature = "vec_into_raw_parts", reason = "new API", issue = "65816")]
 721     pub fn into_raw_parts(self) -> (*mut T, usize, usize) {
 722         let mut me = ManuallyDrop::new(self);
 723         (me.as_mut_ptr(), me.len(), me.capacity())
 724     }
 725
 726     /// Decomposes a `Vec<T>` into its raw components.
 727     ///
 728     /// Returns the raw pointer to the underlying data, the length of the vector (in elements),
 729     /// the allocated capacity of the data (in elements), and the allocator. These are the same
 730     /// arguments in the same order as the arguments to [`from_raw_parts_in`].
 731     ///
 732     /// After calling this function, the caller is responsible for the
 733     /// memory previously managed by the `Vec`. The only way to do
 734     /// this is to convert the raw pointer, length, and capacity back
 735     /// into a `Vec` with the [`from_raw_parts_in`] function, allowing
 736     /// the destructor to perform the cleanup.
 737     ///
 738     /// [`from_raw_parts_in`]: Vec::from_raw_parts_in
 739     ///
 740     /// # Examples
 741     ///
 742     /// ```
 743     /// #![feature(allocator_api, vec_into_raw_parts)]
 744     ///
 745     /// use std::alloc::System;
 746     ///
 747     /// let mut v: Vec<i32, System> = Vec::new_in(System);
 748     /// v.push(-1);
 749     /// v.push(0);
 750     /// v.push(1);
 751     ///
 752     /// let (ptr, len, cap, alloc) = v.into_raw_parts_with_alloc();
 753     ///
 754     /// let rebuilt = unsafe {
 755     ///     // We can now make changes to the components, such as
 756     ///     // transmuting the raw pointer to a compatible type.
 757     ///     let ptr = ptr as *mut u32;
 758     ///
 759     ///     Vec::from_raw_parts_in(ptr, len, cap, alloc)
 760     /// };
 761     /// assert_eq!(rebuilt, [4294967295, 0, 1]);
 762     /// ```
 763     #[unstable(feature = "allocator_api", issue = "32838")]
 764     // #[unstable(feature = "vec_into_raw_parts", reason = "new API", issue = "65816")]
 765     pub fn into_raw_parts_with_alloc(self) -> (*mut T, usize, usize, A) {
 766         let mut me = ManuallyDrop::new(self);
 767         let len = me.len();
 768         let capacity = me.capacity();
 769         let ptr = me.as_mut_ptr();
 770         let alloc = unsafe { ptr::read(me.allocator()) };
 771         (ptr, len, capacity, alloc)
 772     }
 773
 774     /// Returns the number of elements the vector can hold without
 775     /// reallocating.
 776     ///
 777     /// # Examples
 778     ///
 779     /// ```
 780     /// let vec: Vec<i32> = Vec::with_capacity(10);
 781     /// assert_eq!(vec.capacity(), 10);
 782     /// ```
 783     #[inline]
 784     #[stable(feature = "rust1", since = "1.0.0")]
 785     pub fn capacity(&self) -> usize {
 786         self.buf.capacity()
 787     }
 788
 789     /// Reserves capacity for at least `additional` more elements to be inserted
 790     /// in the given `Vec<T>`. The collection may reserve more space to avoid
 791     /// frequent reallocations. After calling `reserve`, capacity will be
 792     /// greater than or equal to `self.len() + additional`. Does nothing if
 793     /// capacity is already sufficient.
 794     ///
 795     /// # Panics
 796     ///
 797     /// Panics if the new capacity exceeds `isize::MAX` bytes.
 798     ///
 799     /// # Examples
 800     ///
 801     /// ```
 802     /// let mut vec = vec![1];
 803     /// vec.reserve(10);
 804     /// assert!(vec.capacity() >= 11);
 805     /// ```
 806     #[cfg(not(no_global_oom_handling))]
 807     #[stable(feature = "rust1", since = "1.0.0")]
 808     pub fn reserve(&mut self, additional: usize) {
 809         self.buf.reserve(self.len, additional);
 810     }
 811
 812     /// Reserves the minimum capacity for exactly `additional` more elements to
 813     /// be inserted in the given `Vec<T>`. After calling `reserve_exact`,
 814     /// capacity will be greater than or equal to `self.len() + additional`.
 815     /// Does nothing if the capacity is already sufficient.
 816     ///
 817     /// Note that the allocator may give the collection more space than it
 818     /// requests. Therefore, capacity can not be relied upon to be precisely
 819     /// minimal. Prefer [`reserve`] if future insertions are expected.
 820     ///
 821     /// [`reserve`]: Vec::reserve
 822     ///
 823     /// # Panics
 824     ///
 825     /// Panics if the new capacity exceeds `isize::MAX` bytes.
 826     ///
 827     /// # Examples
 828     ///
 829     /// ```
 830     /// let mut vec = vec![1];
 831     /// vec.reserve_exact(10);
 832     /// assert!(vec.capacity() >= 11);
 833     /// ```
 834     #[cfg(not(no_global_oom_handling))]
 835     #[stable(feature = "rust1", since = "1.0.0")]
 836     pub fn reserve_exact(&mut self, additional: usize) {
 837         self.buf.reserve_exact(self.len, additional);
 838     }
 839
 840     /// Tries to reserve capacity for at least `additional` more elements to be inserted
 841     /// in the given `Vec<T>`. The collection may reserve more space to avoid
 842     /// frequent reallocations. After calling `try_reserve`, capacity will be
 843     /// greater than or equal to `self.len() + additional`. Does nothing if
 844     /// capacity is already sufficient.
 845     ///
 846     /// # Errors
 847     ///
 848     /// If the capacity overflows, or the allocator reports a failure, then an error
 849     /// is returned.
 850     ///
 851     /// # Examples
 852     ///
 853     /// ```
 854     /// use std::collections::TryReserveError;
 855     ///
 856     /// fn process_data(data: &[u32]) -> Result<Vec<u32>, TryReserveError> {
 857     ///     let mut output = Vec::new();
 858     ///
 859     ///     // Pre-reserve the memory, exiting if we can't
 860     ///     output.try_reserve(data.len())?;
 861     ///
 862     ///     // Now we know this can't OOM in the middle of our complex work
 863     ///     output.extend(data.iter().map(|&val| {
 864     ///         val * 2 + 5 // very complicated
 865     ///     }));
 866     ///
 867     ///     Ok(output)
 868     /// }
 869     /// # process_data(&[1, 2, 3]).expect("why is the test harness OOMing on 12 bytes?");
 870     /// ```
 871     #[stable(feature = "try_reserve", since = "1.57.0")]
 872     pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError> {
 873         self.buf.try_reserve(self.len, additional)
 874     }
 875
 876     /// Tries to reserve the minimum capacity for exactly `additional`
 877     /// elements to be inserted in the given `Vec<T>`. After calling
 878     /// `try_reserve_exact`, capacity will be greater than or equal to
 879     /// `self.len() + additional` if it returns `Ok(())`.
 880     /// Does nothing if the capacity is already sufficient.
 881     ///
 882     /// Note that the allocator may give the collection more space than it
 883     /// requests. Therefore, capacity can not be relied upon to be precisely
 884     /// minimal. Prefer [`try_reserve`] if future insertions are expected.
 885     ///
 886     /// [`try_reserve`]: Vec::try_reserve
 887     ///
 888     /// # Errors
 889     ///
 890     /// If the capacity overflows, or the allocator reports a failure, then an error
 891     /// is returned.
 892     ///
 893     /// # Examples
 894     ///
 895     /// ```
 896     /// use std::collections::TryReserveError;
 897     ///
 898     /// fn process_data(data: &[u32]) -> Result<Vec<u32>, TryReserveError> {
 899     ///     let mut output = Vec::new();
 900     ///
 901     ///     // Pre-reserve the memory, exiting if we can't
 902     ///     output.try_reserve_exact(data.len())?;
 903     ///
 904     ///     // Now we know this can't OOM in the middle of our complex work
 905     ///     output.extend(data.iter().map(|&val| {
 906     ///         val * 2 + 5 // very complicated
 907     ///     }));
 908     ///
 909     ///     Ok(output)
 910     /// }
 911     /// # process_data(&[1, 2, 3]).expect("why is the test harness OOMing on 12 bytes?");
 912     /// ```
 913     #[stable(feature = "try_reserve", since = "1.57.0")]
 914     pub fn try_reserve_exact(&mut self, additional: usize) -> Result<(), TryReserveError> {
 915         self.buf.try_reserve_exact(self.len, additional)
 916     }
 917
 918     /// Shrinks the capacity of the vector as much as possible.
 919     ///
 920     /// It will drop down as close as possible to the length but the allocator
 921     /// may still inform the vector that there is space for a few more elements.
 922     ///
 923     /// # Examples
 924     ///
 925     /// ```
 926     /// let mut vec = Vec::with_capacity(10);
 927     /// vec.extend([1, 2, 3]);
 928     /// assert_eq!(vec.capacity(), 10);
 929     /// vec.shrink_to_fit();
 930     /// assert!(vec.capacity() >= 3);
 931     /// ```
 932     #[cfg(not(no_global_oom_handling))]
 933     #[stable(feature = "rust1", since = "1.0.0")]
 934     pub fn shrink_to_fit(&mut self) {
 935         // The capacity is never less than the length, and there's nothing to do when
 936         // they are equal, so we can avoid the panic case in `RawVec::shrink_to_fit`
 937         // by only calling it with a greater capacity.
 938         if self.capacity() > self.len {
 939             self.buf.shrink_to_fit(self.len);
 940         }
 941     }
 942
 943     /// Shrinks the capacity of the vector with a lower bound.
 944     ///
 945     /// The capacity will remain at least as large as both the length
 946     /// and the supplied value.
 947     ///
 948     /// If the current capacity is less than the lower limit, this is a no-op.
 949     ///
 950     /// # Examples
 951     ///
 952     /// ```
 953     /// let mut vec = Vec::with_capacity(10);
 954     /// vec.extend([1, 2, 3]);
 955     /// assert_eq!(vec.capacity(), 10);
 956     /// vec.shrink_to(4);
 957     /// assert!(vec.capacity() >= 4);
 958     /// vec.shrink_to(0);
 959     /// assert!(vec.capacity() >= 3);
 960     /// ```
 961     #[cfg(not(no_global_oom_handling))]
 962     #[stable(feature = "shrink_to", since = "1.56.0")]
 963     pub fn shrink_to(&mut self, min_capacity: usize) {
 964         if self.capacity() > min_capacity {
 965             self.buf.shrink_to_fit(cmp::max(self.len, min_capacity));
 966         }
 967     }
 968
 969     /// Converts the vector into [`Box<[T]>`][owned slice].
 970     ///
 971     /// Note that this will drop any excess capacity.
 972     ///
 973     /// [owned slice]: Box
 974     ///
 975     /// # Examples
 976     ///
 977     /// ```
 978     /// let v = vec![1, 2, 3];
 979     ///
 980     /// let slice = v.into_boxed_slice();
 981     /// ```
 982     ///
 983     /// Any excess capacity is removed:
 984     ///
 985     /// ```
 986     /// let mut vec = Vec::with_capacity(10);
 987     /// vec.extend([1, 2, 3]);
 988     ///
 989     /// assert_eq!(vec.capacity(), 10);
 990     /// let slice = vec.into_boxed_slice();
 991     /// assert_eq!(slice.into_vec().capacity(), 3);
 992     /// ```
 993     #[cfg(not(no_global_oom_handling))]
 994     #[stable(feature = "rust1", since = "1.0.0")]
 995     pub fn into_boxed_slice(mut self) -> Box<[T], A> {
 996         unsafe {
 997             self.shrink_to_fit();
 998             let me = ManuallyDrop::new(self);
 999             let buf = ptr::read(&me.buf);
1000             let len = me.len();
1001             buf.into_box(len).assume_init()
1002         }
1003     }
1004
1005     /// Shortens the vector, keeping the first `len` elements and dropping
1006     /// the rest.
1007     ///
1008     /// If `len` is greater than the vector's current length, this has no
1009     /// effect.
1010     ///
1011     /// The [`drain`] method can emulate `truncate`, but causes the excess
1012     /// elements to be returned instead of dropped.
1013     ///
1014     /// Note that this method has no effect on the allocated capacity
1015     /// of the vector.
1016     ///
1017     /// # Examples
1018     ///
1019     /// Truncating a five element vector to two elements:
1020     ///
1021     /// ```
1022     /// let mut vec = vec![1, 2, 3, 4, 5];
1023     /// vec.truncate(2);
1024     /// assert_eq!(vec, [1, 2]);
1025     /// ```
1026     ///
1027     /// No truncation occurs when `len` is greater than the vector's current
1028     /// length:
1029     ///
1030     /// ```
1031     /// let mut vec = vec![1, 2, 3];
1032     /// vec.truncate(8);
1033     /// assert_eq!(vec, [1, 2, 3]);
1034     /// ```
1035     ///
1036     /// Truncating when `len == 0` is equivalent to calling the [`clear`]
1037     /// method.
1038     ///
1039     /// ```
1040     /// let mut vec = vec![1, 2, 3];
1041     /// vec.truncate(0);
1042     /// assert_eq!(vec, []);
1043     /// ```
1044     ///
1045     /// [`clear`]: Vec::clear
1046     /// [`drain`]: Vec::drain
1047     #[stable(feature = "rust1", since = "1.0.0")]
1048     pub fn truncate(&mut self, len: usize) {
1049         // This is safe because:
1050         //
1051         // * the slice passed to `drop_in_place` is valid; the `len > self.len`
1052         //   case avoids creating an invalid slice, and
1053         // * the `len` of the vector is shrunk before calling `drop_in_place`,
1054         //   such that no value will be dropped twice in case `drop_in_place`
1055         //   were to panic once (if it panics twice, the program aborts).
1056         unsafe {
1057             // Note: It's intentional that this is `>` and not `>=`.
1058             //       Changing it to `>=` has negative performance
1059             //       implications in some cases. See #78884 for more.
1060             if len > self.len {
1061                 return;
1062             }
1063             let remaining_len = self.len - len;
1064             let s = ptr::slice_from_raw_parts_mut(self.as_mut_ptr().add(len), remaining_len);
1065             self.len = len;
1066             ptr::drop_in_place(s);
1067         }
1068     }
1069
1070     /// Extracts a slice containing the entire vector.
1071     ///
1072     /// Equivalent to `&s[..]`.
1073     ///
1074     /// # Examples
1075     ///
1076     /// ```
1077     /// use std::io::{self, Write};
1078     /// let buffer = vec![1, 2, 3, 5, 8];
1079     /// io::sink().write(buffer.as_slice()).unwrap();
1080     /// ```
1081     #[inline]
1082     #[stable(feature = "vec_as_slice", since = "1.7.0")]
1083     pub fn as_slice(&self) -> &[T] {
1084         self
1085     }
1086
1087     /// Extracts a mutable slice of the entire vector.
1088     ///
1089     /// Equivalent to `&mut s[..]`.
1090     ///
1091     /// # Examples
1092     ///
1093     /// ```
1094     /// use std::io::{self, Read};
1095     /// let mut buffer = vec![0; 3];
1096     /// io::repeat(0b101).read_exact(buffer.as_mut_slice()).unwrap();
1097     /// ```
1098     #[inline]
1099     #[stable(feature = "vec_as_slice", since = "1.7.0")]
1100     pub fn as_mut_slice(&mut self) -> &mut [T] {
1101         self
1102     }
1103
1104     /// Returns a raw pointer to the vector's buffer.
1105     ///
1106     /// The caller must ensure that the vector outlives the pointer this
1107     /// function returns, or else it will end up pointing to garbage.
1108     /// Modifying the vector may cause its buffer to be reallocated,
1109     /// which would also make any pointers to it invalid.
1110     ///
1111     /// The caller must also ensure that the memory the pointer (non-transitively) points to
1112     /// is never written to (except inside an `UnsafeCell`) using this pointer or any pointer
1113     /// derived from it. If you need to mutate the contents of the slice, use [`as_mut_ptr`].
1114     ///
1115     /// # Examples
1116     ///
1117     /// ```
1118     /// let x = vec![1, 2, 4];
1119     /// let x_ptr = x.as_ptr();
1120     ///
1121     /// unsafe {
1122     ///     for i in 0..x.len() {
1123     ///         assert_eq!(*x_ptr.add(i), 1 << i);
1124     ///     }
1125     /// }
1126     /// ```
1127     ///
1128     /// [`as_mut_ptr`]: Vec::as_mut_ptr
1129     #[stable(feature = "vec_as_ptr", since = "1.37.0")]
1130     #[inline]
1131     pub fn as_ptr(&self) -> *const T {
1132         // We shadow the slice method of the same name to avoid going through
1133         // `deref`, which creates an intermediate reference.
1134         let ptr = self.buf.ptr();
1135         unsafe {
1136             assume(!ptr.is_null());
1137         }
1138         ptr
1139     }
1140
1141     /// Returns an unsafe mutable pointer to the vector's buffer.
1142     ///
1143     /// The caller must ensure that the vector outlives the pointer this
1144     /// function returns, or else it will end up pointing to garbage.
1145     /// Modifying the vector may cause its buffer to be reallocated,
1146     /// which would also make any pointers to it invalid.
1147     ///
1148     /// # Examples
1149     ///
1150     /// ```
1151     /// // Allocate vector big enough for 4 elements.
1152     /// let size = 4;
1153     /// let mut x: Vec<i32> = Vec::with_capacity(size);
1154     /// let x_ptr = x.as_mut_ptr();
1155     ///
1156     /// // Initialize elements via raw pointer writes, then set length.
1157     /// unsafe {
1158     ///     for i in 0..size {
1159     ///         *x_ptr.add(i) = i as i32;
1160     ///     }
1161     ///     x.set_len(size);
1162     /// }
1163     /// assert_eq!(&*x, &[0, 1, 2, 3]);
1164     /// ```
1165     #[stable(feature = "vec_as_ptr", since = "1.37.0")]
1166     #[inline]
1167     pub fn as_mut_ptr(&mut self) -> *mut T {
1168         // We shadow the slice method of the same name to avoid going through
1169         // `deref_mut`, which creates an intermediate reference.
1170         let ptr = self.buf.ptr();
1171         unsafe {
1172             assume(!ptr.is_null());
1173         }
1174         ptr
1175     }
1176
1177     /// Returns a reference to the underlying allocator.
1178     #[unstable(feature = "allocator_api", issue = "32838")]
1179     #[inline]
1180     pub fn allocator(&self) -> &A {
1181         self.buf.allocator()
1182     }
1183
1184     /// Forces the length of the vector to `new_len`.
1185     ///
1186     /// This is a low-level operation that maintains none of the normal
1187     /// invariants of the type. Normally changing the length of a vector
1188     /// is done using one of the safe operations instead, such as
1189     /// [`truncate`], [`resize`], [`extend`], or [`clear`].
1190     ///
1191     /// [`truncate`]: Vec::truncate
1192     /// [`resize`]: Vec::resize
1193     /// [`extend`]: Extend::extend
1194     /// [`clear`]: Vec::clear
1195     ///
1196     /// # Safety
1197     ///
1198     /// - `new_len` must be less than or equal to [`capacity()`].
1199     /// - The elements at `old_len..new_len` must be initialized.
1200     ///
1201     /// [`capacity()`]: Vec::capacity
1202     ///
1203     /// # Examples
1204     ///
1205     /// This method can be useful for situations in which the vector
1206     /// is serving as a buffer for other code, particularly over FFI:
1207     ///
1208     /// ```no_run
1209     /// # #![allow(dead_code)]
1210     /// # // This is just a minimal skeleton for the doc example;
1211     /// # // don't use this as a starting point for a real library.
1212     /// # pub struct StreamWrapper { strm: *mut std::ffi::c_void }
1213     /// # const Z_OK: i32 = 0;
1214     /// # extern "C" {
1215     /// #     fn deflateGetDictionary(
1216     /// #         strm: *mut std::ffi::c_void,
1217     /// #         dictionary: *mut u8,
1218     /// #         dictLength: *mut usize,
1219     /// #     ) -> i32;
1220     /// # }
1221     /// # impl StreamWrapper {
1222     /// pub fn get_dictionary(&self) -> Option<Vec<u8>> {
1223     ///     // Per the FFI method's docs, "32768 bytes is always enough".
1224     ///     let mut dict = Vec::with_capacity(32_768);
1225     ///     let mut dict_length = 0;
1226     ///     // SAFETY: When `deflateGetDictionary` returns `Z_OK`, it holds that:
1227     ///     // 1. `dict_length` elements were initialized.
1228     ///     // 2. `dict_length` <= the capacity (32_768)
1229     ///     // which makes `set_len` safe to call.
1230     ///     unsafe {
1231     ///         // Make the FFI call...
1232     ///         let r = deflateGetDictionary(self.strm, dict.as_mut_ptr(), &mut dict_length);
1233     ///         if r == Z_OK {
1234     ///             // ...and update the length to what was initialized.
1235     ///             dict.set_len(dict_length);
1236     ///             Some(dict)
1237     ///         } else {
1238     ///             None
1239     ///         }
1240     ///     }
1241     /// }
1242     /// # }
1243     /// ```
1244     ///
1245     /// While the following example is sound, there is a memory leak since
1246     /// the inner vectors were not freed prior to the `set_len` call:
1247     ///
1248     /// ```
1249     /// let mut vec = vec![vec![1, 0, 0],
1250     ///                    vec![0, 1, 0],
1251     ///                    vec![0, 0, 1]];
1252     /// // SAFETY:
1253     /// // 1. `old_len..0` is empty so no elements need to be initialized.
1254     /// // 2. `0 <= capacity` always holds whatever `capacity` is.
1255     /// unsafe {
1256     ///     vec.set_len(0);
1257     /// }
1258     /// ```
1259     ///
1260     /// Normally, here, one would use [`clear`] instead to correctly drop
1261     /// the contents and thus not leak memory.
1262     #[inline]
1263     #[stable(feature = "rust1", since = "1.0.0")]
1264     pub unsafe fn set_len(&mut self, new_len: usize) {
1265         debug_assert!(new_len <= self.capacity());
1266
1267         self.len = new_len;
1268     }
1269
1270     /// Removes an element from the vector and returns it.
1271     ///
1272     /// The removed element is replaced by the last element of the vector.
1273     ///
1274     /// This does not preserve ordering, but is *O*(1).
1275     /// If you need to preserve the element order, use [`remove`] instead.
1276     ///
1277     /// [`remove`]: Vec::remove
1278     ///
1279     /// # Panics
1280     ///
1281     /// Panics if `index` is out of bounds.
1282     ///
1283     /// # Examples
1284     ///
1285     /// ```
1286     /// let mut v = vec!["foo", "bar", "baz", "qux"];
1287     ///
1288     /// assert_eq!(v.swap_remove(1), "bar");
1289     /// assert_eq!(v, ["foo", "qux", "baz"]);
1290     ///
1291     /// assert_eq!(v.swap_remove(0), "foo");
1292     /// assert_eq!(v, ["baz", "qux"]);
1293     /// ```
1294     #[inline]
1295     #[stable(feature = "rust1", since = "1.0.0")]
1296     pub fn swap_remove(&mut self, index: usize) -> T {
1297         #[cold]
1298         #[inline(never)]
1299         fn assert_failed(index: usize, len: usize) -> ! {
1300             panic!("swap_remove index (is {index}) should be < len (is {len})");
1301         }
1302
1303         let len = self.len();
1304         if index >= len {
1305             assert_failed(index, len);
1306         }
1307         unsafe {
1308             // We replace self[index] with the last element. Note that if the
1309             // bounds check above succeeds there must be a last element (which
1310             // can be self[index] itself).
1311             let value = ptr::read(self.as_ptr().add(index));
1312             let base_ptr = self.as_mut_ptr();
1313             ptr::copy(base_ptr.add(len - 1), base_ptr.add(index), 1);
1314             self.set_len(len - 1);
1315             value
1316         }
1317     }
1318
1319     /// Inserts an element at position `index` within the vector, shifting all
1320     /// elements after it to the right.
1321     ///
1322     /// # Panics
1323     ///
1324     /// Panics if `index > len`.
1325     ///
1326     /// # Examples
1327     ///
1328     /// ```
1329     /// let mut vec = vec![1, 2, 3];
1330     /// vec.insert(1, 4);
1331     /// assert_eq!(vec, [1, 4, 2, 3]);
1332     /// vec.insert(4, 5);
1333     /// assert_eq!(vec, [1, 4, 2, 3, 5]);
1334     /// ```
1335     #[cfg(not(no_global_oom_handling))]
1336     #[stable(feature = "rust1", since = "1.0.0")]
1337     pub fn insert(&mut self, index: usize, element: T) {
1338         #[cold]
1339         #[inline(never)]
1340         fn assert_failed(index: usize, len: usize) -> ! {
1341             panic!("insertion index (is {index}) should be <= len (is {len})");
1342         }
1343
1344         let len = self.len();
1345         if index > len {
1346             assert_failed(index, len);
1347         }
1348
1349         // space for the new element
1350         if len == self.buf.capacity() {
1351             self.reserve(1);
1352         }
1353
1354         unsafe {
1355             // infallible
1356             // The spot to put the new value
1357             {
1358                 let p = self.as_mut_ptr().add(index);
1359                 // Shift everything over to make space. (Duplicating the
1360                 // `index`th element into two consecutive places.)
1361                 ptr::copy(p, p.offset(1), len - index);
1362                 // Write it in, overwriting the first copy of the `index`th
1363                 // element.
1364                 ptr::write(p, element);
1365             }
1366             self.set_len(len + 1);
1367         }
1368     }
1369
1370     /// Removes and returns the element at position `index` within the vector,
1371     /// shifting all elements after it to the left.
1372     ///
1373     /// Note: Because this shifts over the remaining elements, it has a
1374     /// worst-case performance of *O*(*n*). If you don't need the order of elements
1375     /// to be preserved, use [`swap_remove`] instead. If you'd like to remove
1376     /// elements from the beginning of the `Vec`, consider using
1377     /// [`VecDeque::pop_front`] instead.
1378     ///
1379     /// [`swap_remove`]: Vec::swap_remove
1380     /// [`VecDeque::pop_front`]: crate::collections::VecDeque::pop_front
1381     ///
1382     /// # Panics
1383     ///
1384     /// Panics if `index` is out of bounds.
1385     ///
1386     /// # Examples
1387     ///
1388     /// ```
1389     /// let mut v = vec![1, 2, 3];
1390     /// assert_eq!(v.remove(1), 2);
1391     /// assert_eq!(v, [1, 3]);
1392     /// ```
1393     #[stable(feature = "rust1", since = "1.0.0")]
1394     #[track_caller]
1395     pub fn remove(&mut self, index: usize) -> T {
1396         #[cold]
1397         #[inline(never)]
1398         #[track_caller]
1399         fn assert_failed(index: usize, len: usize) -> ! {
1400             panic!("removal index (is {index}) should be < len (is {len})");
1401         }
1402
1403         let len = self.len();
1404         if index >= len {
1405             assert_failed(index, len);
1406         }
1407         unsafe {
1408             // infallible
1409             let ret;
1410             {
1411                 // the place we are taking from.
1412                 let ptr = self.as_mut_ptr().add(index);
1413                 // copy it out, unsafely having a copy of the value on
1414                 // the stack and in the vector at the same time.
1415                 ret = ptr::read(ptr);
1416
1417                 // Shift everything down to fill in that spot.
1418                 ptr::copy(ptr.offset(1), ptr, len - index - 1);
1419             }
1420             self.set_len(len - 1);
1421             ret
1422         }
1423     }
1424
1425     /// Retains only the elements specified by the predicate.
1426     ///
1427     /// In other words, remove all elements `e` for which `f(&e)` returns `false`.
1428     /// This method operates in place, visiting each element exactly once in the
1429     /// original order, and preserves the order of the retained elements.
1430     ///
1431     /// # Examples
1432     ///
1433     /// ```
1434     /// let mut vec = vec![1, 2, 3, 4];
1435     /// vec.retain(|&x| x % 2 == 0);
1436     /// assert_eq!(vec, [2, 4]);
1437     /// ```
1438     ///
1439     /// Because the elements are visited exactly once in the original order,
1440     /// external state may be used to decide which elements to keep.
1441     ///
1442     /// ```
1443     /// let mut vec = vec![1, 2, 3, 4, 5];
1444     /// let keep = [false, true, true, false, true];
1445     /// let mut iter = keep.iter();
1446     /// vec.retain(|_| *iter.next().unwrap());
1447     /// assert_eq!(vec, [2, 3, 5]);
1448     /// ```
1449     #[stable(feature = "rust1", since = "1.0.0")]
1450     pub fn retain<F>(&mut self, mut f: F)
1451     where
1452         F: FnMut(&T) -> bool,
1453     {
1454         self.retain_mut(|elem| f(elem));
1455     }
1456
1457     /// Retains only the elements specified by the predicate, passing a mutable reference to it.
1458     ///
1459     /// In other words, remove all elements `e` such that `f(&mut e)` returns `false`.
1460     /// This method operates in place, visiting each element exactly once in the
1461     /// original order, and preserves the order of the retained elements.
1462     ///
1463     /// # Examples
1464     ///
1465     /// ```
1466     /// #![feature(vec_retain_mut)]
1467     ///
1468     /// let mut vec = vec![1, 2, 3, 4];
1469     /// vec.retain_mut(|x| if *x > 3 {
1470     ///     false
1471     /// } else {
1472     ///     *x += 1;
1473     ///     true
1474     /// });
1475     /// assert_eq!(vec, [2, 3, 4]);
1476     /// ```
1477     #[unstable(feature = "vec_retain_mut", issue = "90829")]
1478     pub fn retain_mut<F>(&mut self, mut f: F)
1479     where
1480         F: FnMut(&mut T) -> bool,
1481     {
1482         let original_len = self.len();
1483         // Avoid double drop if the drop guard is not executed,
1484         // since we may make some holes during the process.
1485         unsafe { self.set_len(0) };
1486
1487         // Vec: [Kept, Kept, Hole, Hole, Hole, Hole, Unchecked, Unchecked]
1488         //      |<-              processed len   ->| ^- next to check
1489         //                  |<-  deleted cnt     ->|
1490         //      |<-              original_len                          ->|
1491         // Kept: Elements which predicate returns true on.
1492         // Hole: Moved or dropped element slot.
1493         // Unchecked: Unchecked valid elements.
1494         //
1495         // This drop guard will be invoked when predicate or `drop` of element panicked.
1496         // It shifts unchecked elements to cover holes and `set_len` to the correct length.
1497         // In cases when predicate and `drop` never panick, it will be optimized out.
1498         struct BackshiftOnDrop<'a, T, A: Allocator> {
1499             v: &'a mut Vec<T, A>,
1500             processed_len: usize,
1501             deleted_cnt: usize,
1502             original_len: usize,
1503         }
1504
1505         impl<T, A: Allocator> Drop for BackshiftOnDrop<'_, T, A> {
1506             fn drop(&mut self) {
1507                 if self.deleted_cnt > 0 {
1508                     // SAFETY: Trailing unchecked items must be valid since we never touch them.
1509                     unsafe {
1510                         ptr::copy(
1511                             self.v.as_ptr().add(self.processed_len),
1512                             self.v.as_mut_ptr().add(self.processed_len - self.deleted_cnt),
1513                             self.original_len - self.processed_len,
1514                         );
1515                     }
1516                 }
1517                 // SAFETY: After filling holes, all items are in contiguous memory.
1518                 unsafe {
1519                     self.v.set_len(self.original_len - self.deleted_cnt);
1520                 }
1521             }
1522         }
1523
1524         let mut g = BackshiftOnDrop { v: self, processed_len: 0, deleted_cnt: 0, original_len };
1525
1526         fn process_loop<F, T, A: Allocator, const DELETED: bool>(
1527             original_len: usize,
1528             f: &mut F,
1529             g: &mut BackshiftOnDrop<'_, T, A>,
1530         ) where
1531             F: FnMut(&mut T) -> bool,
1532         {
1533             while g.processed_len != original_len {
1534                 // SAFETY: Unchecked element must be valid.
1535                 let cur = unsafe { &mut *g.v.as_mut_ptr().add(g.processed_len) };
1536                 if !f(cur) {
1537                     // Advance early to avoid double drop if `drop_in_place` panicked.
1538                     g.processed_len += 1;
1539                     g.deleted_cnt += 1;
1540                     // SAFETY: We never touch this element again after dropped.
1541                     unsafe { ptr::drop_in_place(cur) };
1542                     // We already advanced the counter.
1543                     if DELETED {
1544                         continue;
1545                     } else {
1546                         break;
1547                     }
1548                 }
1549                 if DELETED {
1550                     // SAFETY: `deleted_cnt` > 0, so the hole slot must not overlap with current element.
1551                     // We use copy for move, and never touch this element again.
1552                     unsafe {
1553                         let hole_slot = g.v.as_mut_ptr().add(g.processed_len - g.deleted_cnt);
1554                         ptr::copy_nonoverlapping(cur, hole_slot, 1);
1555                     }
1556                 }
1557                 g.processed_len += 1;
1558             }
1559         }
1560
1561         // Stage 1: Nothing was deleted.
1562         process_loop::<F, T, A, false>(original_len, &mut f, &mut g);
1563
1564         // Stage 2: Some elements were deleted.
1565         process_loop::<F, T, A, true>(original_len, &mut f, &mut g);
1566
1567         // All item are processed. This can be optimized to `set_len` by LLVM.
1568         drop(g);
1569     }
1570
1571     /// Removes all but the first of consecutive elements in the vector that resolve to the same
1572     /// key.
1573     ///
1574     /// If the vector is sorted, this removes all duplicates.
1575     ///
1576     /// # Examples
1577     ///
1578     /// ```
1579     /// let mut vec = vec![10, 20, 21, 30, 20];
1580     ///
1581     /// vec.dedup_by_key(|i| *i / 10);
1582     ///
1583     /// assert_eq!(vec, [10, 20, 30, 20]);
1584     /// ```
1585     #[stable(feature = "dedup_by", since = "1.16.0")]
1586     #[inline]
1587     pub fn dedup_by_key<F, K>(&mut self, mut key: F)
1588     where
1589         F: FnMut(&mut T) -> K,
1590         K: PartialEq,
1591     {
1592         self.dedup_by(|a, b| key(a) == key(b))
1593     }
1594
1595     /// Removes all but the first of consecutive elements in the vector satisfying a given equality
1596     /// relation.
1597     ///
1598     /// The `same_bucket` function is passed references to two elements from the vector and
1599     /// must determine if the elements compare equal. The elements are passed in opposite order
1600     /// from their order in the slice, so if `same_bucket(a, b)` returns `true`, `a` is removed.
1601     ///
1602     /// If the vector is sorted, this removes all duplicates.
1603     ///
1604     /// # Examples
1605     ///
1606     /// ```
1607     /// let mut vec = vec!["foo", "bar", "Bar", "baz", "bar"];
1608     ///
1609     /// vec.dedup_by(|a, b| a.eq_ignore_ascii_case(b));
1610     ///
1611     /// assert_eq!(vec, ["foo", "bar", "baz", "bar"]);
1612     /// ```
1613     #[stable(feature = "dedup_by", since = "1.16.0")]
1614     pub fn dedup_by<F>(&mut self, mut same_bucket: F)
1615     where
1616         F: FnMut(&mut T, &mut T) -> bool,
1617     {
1618         let len = self.len();
1619         if len <= 1 {
1620             return;
1621         }
1622
1623         /* INVARIANT: vec.len() > read >= write > write-1 >= 0 */
1624         struct FillGapOnDrop<'a, T, A: core::alloc::Allocator> {
1625             /* Offset of the element we want to check if it is duplicate */
1626             read: usize,
1627
1628             /* Offset of the place where we want to place the non-duplicate
1629              * when we find it. */
1630             write: usize,
1631
1632             /* The Vec that would need correction if `same_bucket` panicked */
1633             vec: &'a mut Vec<T, A>,
1634         }
1635
1636         impl<'a, T, A: core::alloc::Allocator> Drop for FillGapOnDrop<'a, T, A> {
1637             fn drop(&mut self) {
1638                 /* This code gets executed when `same_bucket` panics */
1639
1640                 /* SAFETY: invariant guarantees that `read - write`
1641                  * and `len - read` never overflow and that the copy is always
1642                  * in-bounds. */
1643                 unsafe {
1644                     let ptr = self.vec.as_mut_ptr();
1645                     let len = self.vec.len();
1646
1647                     /* How many items were left when `same_bucket` panicked.
1648                      * Basically vec[read..].len() */
1649                     let items_left = len.wrapping_sub(self.read);
1650
1651                     /* Pointer to first item in vec[write..write+items_left] slice */
1652                     let dropped_ptr = ptr.add(self.write);
1653                     /* Pointer to first item in vec[read..] slice */
1654                     let valid_ptr = ptr.add(self.read);
1655
1656                     /* Copy `vec[read..]` to `vec[write..write+items_left]`.
1657                      * The slices can overlap, so `copy_nonoverlapping` cannot be used */
1658                     ptr::copy(valid_ptr, dropped_ptr, items_left);
1659
1660                     /* How many items have been already dropped
1661                      * Basically vec[read..write].len() */
1662                     let dropped = self.read.wrapping_sub(self.write);
1663
1664                     self.vec.set_len(len - dropped);
1665                 }
1666             }
1667         }
1668
1669         let mut gap = FillGapOnDrop { read: 1, write: 1, vec: self };
1670         let ptr = gap.vec.as_mut_ptr();
1671
1672         /* Drop items while going through Vec, it should be more efficient than
1673          * doing slice partition_dedup + truncate */
1674
1675         /* SAFETY: Because of the invariant, read_ptr, prev_ptr and write_ptr
1676          * are always in-bounds and read_ptr never aliases prev_ptr */
1677         unsafe {
1678             while gap.read < len {
1679                 let read_ptr = ptr.add(gap.read);
1680                 let prev_ptr = ptr.add(gap.write.wrapping_sub(1));
1681
1682                 if same_bucket(&mut *read_ptr, &mut *prev_ptr) {
1683                     // Increase `gap.read` now since the drop may panic.
1684                     gap.read += 1;
1685                     /* We have found duplicate, drop it in-place */
1686                     ptr::drop_in_place(read_ptr);
1687                 } else {
1688                     let write_ptr = ptr.add(gap.write);
1689
1690                     /* Because `read_ptr` can be equal to `write_ptr`, we either
1691                      * have to use `copy` or conditional `copy_nonoverlapping`.
1692                      * Looks like the first option is faster. */
1693                     ptr::copy(read_ptr, write_ptr, 1);
1694
1695                     /* We have filled that place, so go further */
1696                     gap.write += 1;
1697                     gap.read += 1;
1698                 }
1699             }
1700
1701             /* Technically we could let `gap` clean up with its Drop, but
1702              * when `same_bucket` is guaranteed to not panic, this bloats a little
1703              * the codegen, so we just do it manually */
1704             gap.vec.set_len(gap.write);
1705             mem::forget(gap);
1706         }
1707     }
1708
1709     /// Appends an element to the back of a collection.
1710     ///
1711     /// # Panics
1712     ///
1713     /// Panics if the new capacity exceeds `isize::MAX` bytes.
1714     ///
1715     /// # Examples
1716     ///
1717     /// ```
1718     /// let mut vec = vec![1, 2];
1719     /// vec.push(3);
1720     /// assert_eq!(vec, [1, 2, 3]);
1721     /// ```
1722     #[cfg(not(no_global_oom_handling))]
1723     #[inline]
1724     #[stable(feature = "rust1", since = "1.0.0")]
1725     pub fn push(&mut self, value: T) {
1726         // This will panic or abort if we would allocate > isize::MAX bytes
1727         // or if the length increment would overflow for zero-sized types.
1728         if self.len == self.buf.capacity() {
1729             self.buf.reserve_for_push(self.len);
1730         }
1731         unsafe {
1732             let end = self.as_mut_ptr().add(self.len);
1733             ptr::write(end, value);
1734             self.len += 1;
1735         }
1736     }
1737
1738     /// Removes the last element from a vector and returns it, or [`None`] if it
1739     /// is empty.
1740     ///
1741     /// If you'd like to pop the first element, consider using
1742     /// [`VecDeque::pop_front`] instead.
1743     ///
1744     /// [`VecDeque::pop_front`]: crate::collections::VecDeque::pop_front
1745     ///
1746     /// # Examples
1747     ///
1748     /// ```
1749     /// let mut vec = vec![1, 2, 3];
1750     /// assert_eq!(vec.pop(), Some(3));
1751     /// assert_eq!(vec, [1, 2]);
1752     /// ```
1753     #[inline]
1754     #[stable(feature = "rust1", since = "1.0.0")]
1755     pub fn pop(&mut self) -> Option<T> {
1756         if self.len == 0 {
1757             None
1758         } else {
1759             unsafe {
1760                 self.len -= 1;
1761                 Some(ptr::read(self.as_ptr().add(self.len())))
1762             }
1763         }
1764     }
1765
1766     /// Moves all the elements of `other` into `self`, leaving `other` empty.
1767     ///
1768     /// # Panics
1769     ///
1770     /// Panics if the number of elements in the vector overflows a `usize`.
1771     ///
1772     /// # Examples
1773     ///
1774     /// ```
1775     /// let mut vec = vec![1, 2, 3];
1776     /// let mut vec2 = vec![4, 5, 6];
1777     /// vec.append(&mut vec2);
1778     /// assert_eq!(vec, [1, 2, 3, 4, 5, 6]);
1779     /// assert_eq!(vec2, []);
1780     /// ```
1781     #[cfg(not(no_global_oom_handling))]
1782     #[inline]
1783     #[stable(feature = "append", since = "1.4.0")]
1784     pub fn append(&mut self, other: &mut Self) {
1785         unsafe {
1786             self.append_elements(other.as_slice() as _);
1787             other.set_len(0);
1788         }
1789     }
1790
1791     /// Appends elements to `self` from other buffer.
1792     #[cfg(not(no_global_oom_handling))]
1793     #[inline]
1794     unsafe fn append_elements(&mut self, other: *const [T]) {
1795         let count = unsafe { (*other).len() };
1796         self.reserve(count);
1797         let len = self.len();
1798         unsafe { ptr::copy_nonoverlapping(other as *const T, self.as_mut_ptr().add(len), count) };
1799         self.len += count;
1800     }
1801
1802     /// Removes the specified range from the vector in bulk, returning all
1803     /// removed elements as an iterator. If the iterator is dropped before
1804     /// being fully consumed, it drops the remaining removed elements.
1805     ///
1806     /// The returned iterator keeps a mutable borrow on the vector to optimize
1807     /// its implementation.
1808     ///
1809     /// # Panics
1810     ///
1811     /// Panics if the starting point is greater than the end point or if
1812     /// the end point is greater than the length of the vector.
1813     ///
1814     /// # Leaking
1815     ///
1816     /// If the returned iterator goes out of scope without being dropped (due to
1817     /// [`mem::forget`], for example), the vector may have lost and leaked
1818     /// elements arbitrarily, including elements outside the range.
1819     ///
1820     /// # Examples
1821     ///
1822     /// ```
1823     /// let mut v = vec![1, 2, 3];
1824     /// let u: Vec<_> = v.drain(1..).collect();
1825     /// assert_eq!(v, &[1]);
1826     /// assert_eq!(u, &[2, 3]);
1827     ///
1828     /// // A full range clears the vector, like `clear()` does
1829     /// v.drain(..);
1830     /// assert_eq!(v, &[]);
1831     /// ```
1832     #[stable(feature = "drain", since = "1.6.0")]
1833     pub fn drain<R>(&mut self, range: R) -> Drain<'_, T, A>
1834     where
1835         R: RangeBounds<usize>,
1836     {
1837         // Memory safety
1838         //
1839         // When the Drain is first created, it shortens the length of
1840         // the source vector to make sure no uninitialized or moved-from elements
1841         // are accessible at all if the Drain's destructor never gets to run.
1842         //
1843         // Drain will ptr::read out the values to remove.
1844         // When finished, remaining tail of the vec is copied back to cover
1845         // the hole, and the vector length is restored to the new length.
1846         //
1847         let len = self.len();
1848         let Range { start, end } = slice::range(range, ..len);
1849
1850         unsafe {
1851             // set self.vec length's to start, to be safe in case Drain is leaked
1852             self.set_len(start);
1853             // Use the borrow in the IterMut to indicate borrowing behavior of the
1854             // whole Drain iterator (like &mut T).
1855             let range_slice = slice::from_raw_parts_mut(self.as_mut_ptr().add(start), end - start);
1856             Drain {
1857                 tail_start: end,
1858                 tail_len: len - end,
1859                 iter: range_slice.iter(),
1860                 vec: NonNull::from(self),
1861             }
1862         }
1863     }
1864
1865     /// Clears the vector, removing all values.
1866     ///
1867     /// Note that this method has no effect on the allocated capacity
1868     /// of the vector.
1869     ///
1870     /// # Examples
1871     ///
1872     /// ```
1873     /// let mut v = vec![1, 2, 3];
1874     ///
1875     /// v.clear();
1876     ///
1877     /// assert!(v.is_empty());
1878     /// ```
1879     #[inline]
1880     #[stable(feature = "rust1", since = "1.0.0")]
1881     pub fn clear(&mut self) {
1882         self.truncate(0)
1883     }
1884
1885     /// Returns the number of elements in the vector, also referred to
1886     /// as its 'length'.
1887     ///
1888     /// # Examples
1889     ///
1890     /// ```
1891     /// let a = vec![1, 2, 3];
1892     /// assert_eq!(a.len(), 3);
1893     /// ```
1894     #[inline]
1895     #[stable(feature = "rust1", since = "1.0.0")]
1896     pub fn len(&self) -> usize {
1897         self.len
1898     }
1899
1900     /// Returns `true` if the vector contains no elements.
1901     ///
1902     /// # Examples
1903     ///
1904     /// ```
1905     /// let mut v = Vec::new();
1906     /// assert!(v.is_empty());
1907     ///
1908     /// v.push(1);
1909     /// assert!(!v.is_empty());
1910     /// ```
1911     #[stable(feature = "rust1", since = "1.0.0")]
1912     pub fn is_empty(&self) -> bool {
1913         self.len() == 0
1914     }
1915
1916     /// Splits the collection into two at the given index.
1917     ///
1918     /// Returns a newly allocated vector containing the elements in the range
1919     /// `[at, len)`. After the call, the original vector will be left containing
1920     /// the elements `[0, at)` with its previous capacity unchanged.
1921     ///
1922     /// # Panics
1923     ///
1924     /// Panics if `at > len`.
1925     ///
1926     /// # Examples
1927     ///
1928     /// ```
1929     /// let mut vec = vec![1, 2, 3];
1930     /// let vec2 = vec.split_off(1);
1931     /// assert_eq!(vec, [1]);
1932     /// assert_eq!(vec2, [2, 3]);
1933     /// ```
1934     #[cfg(not(no_global_oom_handling))]
1935     #[inline]
1936     #[must_use = "use `.truncate()` if you don't need the other half"]
1937     #[stable(feature = "split_off", since = "1.4.0")]
1938     pub fn split_off(&mut self, at: usize) -> Self
1939     where
1940         A: Clone,
1941     {
1942         #[cold]
1943         #[inline(never)]
1944         fn assert_failed(at: usize, len: usize) -> ! {
1945             panic!("`at` split index (is {at}) should be <= len (is {len})");
1946         }
1947
1948         if at > self.len() {
1949             assert_failed(at, self.len());
1950         }
1951
1952         if at == 0 {
1953             // the new vector can take over the original buffer and avoid the copy
1954             return mem::replace(
1955                 self,
1956                 Vec::with_capacity_in(self.capacity(), self.allocator().clone()),
1957             );
1958         }
1959
1960         let other_len = self.len - at;
1961         let mut other = Vec::with_capacity_in(other_len, self.allocator().clone());
1962
1963         // Unsafely `set_len` and copy items to `other`.
1964         unsafe {
1965             self.set_len(at);
1966             other.set_len(other_len);
1967
1968             ptr::copy_nonoverlapping(self.as_ptr().add(at), other.as_mut_ptr(), other.len());
1969         }
1970         other
1971     }
1972
1973     /// Resizes the `Vec` in-place so that `len` is equal to `new_len`.
1974     ///
1975     /// If `new_len` is greater than `len`, the `Vec` is extended by the
1976     /// difference, with each additional slot filled with the result of
1977     /// calling the closure `f`. The return values from `f` will end up
1978     /// in the `Vec` in the order they have been generated.
1979     ///
1980     /// If `new_len` is less than `len`, the `Vec` is simply truncated.
1981     ///
1982     /// This method uses a closure to create new values on every push. If
1983     /// you'd rather [`Clone`] a given value, use [`Vec::resize`]. If you
1984     /// want to use the [`Default`] trait to generate values, you can
1985     /// pass [`Default::default`] as the second argument.
1986     ///
1987     /// # Examples
1988     ///
1989     /// ```
1990     /// let mut vec = vec![1, 2, 3];
1991     /// vec.resize_with(5, Default::default);
1992     /// assert_eq!(vec, [1, 2, 3, 0, 0]);
1993     ///
1994     /// let mut vec = vec![];
1995     /// let mut p = 1;
1996     /// vec.resize_with(4, || { p *= 2; p });
1997     /// assert_eq!(vec, [2, 4, 8, 16]);
1998     /// ```
1999     #[cfg(not(no_global_oom_handling))]
2000     #[stable(feature = "vec_resize_with", since = "1.33.0")]
2001     pub fn resize_with<F>(&mut self, new_len: usize, f: F)
2002     where
2003         F: FnMut() -> T,
2004     {
2005         let len = self.len();
2006         if new_len > len {
2007             self.extend_with(new_len - len, ExtendFunc(f));
2008         } else {
2009             self.truncate(new_len);
2010         }
2011     }
2012
2013     /// Consumes and leaks the `Vec`, returning a mutable reference to the contents,
2014     /// `&'a mut [T]`. Note that the type `T` must outlive the chosen lifetime
2015     /// `'a`. If the type has only static references, or none at all, then this
2016     /// may be chosen to be `'static`.
2017     ///
2018     /// As of Rust 1.57, this method does not reallocate or shrink the `Vec`,
2019     /// so the leaked allocation may include unused capacity that is not part
2020     /// of the returned slice.
2021     ///
2022     /// This function is mainly useful for data that lives for the remainder of
2023     /// the program's life. Dropping the returned reference will cause a memory
2024     /// leak.
2025     ///
2026     /// # Examples
2027     ///
2028     /// Simple usage:
2029     ///
2030     /// ```
2031     /// let x = vec![1, 2, 3];
2032     /// let static_ref: &'static mut [usize] = x.leak();
2033     /// static_ref[0] += 1;
2034     /// assert_eq!(static_ref, &[2, 2, 3]);
2035     /// ```
2036     #[cfg(not(no_global_oom_handling))]
2037     #[stable(feature = "vec_leak", since = "1.47.0")]
2038     #[inline]
2039     pub fn leak<'a>(self) -> &'a mut [T]
2040     where
2041         A: 'a,
2042     {
2043         let mut me = ManuallyDrop::new(self);
2044         unsafe { slice::from_raw_parts_mut(me.as_mut_ptr(), me.len) }
2045     }
2046
2047     /// Returns the remaining spare capacity of the vector as a slice of
2048     /// `MaybeUninit<T>`.
2049     ///
2050     /// The returned slice can be used to fill the vector with data (e.g. by
2051     /// reading from a file) before marking the data as initialized using the
2052     /// [`set_len`] method.
2053     ///
2054     /// [`set_len`]: Vec::set_len
2055     ///
2056     /// # Examples
2057     ///
2058     /// ```
2059     /// // Allocate vector big enough for 10 elements.
2060     /// let mut v = Vec::with_capacity(10);
2061     ///
2062     /// // Fill in the first 3 elements.
2063     /// let uninit = v.spare_capacity_mut();
2064     /// uninit[0].write(0);
2065     /// uninit[1].write(1);
2066     /// uninit[2].write(2);
2067     ///
2068     /// // Mark the first 3 elements of the vector as being initialized.
2069     /// unsafe {
2070     ///     v.set_len(3);
2071     /// }
2072     ///
2073     /// assert_eq!(&v, &[0, 1, 2]);
2074     /// ```
2075     #[stable(feature = "vec_spare_capacity", since = "1.60.0")]
2076     #[inline]
2077     pub fn spare_capacity_mut(&mut self) -> &mut [MaybeUninit<T>] {
2078         // Note:
2079         // This method is not implemented in terms of `split_at_spare_mut`,
2080         // to prevent invalidation of pointers to the buffer.
2081         unsafe {
2082             slice::from_raw_parts_mut(
2083                 self.as_mut_ptr().add(self.len) as *mut MaybeUninit<T>,
2084                 self.buf.capacity() - self.len,
2085             )
2086         }
2087     }
2088
2089     /// Returns vector content as a slice of `T`, along with the remaining spare
2090     /// capacity of the vector as a slice of `MaybeUninit<T>`.
2091     ///
2092     /// The returned spare capacity slice can be used to fill the vector with data
2093     /// (e.g. by reading from a file) before marking the data as initialized using
2094     /// the [`set_len`] method.
2095     ///
2096     /// [`set_len`]: Vec::set_len
2097     ///
2098     /// Note that this is a low-level API, which should be used with care for
2099     /// optimization purposes. If you need to append data to a `Vec`
2100     /// you can use [`push`], [`extend`], [`extend_from_slice`],
2101     /// [`extend_from_within`], [`insert`], [`append`], [`resize`] or
2102     /// [`resize_with`], depending on your exact needs.
2103     ///
2104     /// [`push`]: Vec::push
2105     /// [`extend`]: Vec::extend
2106     /// [`extend_from_slice`]: Vec::extend_from_slice
2107     /// [`extend_from_within`]: Vec::extend_from_within
2108     /// [`insert`]: Vec::insert
2109     /// [`append`]: Vec::append
2110     /// [`resize`]: Vec::resize
2111     /// [`resize_with`]: Vec::resize_with
2112     ///
2113     /// # Examples
2114     ///
2115     /// ```
2116     /// #![feature(vec_split_at_spare)]
2117     ///
2118     /// let mut v = vec![1, 1, 2];
2119     ///
2120     /// // Reserve additional space big enough for 10 elements.
2121     /// v.reserve(10);
2122     ///
2123     /// let (init, uninit) = v.split_at_spare_mut();
2124     /// let sum = init.iter().copied().sum::<u32>();
2125     ///
2126     /// // Fill in the next 4 elements.
2127     /// uninit[0].write(sum);
2128     /// uninit[1].write(sum * 2);
2129     /// uninit[2].write(sum * 3);
2130     /// uninit[3].write(sum * 4);
2131     ///
2132     /// // Mark the 4 elements of the vector as being initialized.
2133     /// unsafe {
2134     ///     let len = v.len();
2135     ///     v.set_len(len + 4);
2136     /// }
2137     ///
2138     /// assert_eq!(&v, &[1, 1, 2, 4, 8, 12, 16]);
2139     /// ```
2140     #[unstable(feature = "vec_split_at_spare", issue = "81944")]
2141     #[inline]
2142     pub fn split_at_spare_mut(&mut self) -> (&mut [T], &mut [MaybeUninit<T>]) {
2143         // SAFETY:
2144         // - len is ignored and so never changed
2145         let (init, spare, _) = unsafe { self.split_at_spare_mut_with_len() };
2146         (init, spare)
2147     }
2148
2149     /// Safety: changing returned .2 (&mut usize) is considered the same as calling `.set_len(_)`.
2150     ///
2151     /// This method provides unique access to all vec parts at once in `extend_from_within`.
2152     unsafe fn split_at_spare_mut_with_len(
2153         &mut self,
2154     ) -> (&mut [T], &mut [MaybeUninit<T>], &mut usize) {
2155         let ptr = self.as_mut_ptr();
2156         // SAFETY:
2157         // - `ptr` is guaranteed to be valid for `self.len` elements
2158         // - but the allocation extends out to `self.buf.capacity()` elements, possibly
2159         // uninitialized
2160         let spare_ptr = unsafe { ptr.add(self.len) };
2161         let spare_ptr = spare_ptr.cast::<MaybeUninit<T>>();
2162         let spare_len = self.buf.capacity() - self.len;
2163
2164         // SAFETY:
2165         // - `ptr` is guaranteed to be valid for `self.len` elements
2166         // - `spare_ptr` is pointing one element past the buffer, so it doesn't overlap with `initialized`
2167         unsafe {
2168             let initialized = slice::from_raw_parts_mut(ptr, self.len);
2169             let spare = slice::from_raw_parts_mut(spare_ptr, spare_len);
2170
2171             (initialized, spare, &mut self.len)
2172         }
2173     }
2174 }
2175
2176 impl<T: Clone, A: Allocator> Vec<T, A> {
2177     /// Resizes the `Vec` in-place so that `len` is equal to `new_len`.
2178     ///
2179     /// If `new_len` is greater than `len`, the `Vec` is extended by the
2180     /// difference, with each additional slot filled with `value`.
2181     /// If `new_len` is less than `len`, the `Vec` is simply truncated.
2182     ///
2183     /// This method requires `T` to implement [`Clone`],
2184     /// in order to be able to clone the passed value.
2185     /// If you need more flexibility (or want to rely on [`Default`] instead of
2186     /// [`Clone`]), use [`Vec::resize_with`].
2187     /// If you only need to resize to a smaller size, use [`Vec::truncate`].
2188     ///
2189     /// # Examples
2190     ///
2191     /// ```
2192     /// let mut vec = vec!["hello"];
2193     /// vec.resize(3, "world");
2194     /// assert_eq!(vec, ["hello", "world", "world"]);
2195     ///
2196     /// let mut vec = vec![1, 2, 3, 4];
2197     /// vec.resize(2, 0);
2198     /// assert_eq!(vec, [1, 2]);
2199     /// ```
2200     #[cfg(not(no_global_oom_handling))]
2201     #[stable(feature = "vec_resize", since = "1.5.0")]
2202     pub fn resize(&mut self, new_len: usize, value: T) {
2203         let len = self.len();
2204
2205         if new_len > len {
2206             self.extend_with(new_len - len, ExtendElement(value))
2207         } else {
2208             self.truncate(new_len);
2209         }
2210     }
2211
2212     /// Clones and appends all elements in a slice to the `Vec`.
2213     ///
2214     /// Iterates over the slice `other`, clones each element, and then appends
2215     /// it to this `Vec`. The `other` slice is traversed in-order.
2216     ///
2217     /// Note that this function is same as [`extend`] except that it is
2218     /// specialized to work with slices instead. If and when Rust gets
2219     /// specialization this function will likely be deprecated (but still
2220     /// available).
2221     ///
2222     /// # Examples
2223     ///
2224     /// ```
2225     /// let mut vec = vec![1];
2226     /// vec.extend_from_slice(&[2, 3, 4]);
2227     /// assert_eq!(vec, [1, 2, 3, 4]);
2228     /// ```
2229     ///
2230     /// [`extend`]: Vec::extend
2231     #[cfg(not(no_global_oom_handling))]
2232     #[stable(feature = "vec_extend_from_slice", since = "1.6.0")]
2233     pub fn extend_from_slice(&mut self, other: &[T]) {
2234         self.spec_extend(other.iter())
2235     }
2236
2237     /// Copies elements from `src` range to the end of the vector.
2238     ///
2239     /// # Panics
2240     ///
2241     /// Panics if the starting point is greater than the end point or if
2242     /// the end point is greater than the length of the vector.
2243     ///
2244     /// # Examples
2245     ///
2246     /// ```
2247     /// let mut vec = vec![0, 1, 2, 3, 4];
2248     ///
2249     /// vec.extend_from_within(2..);
2250     /// assert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4]);
2251     ///
2252     /// vec.extend_from_within(..2);
2253     /// assert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4, 0, 1]);
2254     ///
2255     /// vec.extend_from_within(4..8);
2256     /// assert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4, 0, 1, 4, 2, 3, 4]);
2257     /// ```
2258     #[cfg(not(no_global_oom_handling))]
2259     #[stable(feature = "vec_extend_from_within", since = "1.53.0")]
2260     pub fn extend_from_within<R>(&mut self, src: R)
2261     where
2262         R: RangeBounds<usize>,
2263     {
2264         let range = slice::range(src, ..self.len());
2265         self.reserve(range.len());
2266
2267         // SAFETY:
2268         // - `slice::range` guarantees  that the given range is valid for indexing self
2269         unsafe {
2270             self.spec_extend_from_within(range);
2271         }
2272     }
2273 }
2274
2275 // This code generalizes `extend_with_{element,default}`.
2276 trait ExtendWith<T> {
2277     fn next(&mut self) -> T;
2278     fn last(self) -> T;
2279 }
2280
2281 struct ExtendElement<T>(T);
2282 impl<T: Clone> ExtendWith<T> for ExtendElement<T> {
2283     fn next(&mut self) -> T {
2284         self.0.clone()
2285     }
2286     fn last(self) -> T {
2287         self.0
2288     }
2289 }
2290
2291 struct ExtendFunc<F>(F);
2292 impl<T, F: FnMut() -> T> ExtendWith<T> for ExtendFunc<F> {
2293     fn next(&mut self) -> T {
2294         (self.0)()
2295     }
2296     fn last(mut self) -> T {
2297         (self.0)()
2298     }
2299 }
2300
2301 impl<T, A: Allocator> Vec<T, A> {
2302     #[cfg(not(no_global_oom_handling))]
2303     /// Extend the vector by `n` values, using the given generator.
2304     fn extend_with<E: ExtendWith<T>>(&mut self, n: usize, mut value: E) {
2305         self.reserve(n);
2306
2307         unsafe {
2308             let mut ptr = self.as_mut_ptr().add(self.len());
2309             // Use SetLenOnDrop to work around bug where compiler
2310             // might not realize the store through `ptr` through self.set_len()
2311             // don't alias.
2312             let mut local_len = SetLenOnDrop::new(&mut self.len);
2313
2314             // Write all elements except the last one
2315             for _ in 1..n {
2316                 ptr::write(ptr, value.next());
2317                 ptr = ptr.offset(1);
2318                 // Increment the length in every step in case next() panics
2319                 local_len.increment_len(1);
2320             }
2321
2322             if n > 0 {
2323                 // We can write the last element directly without cloning needlessly
2324                 ptr::write(ptr, value.last());
2325                 local_len.increment_len(1);
2326             }
2327
2328             // len set by scope guard
2329         }
2330     }
2331 }
2332
2333 impl<T: PartialEq, A: Allocator> Vec<T, A> {
2334     /// Removes consecutive repeated elements in the vector according to the
2335     /// [`PartialEq`] trait implementation.
2336     ///
2337     /// If the vector is sorted, this removes all duplicates.
2338     ///
2339     /// # Examples
2340     ///
2341     /// ```
2342     /// let mut vec = vec![1, 2, 2, 3, 2];
2343     ///
2344     /// vec.dedup();
2345     ///
2346     /// assert_eq!(vec, [1, 2, 3, 2]);
2347     /// ```
2348     #[stable(feature = "rust1", since = "1.0.0")]
2349     #[inline]
2350     pub fn dedup(&mut self) {
2351         self.dedup_by(|a, b| a == b)
2352     }
2353 }
2354
2355 ////////////////////////////////////////////////////////////////////////////////
2356 // Internal methods and functions
2357 ////////////////////////////////////////////////////////////////////////////////
2358
2359 #[doc(hidden)]
2360 #[cfg(not(no_global_oom_handling))]
2361 #[stable(feature = "rust1", since = "1.0.0")]
2362 pub fn from_elem<T: Clone>(elem: T, n: usize) -> Vec<T> {
2363     <T as SpecFromElem>::from_elem(elem, n, Global)
2364 }
2365
2366 #[doc(hidden)]
2367 #[cfg(not(no_global_oom_handling))]
2368 #[unstable(feature = "allocator_api", issue = "32838")]
2369 pub fn from_elem_in<T: Clone, A: Allocator>(elem: T, n: usize, alloc: A) -> Vec<T, A> {
2370     <T as SpecFromElem>::from_elem(elem, n, alloc)
2371 }
2372
2373 trait ExtendFromWithinSpec {
2374     /// # Safety
2375     ///
2376     /// - `src` needs to be valid index
2377     /// - `self.capacity() - self.len()` must be `>= src.len()`
2378     unsafe fn spec_extend_from_within(&mut self, src: Range<usize>);
2379 }
2380
2381 impl<T: Clone, A: Allocator> ExtendFromWithinSpec for Vec<T, A> {
2382     default unsafe fn spec_extend_from_within(&mut self, src: Range<usize>) {
2383         // SAFETY:
2384         // - len is increased only after initializing elements
2385         let (this, spare, len) = unsafe { self.split_at_spare_mut_with_len() };
2386
2387         // SAFETY:
2388         // - caller guaratees that src is a valid index
2389         let to_clone = unsafe { this.get_unchecked(src) };
2390
2391         iter::zip(to_clone, spare)
2392             .map(|(src, dst)| dst.write(src.clone()))
2393             // Note:
2394             // - Element was just initialized with `MaybeUninit::write`, so it's ok to increase len
2395             // - len is increased after each element to prevent leaks (see issue #82533)
2396             .for_each(|_| *len += 1);
2397     }
2398 }
2399
2400 impl<T: Copy, A: Allocator> ExtendFromWithinSpec for Vec<T, A> {
2401     unsafe fn spec_extend_from_within(&mut self, src: Range<usize>) {
2402         let count = src.len();
2403         {
2404             let (init, spare) = self.split_at_spare_mut();
2405
2406             // SAFETY:
2407             // - caller guaratees that `src` is a valid index
2408             let source = unsafe { init.get_unchecked(src) };
2409
2410             // SAFETY:
2411             // - Both pointers are created from unique slice references (`&mut [_]`)
2412             //   so they are valid and do not overlap.
2413             // - Elements are :Copy so it's OK to to copy them, without doing
2414             //   anything with the original values
2415             // - `count` is equal to the len of `source`, so source is valid for
2416             //   `count` reads
2417             // - `.reserve(count)` guarantees that `spare.len() >= count` so spare
2418             //   is valid for `count` writes
2419             unsafe { ptr::copy_nonoverlapping(source.as_ptr(), spare.as_mut_ptr() as _, count) };
2420         }
2421
2422         // SAFETY:
2423         // - The elements were just initialized by `copy_nonoverlapping`
2424         self.len += count;
2425     }
2426 }
2427
2428 ////////////////////////////////////////////////////////////////////////////////
2429 // Common trait implementations for Vec
2430 ////////////////////////////////////////////////////////////////////////////////
2431
2432 #[stable(feature = "rust1", since = "1.0.0")]
2433 impl<T, A: Allocator> ops::Deref for Vec<T, A> {
2434     type Target = [T];
2435
2436     fn deref(&self) -> &[T] {
2437         unsafe { slice::from_raw_parts(self.as_ptr(), self.len) }
2438     }
2439 }
2440
2441 #[stable(feature = "rust1", since = "1.0.0")]
2442 impl<T, A: Allocator> ops::DerefMut for Vec<T, A> {
2443     fn deref_mut(&mut self) -> &mut [T] {
2444         unsafe { slice::from_raw_parts_mut(self.as_mut_ptr(), self.len) }
2445     }
2446 }
2447
2448 #[cfg(not(no_global_oom_handling))]
2449 trait SpecCloneFrom {
2450     fn clone_from(this: &mut Self, other: &Self);
2451 }
2452
2453 #[cfg(not(no_global_oom_handling))]
2454 impl<T: Clone, A: Allocator> SpecCloneFrom for Vec<T, A> {
2455     default fn clone_from(this: &mut Self, other: &Self) {
2456         // drop anything that will not be overwritten
2457         this.truncate(other.len());
2458
2459         // self.len <= other.len due to the truncate above, so the
2460         // slices here are always in-bounds.
2461         let (init, tail) = other.split_at(this.len());
2462
2463         // reuse the contained values' allocations/resources.
2464         this.clone_from_slice(init);
2465         this.extend_from_slice(tail);
2466     }
2467 }
2468
2469 #[cfg(not(no_global_oom_handling))]
2470 impl<T: Copy, A: Allocator> SpecCloneFrom for Vec<T, A> {
2471     fn clone_from(this: &mut Self, other: &Self) {
2472         this.clear();
2473         this.extend_from_slice(other);
2474     }
2475 }
2476
2477 #[cfg(not(no_global_oom_handling))]
2478 #[stable(feature = "rust1", since = "1.0.0")]
2479 impl<T: Clone, A: Allocator + Clone> Clone for Vec<T, A> {
2480     #[cfg(not(test))]
2481     fn clone(&self) -> Self {
2482         let alloc = self.allocator().clone();
2483         <[T]>::to_vec_in(&**self, alloc)
2484     }
2485
2486     // HACK(japaric): with cfg(test) the inherent `[T]::to_vec` method, which is
2487     // required for this method definition, is not available. Instead use the
2488     // `slice::to_vec`  function which is only available with cfg(test)
2489     // NB see the slice::hack module in slice.rs for more information
2490     #[cfg(test)]
2491     fn clone(&self) -> Self {
2492         let alloc = self.allocator().clone();
2493         crate::slice::to_vec(&**self, alloc)
2494     }
2495
2496     fn clone_from(&mut self, other: &Self) {
2497         SpecCloneFrom::clone_from(self, other)
2498     }
2499 }
2500
2501 /// The hash of a vector is the same as that of the corresponding slice,
2502 /// as required by the `core::borrow::Borrow` implementation.
2503 ///
2504 /// ```
2505 /// #![feature(build_hasher_simple_hash_one)]
2506 /// use std::hash::BuildHasher;
2507 ///
2508 /// let b = std::collections::hash_map::RandomState::new();
2509 /// let v: Vec<u8> = vec![0xa8, 0x3c, 0x09];
2510 /// let s: &[u8] = &[0xa8, 0x3c, 0x09];
2511 /// assert_eq!(b.hash_one(v), b.hash_one(s));
2512 /// ```
2513 #[stable(feature = "rust1", since = "1.0.0")]
2514 impl<T: Hash, A: Allocator> Hash for Vec<T, A> {
2515     #[inline]
2516     fn hash<H: Hasher>(&self, state: &mut H) {
2517         Hash::hash(&**self, state)
2518     }
2519 }
2520
2521 #[stable(feature = "rust1", since = "1.0.0")]
2522 #[rustc_on_unimplemented(
2523     message = "vector indices are of type `usize` or ranges of `usize`",
2524     label = "vector indices are of type `usize` or ranges of `usize`"
2525 )]
2526 impl<T, I: SliceIndex<[T]>, A: Allocator> Index<I> for Vec<T, A> {
2527     type Output = I::Output;
2528
2529     #[inline]
2530     fn index(&self, index: I) -> &Self::Output {
2531         Index::index(&**self, index)
2532     }
2533 }
2534
2535 #[stable(feature = "rust1", since = "1.0.0")]
2536 #[rustc_on_unimplemented(
2537     message = "vector indices are of type `usize` or ranges of `usize`",
2538     label = "vector indices are of type `usize` or ranges of `usize`"
2539 )]
2540 impl<T, I: SliceIndex<[T]>, A: Allocator> IndexMut<I> for Vec<T, A> {
2541     #[inline]
2542     fn index_mut(&mut self, index: I) -> &mut Self::Output {
2543         IndexMut::index_mut(&mut **self, index)
2544     }
2545 }
2546
2547 #[cfg(not(no_global_oom_handling))]
2548 #[stable(feature = "rust1", since = "1.0.0")]
2549 impl<T> FromIterator<T> for Vec<T> {
2550     #[inline]
2551     fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Vec<T> {
2552         <Self as SpecFromIter<T, I::IntoIter>>::from_iter(iter.into_iter())
2553     }
2554 }
2555
2556 #[stable(feature = "rust1", since = "1.0.0")]
2557 impl<T, A: Allocator> IntoIterator for Vec<T, A> {
2558     type Item = T;
2559     type IntoIter = IntoIter<T, A>;
2560
2561     /// Creates a consuming iterator, that is, one that moves each value out of
2562     /// the vector (from start to end). The vector cannot be used after calling
2563     /// this.
2564     ///
2565     /// # Examples
2566     ///
2567     /// ```
2568     /// let v = vec!["a".to_string(), "b".to_string()];
2569     /// for s in v.into_iter() {
2570     ///     // s has type String, not &String
2571     ///     println!("{s}");
2572     /// }
2573     /// ```
2574     #[inline]
2575     fn into_iter(self) -> IntoIter<T, A> {
2576         unsafe {
2577             let mut me = ManuallyDrop::new(self);
2578             let alloc = ptr::read(me.allocator());
2579             let begin = me.as_mut_ptr();
2580             let end = if mem::size_of::<T>() == 0 {
2581                 arith_offset(begin as *const i8, me.len() as isize) as *const T
2582             } else {
2583                 begin.add(me.len()) as *const T
2584             };
2585             let cap = me.buf.capacity();
2586             IntoIter {
2587                 buf: NonNull::new_unchecked(begin),
2588                 phantom: PhantomData,
2589                 cap,
2590                 alloc,
2591                 ptr: begin,
2592                 end,
2593             }
2594         }
2595     }
2596 }
2597
2598 #[stable(feature = "rust1", since = "1.0.0")]
2599 impl<'a, T, A: Allocator> IntoIterator for &'a Vec<T, A> {
2600     type Item = &'a T;
2601     type IntoIter = slice::Iter<'a, T>;
2602
2603     fn into_iter(self) -> slice::Iter<'a, T> {
2604         self.iter()
2605     }
2606 }
2607
2608 #[stable(feature = "rust1", since = "1.0.0")]
2609 impl<'a, T, A: Allocator> IntoIterator for &'a mut Vec<T, A> {
2610     type Item = &'a mut T;
2611     type IntoIter = slice::IterMut<'a, T>;
2612
2613     fn into_iter(self) -> slice::IterMut<'a, T> {
2614         self.iter_mut()
2615     }
2616 }
2617
2618 #[cfg(not(no_global_oom_handling))]
2619 #[stable(feature = "rust1", since = "1.0.0")]
2620 impl<T, A: Allocator> Extend<T> for Vec<T, A> {
2621     #[inline]
2622     fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
2623         <Self as SpecExtend<T, I::IntoIter>>::spec_extend(self, iter.into_iter())
2624     }
2625
2626     #[inline]
2627     fn extend_one(&mut self, item: T) {
2628         self.push(item);
2629     }
2630
2631     #[inline]
2632     fn extend_reserve(&mut self, additional: usize) {
2633         self.reserve(additional);
2634     }
2635 }
2636
2637 impl<T, A: Allocator> Vec<T, A> {
2638     // leaf method to which various SpecFrom/SpecExtend implementations delegate when
2639     // they have no further optimizations to apply
2640     #[cfg(not(no_global_oom_handling))]
2641     fn extend_desugared<I: Iterator<Item = T>>(&mut self, mut iterator: I) {
2642         // This is the case for a general iterator.
2643         //
2644         // This function should be the moral equivalent of:
2645         //
2646         //      for item in iterator {
2647         //          self.push(item);
2648         //      }
2649         while let Some(element) = iterator.next() {
2650             let len = self.len();
2651             if len == self.capacity() {
2652                 let (lower, _) = iterator.size_hint();
2653                 self.reserve(lower.saturating_add(1));
2654             }
2655             unsafe {
2656                 ptr::write(self.as_mut_ptr().add(len), element);
2657                 // Since next() executes user code which can panic we have to bump the length
2658                 // after each step.
2659                 // NB can't overflow since we would have had to alloc the address space
2660                 self.set_len(len + 1);
2661             }
2662         }
2663     }
2664
2665     /// Creates a splicing iterator that replaces the specified range in the vector
2666     /// with the given `replace_with` iterator and yields the removed items.
2667     /// `replace_with` does not need to be the same length as `range`.
2668     ///
2669     /// `range` is removed even if the iterator is not consumed until the end.
2670     ///
2671     /// It is unspecified how many elements are removed from the vector
2672     /// if the `Splice` value is leaked.
2673     ///
2674     /// The input iterator `replace_with` is only consumed when the `Splice` value is dropped.
2675     ///
2676     /// This is optimal if:
2677     ///
2678     /// * The tail (elements in the vector after `range`) is empty,
2679     /// * or `replace_with` yields fewer or equal elements than `range`’s length
2680     /// * or the lower bound of its `size_hint()` is exact.
2681     ///
2682     /// Otherwise, a temporary vector is allocated and the tail is moved twice.
2683     ///
2684     /// # Panics
2685     ///
2686     /// Panics if the starting point is greater than the end point or if
2687     /// the end point is greater than the length of the vector.
2688     ///
2689     /// # Examples
2690     ///
2691     /// ```
2692     /// let mut v = vec![1, 2, 3, 4];
2693     /// let new = [7, 8, 9];
2694     /// let u: Vec<_> = v.splice(1..3, new).collect();
2695     /// assert_eq!(v, &[1, 7, 8, 9, 4]);
2696     /// assert_eq!(u, &[2, 3]);
2697     /// ```
2698     #[cfg(not(no_global_oom_handling))]
2699     #[inline]
2700     #[stable(feature = "vec_splice", since = "1.21.0")]
2701     pub fn splice<R, I>(&mut self, range: R, replace_with: I) -> Splice<'_, I::IntoIter, A>
2702     where
2703         R: RangeBounds<usize>,
2704         I: IntoIterator<Item = T>,
2705     {
2706         Splice { drain: self.drain(range), replace_with: replace_with.into_iter() }
2707     }
2708
2709     /// Creates an iterator which uses a closure to determine if an element should be removed.
2710     ///
2711     /// If the closure returns true, then the element is removed and yielded.
2712     /// If the closure returns false, the element will remain in the vector and will not be yielded
2713     /// by the iterator.
2714     ///
2715     /// Using this method is equivalent to the following code:
2716     ///
2717     /// ```
2718     /// # let some_predicate = |x: &mut i32| { *x == 2 || *x == 3 || *x == 6 };
2719     /// # let mut vec = vec![1, 2, 3, 4, 5, 6];
2720     /// let mut i = 0;
2721     /// while i < vec.len() {
2722     ///     if some_predicate(&mut vec[i]) {
2723     ///         let val = vec.remove(i);
2724     ///         // your code here
2725     ///     } else {
2726     ///         i += 1;
2727     ///     }
2728     /// }
2729     ///
2730     /// # assert_eq!(vec, vec![1, 4, 5]);
2731     /// ```
2732     ///
2733     /// But `drain_filter` is easier to use. `drain_filter` is also more efficient,
2734     /// because it can backshift the elements of the array in bulk.
2735     ///
2736     /// Note that `drain_filter` also lets you mutate every element in the filter closure,
2737     /// regardless of whether you choose to keep or remove it.
2738     ///
2739     /// # Examples
2740     ///
2741     /// Splitting an array into evens and odds, reusing the original allocation:
2742     ///
2743     /// ```
2744     /// #![feature(drain_filter)]
2745     /// let mut numbers = vec![1, 2, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15];
2746     ///
2747     /// let evens = numbers.drain_filter(|x| *x % 2 == 0).collect::<Vec<_>>();
2748     /// let odds = numbers;
2749     ///
2750     /// assert_eq!(evens, vec![2, 4, 6, 8, 14]);
2751     /// assert_eq!(odds, vec![1, 3, 5, 9, 11, 13, 15]);
2752     /// ```
2753     #[unstable(feature = "drain_filter", reason = "recently added", issue = "43244")]
2754     pub fn drain_filter<F>(&mut self, filter: F) -> DrainFilter<'_, T, F, A>
2755     where
2756         F: FnMut(&mut T) -> bool,
2757     {
2758         let old_len = self.len();
2759
2760         // Guard against us getting leaked (leak amplification)
2761         unsafe {
2762             self.set_len(0);
2763         }
2764
2765         DrainFilter { vec: self, idx: 0, del: 0, old_len, pred: filter, panic_flag: false }
2766     }
2767 }
2768
2769 /// Extend implementation that copies elements out of references before pushing them onto the Vec.
2770 ///
2771 /// This implementation is specialized for slice iterators, where it uses [`copy_from_slice`] to
2772 /// append the entire slice at once.
2773 ///
2774 /// [`copy_from_slice`]: slice::copy_from_slice
2775 #[cfg(not(no_global_oom_handling))]
2776 #[stable(feature = "extend_ref", since = "1.2.0")]
2777 impl<'a, T: Copy + 'a, A: Allocator + 'a> Extend<&'a T> for Vec<T, A> {
2778     fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I) {
2779         self.spec_extend(iter.into_iter())
2780     }
2781
2782     #[inline]
2783     fn extend_one(&mut self, &item: &'a T) {
2784         self.push(item);
2785     }
2786
2787     #[inline]
2788     fn extend_reserve(&mut self, additional: usize) {
2789         self.reserve(additional);
2790     }
2791 }
2792
2793 /// Implements comparison of vectors, [lexicographically](core::cmp::Ord#lexicographical-comparison).
2794 #[stable(feature = "rust1", since = "1.0.0")]
2795 impl<T: PartialOrd, A: Allocator> PartialOrd for Vec<T, A> {
2796     #[inline]
2797     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
2798         PartialOrd::partial_cmp(&**self, &**other)
2799     }
2800 }
2801
2802 #[stable(feature = "rust1", since = "1.0.0")]
2803 impl<T: Eq, A: Allocator> Eq for Vec<T, A> {}
2804
2805 /// Implements ordering of vectors, [lexicographically](core::cmp::Ord#lexicographical-comparison).
2806 #[stable(feature = "rust1", since = "1.0.0")]
2807 impl<T: Ord, A: Allocator> Ord for Vec<T, A> {
2808     #[inline]
2809     fn cmp(&self, other: &Self) -> Ordering {
2810         Ord::cmp(&**self, &**other)
2811     }
2812 }
2813
2814 #[stable(feature = "rust1", since = "1.0.0")]
2815 unsafe impl<#[may_dangle] T, A: Allocator> Drop for Vec<T, A> {
2816     fn drop(&mut self) {
2817         unsafe {
2818             // use drop for [T]
2819             // use a raw slice to refer to the elements of the vector as weakest necessary type;
2820             // could avoid questions of validity in certain cases
2821             ptr::drop_in_place(ptr::slice_from_raw_parts_mut(self.as_mut_ptr(), self.len))
2822         }
2823         // RawVec handles deallocation
2824     }
2825 }
2826
2827 #[stable(feature = "rust1", since = "1.0.0")]
2828 #[rustc_const_unstable(feature = "const_default_impls", issue = "87864")]
2829 impl<T> const Default for Vec<T> {
2830     /// Creates an empty `Vec<T>`.
2831     fn default() -> Vec<T> {
2832         Vec::new()
2833     }
2834 }
2835
2836 #[stable(feature = "rust1", since = "1.0.0")]
2837 impl<T: fmt::Debug, A: Allocator> fmt::Debug for Vec<T, A> {
2838     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2839         fmt::Debug::fmt(&**self, f)
2840     }
2841 }
2842
2843 #[stable(feature = "rust1", since = "1.0.0")]
2844 impl<T, A: Allocator> AsRef<Vec<T, A>> for Vec<T, A> {
2845     fn as_ref(&self) -> &Vec<T, A> {
2846         self
2847     }
2848 }
2849
2850 #[stable(feature = "vec_as_mut", since = "1.5.0")]
2851 impl<T, A: Allocator> AsMut<Vec<T, A>> for Vec<T, A> {
2852     fn as_mut(&mut self) -> &mut Vec<T, A> {
2853         self
2854     }
2855 }
2856
2857 #[stable(feature = "rust1", since = "1.0.0")]
2858 impl<T, A: Allocator> AsRef<[T]> for Vec<T, A> {
2859     fn as_ref(&self) -> &[T] {
2860         self
2861     }
2862 }
2863
2864 #[stable(feature = "vec_as_mut", since = "1.5.0")]
2865 impl<T, A: Allocator> AsMut<[T]> for Vec<T, A> {
2866     fn as_mut(&mut self) -> &mut [T] {
2867         self
2868     }
2869 }
2870
2871 #[cfg(not(no_global_oom_handling))]
2872 #[stable(feature = "rust1", since = "1.0.0")]
2873 impl<T: Clone> From<&[T]> for Vec<T> {
2874     /// Allocate a `Vec<T>` and fill it by cloning `s`'s items.
2875     ///
2876     /// # Examples
2877     ///
2878     /// ```
2879     /// assert_eq!(Vec::from(&[1, 2, 3][..]), vec![1, 2, 3]);
2880     /// ```
2881     #[cfg(not(test))]
2882     fn from(s: &[T]) -> Vec<T> {
2883         s.to_vec()
2884     }
2885     #[cfg(test)]
2886     fn from(s: &[T]) -> Vec<T> {
2887         crate::slice::to_vec(s, Global)
2888     }
2889 }
2890
2891 #[cfg(not(no_global_oom_handling))]
2892 #[stable(feature = "vec_from_mut", since = "1.19.0")]
2893 impl<T: Clone> From<&mut [T]> for Vec<T> {
2894     /// Allocate a `Vec<T>` and fill it by cloning `s`'s items.
2895     ///
2896     /// # Examples
2897     ///
2898     /// ```
2899     /// assert_eq!(Vec::from(&mut [1, 2, 3][..]), vec![1, 2, 3]);
2900     /// ```
2901     #[cfg(not(test))]
2902     fn from(s: &mut [T]) -> Vec<T> {
2903         s.to_vec()
2904     }
2905     #[cfg(test)]
2906     fn from(s: &mut [T]) -> Vec<T> {
2907         crate::slice::to_vec(s, Global)
2908     }
2909 }
2910
2911 #[cfg(not(no_global_oom_handling))]
2912 #[stable(feature = "vec_from_array", since = "1.44.0")]
2913 impl<T, const N: usize> From<[T; N]> for Vec<T> {
2914     /// Allocate a `Vec<T>` and move `s`'s items into it.
2915     ///
2916     /// # Examples
2917     ///
2918     /// ```
2919     /// assert_eq!(Vec::from([1, 2, 3]), vec![1, 2, 3]);
2920     /// ```
2921     #[cfg(not(test))]
2922     fn from(s: [T; N]) -> Vec<T> {
2923         <[T]>::into_vec(box s)
2924     }
2925
2926     #[cfg(test)]
2927     fn from(s: [T; N]) -> Vec<T> {
2928         crate::slice::into_vec(box s)
2929     }
2930 }
2931
2932 #[stable(feature = "vec_from_cow_slice", since = "1.14.0")]
2933 impl<'a, T> From<Cow<'a, [T]>> for Vec<T>
2934 where
2935     [T]: ToOwned<Owned = Vec<T>>,
2936 {
2937     /// Convert a clone-on-write slice into a vector.
2938     ///
2939     /// If `s` already owns a `Vec<T>`, it will be returned directly.
2940     /// If `s` is borrowing a slice, a new `Vec<T>` will be allocated and
2941     /// filled by cloning `s`'s items into it.
2942     ///
2943     /// # Examples
2944     ///
2945     /// ```
2946     /// # use std::borrow::Cow;
2947     /// let o: Cow<[i32]> = Cow::Owned(vec![1, 2, 3]);
2948     /// let b: Cow<[i32]> = Cow::Borrowed(&[1, 2, 3]);
2949     /// assert_eq!(Vec::from(o), Vec::from(b));
2950     /// ```
2951     fn from(s: Cow<'a, [T]>) -> Vec<T> {
2952         s.into_owned()
2953     }
2954 }
2955
2956 // note: test pulls in libstd, which causes errors here
2957 #[cfg(not(test))]
2958 #[stable(feature = "vec_from_box", since = "1.18.0")]
2959 impl<T, A: Allocator> From<Box<[T], A>> for Vec<T, A> {
2960     /// Convert a boxed slice into a vector by transferring ownership of
2961     /// the existing heap allocation.
2962     ///
2963     /// # Examples
2964     ///
2965     /// ```
2966     /// let b: Box<[i32]> = vec![1, 2, 3].into_boxed_slice();
2967     /// assert_eq!(Vec::from(b), vec![1, 2, 3]);
2968     /// ```
2969     fn from(s: Box<[T], A>) -> Self {
2970         s.into_vec()
2971     }
2972 }
2973
2974 // note: test pulls in libstd, which causes errors here
2975 #[cfg(not(no_global_oom_handling))]
2976 #[cfg(not(test))]
2977 #[stable(feature = "box_from_vec", since = "1.20.0")]
2978 impl<T, A: Allocator> From<Vec<T, A>> for Box<[T], A> {
2979     /// Convert a vector into a boxed slice.
2980     ///
2981     /// If `v` has excess capacity, its items will be moved into a
2982     /// newly-allocated buffer with exactly the right capacity.
2983     ///
2984     /// # Examples
2985     ///
2986     /// ```
2987     /// assert_eq!(Box::from(vec![1, 2, 3]), vec![1, 2, 3].into_boxed_slice());
2988     /// ```
2989     fn from(v: Vec<T, A>) -> Self {
2990         v.into_boxed_slice()
2991     }
2992 }
2993
2994 #[cfg(not(no_global_oom_handling))]
2995 #[stable(feature = "rust1", since = "1.0.0")]
2996 impl From<&str> for Vec<u8> {
2997     /// Allocate a `Vec<u8>` and fill it with a UTF-8 string.
2998     ///
2999     /// # Examples
3000     ///
3001     /// ```
3002     /// assert_eq!(Vec::from("123"), vec![b'1', b'2', b'3']);
3003     /// ```
3004     fn from(s: &str) -> Vec<u8> {
3005         From::from(s.as_bytes())
3006     }
3007 }
3008
3009 #[stable(feature = "array_try_from_vec", since = "1.48.0")]
3010 impl<T, A: Allocator, const N: usize> TryFrom<Vec<T, A>> for [T; N] {
3011     type Error = Vec<T, A>;
3012
3013     /// Gets the entire contents of the `Vec<T>` as an array,
3014     /// if its size exactly matches that of the requested array.
3015     ///
3016     /// # Examples
3017     ///
3018     /// ```
3019     /// assert_eq!(vec![1, 2, 3].try_into(), Ok([1, 2, 3]));
3020     /// assert_eq!(<Vec<i32>>::new().try_into(), Ok([]));
3021     /// ```
3022     ///
3023     /// If the length doesn't match, the input comes back in `Err`:
3024     /// ```
3025     /// let r: Result<[i32; 4], _> = (0..10).collect::<Vec<_>>().try_into();
3026     /// assert_eq!(r, Err(vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9]));
3027     /// ```
3028     ///
3029     /// If you're fine with just getting a prefix of the `Vec<T>`,
3030     /// you can call [`.truncate(N)`](Vec::truncate) first.
3031     /// ```
3032     /// let mut v = String::from("hello world").into_bytes();
3033     /// v.sort();
3034     /// v.truncate(2);
3035     /// let [a, b]: [_; 2] = v.try_into().unwrap();
3036     /// assert_eq!(a, b' ');
3037     /// assert_eq!(b, b'd');
3038     /// ```
3039     fn try_from(mut vec: Vec<T, A>) -> Result<[T; N], Vec<T, A>> {
3040         if vec.len() != N {
3041             return Err(vec);
3042         }
3043
3044         // SAFETY: `.set_len(0)` is always sound.
3045         unsafe { vec.set_len(0) };
3046
3047         // SAFETY: A `Vec`'s pointer is always aligned properly, and
3048         // the alignment the array needs is the same as the items.
3049         // We checked earlier that we have sufficient items.
3050         // The items will not double-drop as the `set_len`
3051         // tells the `Vec` not to also drop them.
3052         let array = unsafe { ptr::read(vec.as_ptr() as *const [T; N]) };
3053         Ok(array)
3054     }
3055 }