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