src/liballoc/vec.rs

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