src/libcollections/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>` but pronounced 'vector.'
  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 #![stable(feature = "rust1", since = "1.0.0")]
  61
  62 use alloc::boxed::Box;
  63 use alloc::heap::EMPTY;
  64 use alloc::raw_vec::RawVec;
  65 use borrow::ToOwned;
  66 use core::cmp::Ordering;
  67 use core::fmt;
  68 use core::hash::{self, Hash};
  69 use core::intrinsics::{arith_offset, assume, needs_drop};
  70 use core::iter::FromIterator;
  71 use core::mem;
  72 use core::ops::{Index, IndexMut};
  73 use core::ops;
  74 use core::ptr;
  75 use core::slice;
  76
  77 #[allow(deprecated)]
  78 use borrow::{Cow, IntoCow};
  79
  80 use super::range::RangeArgument;
  81
  82 /// A contiguous growable array type, written `Vec<T>` but pronounced 'vector.'
  83 ///
  84 /// # Examples
  85 ///
  86 /// ```
  87 /// let mut vec = Vec::new();
  88 /// vec.push(1);
  89 /// vec.push(2);
  90 ///
  91 /// assert_eq!(vec.len(), 2);
  92 /// assert_eq!(vec[0], 1);
  93 ///
  94 /// assert_eq!(vec.pop(), Some(2));
  95 /// assert_eq!(vec.len(), 1);
  96 ///
  97 /// vec[0] = 7;
  98 /// assert_eq!(vec[0], 7);
  99 ///
 100 /// vec.extend([1, 2, 3].iter().cloned());
 101 ///
 102 /// for x in &vec {
 103 ///     println!("{}", x);
 104 /// }
 105 /// assert_eq!(vec, [7, 1, 2, 3]);
 106 /// ```
 107 ///
 108 /// The `vec!` macro is provided to make initialization more convenient:
 109 ///
 110 /// ```
 111 /// let mut vec = vec![1, 2, 3];
 112 /// vec.push(4);
 113 /// assert_eq!(vec, [1, 2, 3, 4]);
 114 /// ```
 115 ///
 116 /// It can also initialize each element of a `Vec<T>` with a given value:
 117 ///
 118 /// ```
 119 /// let vec = vec![0; 5];
 120 /// assert_eq!(vec, [0, 0, 0, 0, 0]);
 121 /// ```
 122 ///
 123 /// Use a `Vec<T>` as an efficient stack:
 124 ///
 125 /// ```
 126 /// let mut stack = Vec::new();
 127 ///
 128 /// stack.push(1);
 129 /// stack.push(2);
 130 /// stack.push(3);
 131 ///
 132 /// while let Some(top) = stack.pop() {
 133 ///     // Prints 3, 2, 1
 134 ///     println!("{}", top);
 135 /// }
 136 /// ```
 137 ///
 138 /// # Indexing
 139 ///
 140 /// The Vec type allows to access values by index, because it implements the
 141 /// `Index` trait. An example will be more explicit:
 142 ///
 143 /// ```
 144 /// let v = vec!(0, 2, 4, 6);
 145 /// println!("{}", v[1]); // it will display '2'
 146 /// ```
 147 ///
 148 /// However be careful: if you try to access an index which isn't in the Vec,
 149 /// your software will panic! You cannot do this:
 150 ///
 151 /// ```ignore
 152 /// let v = vec!(0, 2, 4, 6);
 153 /// println!("{}", v[6]); // it will panic!
 154 /// ```
 155 ///
 156 /// In conclusion: always check if the index you want to get really exists
 157 /// before doing it.
 158 ///
 159 /// # Slicing
 160 ///
 161 /// A Vec can be mutable. Slices, on the other hand, are read-only objects.
 162 /// To get a slice, use "&". Example:
 163 ///
 164 /// ```
 165 /// fn read_slice(slice: &[usize]) {
 166 ///     // ...
 167 /// }
 168 ///
 169 /// let v = vec!(0, 1);
 170 /// read_slice(&v);
 171 ///
 172 /// // ... and that's all!
 173 /// // you can also do it like this:
 174 /// let x : &[usize] = &v;
 175 /// ```
 176 ///
 177 /// In Rust, it's more common to pass slices as arguments rather than vectors
 178 /// when you just want to provide a read access. The same goes for String and
 179 /// &str.
 180 ///
 181 /// # Capacity and reallocation
 182 ///
 183 /// The capacity of a vector is the amount of space allocated for any future
 184 /// elements that will be added onto the vector. This is not to be confused with
 185 /// the *length* of a vector, which specifies the number of actual elements
 186 /// within the vector. If a vector's length exceeds its capacity, its capacity
 187 /// will automatically be increased, but its elements will have to be
 188 /// reallocated.
 189 ///
 190 /// For example, a vector with capacity 10 and length 0 would be an empty vector
 191 /// with space for 10 more elements. Pushing 10 or fewer elements onto the
 192 /// vector will not change its capacity or cause reallocation to occur. However,
 193 /// if the vector's length is increased to 11, it will have to reallocate, which
 194 /// can be slow. For this reason, it is recommended to use `Vec::with_capacity`
 195 /// whenever possible to specify how big the vector is expected to get.
 196 ///
 197 /// # Guarantees
 198 ///
 199 /// Due to its incredibly fundamental nature, Vec makes a lot of guarantees
 200 /// about its design. This ensures that it's as low-overhead as possible in
 201 /// the general case, and can be correctly manipulated in primitive ways
 202 /// by unsafe code. Note that these guarantees refer to an unqualified `Vec<T>`.
 203 /// If additional type parameters are added (e.g. to support custom allocators),
 204 /// overriding their defaults may change the behavior.
 205 ///
 206 /// Most fundamentally, Vec is and always will be a (pointer, capacity, length)
 207 /// triplet. No more, no less. The order of these fields is completely
 208 /// unspecified, and you should use the appropriate methods to modify these.
 209 /// The pointer will never be null, so this type is null-pointer-optimized.
 210 ///
 211 /// However, the pointer may not actually point to allocated memory. In particular,
 212 /// if you construct a Vec with capacity 0 via `Vec::new()`, `vec![]`,
 213 /// `Vec::with_capacity(0)`, or by calling `shrink_to_fit()` on an empty Vec, it
 214 /// will not allocate memory. Similarly, if you store zero-sized types inside
 215 /// a Vec, it will not allocate space for them. *Note that in this case the
 216 /// Vec may not report a `capacity()` of 0*. Vec will allocate if and only
 217 /// if `mem::size_of::<T>() * capacity() > 0`. In general, Vec's allocation
 218 /// details are subtle enough that it is strongly recommended that you only
 219 /// free memory allocated by a Vec by creating a new Vec and dropping it.
 220 ///
 221 /// If a Vec *has* allocated memory, then the memory it points to is on the heap
 222 /// (as defined by the allocator Rust is configured to use by default), and its
 223 /// pointer points to `len()` initialized elements in order (what you would see
 224 /// if you coerced it to a slice), followed by `capacity() - len()` logically
 225 /// uninitialized elements.
 226 ///
 227 /// Vec will never perform a "small optimization" where elements are actually
 228 /// stored on the stack for two reasons:
 229 ///
 230 /// * It would make it more difficult for unsafe code to correctly manipulate
 231 ///   a Vec. The contents of a Vec wouldn't have a stable address if it were
 232 ///   only moved, and it would be more difficult to determine if a Vec had
 233 ///   actually allocated memory.
 234 ///
 235 /// * It would penalize the general case, incurring an additional branch
 236 ///   on every access.
 237 ///
 238 /// Vec will never automatically shrink itself, even if completely empty. This
 239 /// ensures no unnecessary allocations or deallocations occur. Emptying a Vec
 240 /// and then filling it back up to the same `len()` should incur no calls to
 241 /// the allocator. If you wish to free up unused memory, use `shrink_to_fit`.
 242 ///
 243 /// `push` and `insert` will never (re)allocate if the reported capacity is
 244 /// sufficient. `push` and `insert` *will* (re)allocate if `len() == capacity()`.
 245 /// That is, the reported capacity is completely accurate, and can be relied on.
 246 /// It can even be used to manually free the memory allocated by a Vec if
 247 /// desired. Bulk insertion methods *may* reallocate, even when not necessary.
 248 ///
 249 /// Vec does not guarantee any particular growth strategy when reallocating
 250 /// when full, nor when `reserve` is called. The current strategy is basic
 251 /// and it may prove desirable to use a non-constant growth factor. Whatever
 252 /// strategy is used will of course guarantee `O(1)` amortized `push`.
 253 ///
 254 /// `vec![x; n]`, `vec![a, b, c, d]`, and `Vec::with_capacity(n)`, will all
 255 /// produce a Vec with exactly the requested capacity. If `len() == capacity()`,
 256 /// (as is the case for the `vec!` macro), then a `Vec<T>` can be converted
 257 /// to and from a `Box<[T]>` without reallocating or moving the elements.
 258 ///
 259 /// Vec will not specifically overwrite any data that is removed from it,
 260 /// but also won't specifically preserve it. Its uninitialized memory is
 261 /// scratch space that it may use however it wants. It will generally just do
 262 /// whatever is most efficient or otherwise easy to implement. Do not rely on
 263 /// removed data to be erased for security purposes. Even if you drop a Vec, its
 264 /// buffer may simply be reused by another Vec. Even if you zero a Vec's memory
 265 /// first, that may not actually happen because the optimizer does not consider
 266 /// this a side-effect that must be preserved.
 267 ///
 268 /// Vec does not currently guarantee the order in which elements are dropped
 269 /// (the order has changed in the past, and may change again).
 270 ///
 271 #[unsafe_no_drop_flag]
 272 #[stable(feature = "rust1", since = "1.0.0")]
 273 pub struct Vec<T> {
 274     buf: RawVec<T>,
 275     len: usize,
 276 }
 277
 278 ////////////////////////////////////////////////////////////////////////////////
 279 // Inherent methods
 280 ////////////////////////////////////////////////////////////////////////////////
 281
 282 impl<T> Vec<T> {
 283     /// Constructs a new, empty `Vec<T>`.
 284     ///
 285     /// The vector will not allocate until elements are pushed onto it.
 286     ///
 287     /// # Examples
 288     ///
 289     /// ```
 290     /// # #![allow(unused_mut)]
 291     /// let mut vec: Vec<i32> = Vec::new();
 292     /// ```
 293     #[inline]
 294     #[stable(feature = "rust1", since = "1.0.0")]
 295     pub fn new() -> Vec<T> {
 296         Vec {
 297             buf: RawVec::new(),
 298             len: 0,
 299         }
 300     }
 301
 302     /// Constructs a new, empty `Vec<T>` with the specified capacity.
 303     ///
 304     /// The vector will be able to hold exactly `capacity` elements without
 305     /// reallocating. If `capacity` is 0, the vector will not allocate.
 306     ///
 307     /// It is important to note that this function does not specify the *length*
 308     /// of the returned vector, but only the *capacity*. (For an explanation of
 309     /// the difference between length and capacity, see the main `Vec<T>` docs
 310     /// above, 'Capacity and reallocation'.)
 311     ///
 312     /// # Examples
 313     ///
 314     /// ```
 315     /// let mut vec = Vec::with_capacity(10);
 316     ///
 317     /// // The vector contains no items, even though it has capacity for more
 318     /// assert_eq!(vec.len(), 0);
 319     ///
 320     /// // These are all done without reallocating...
 321     /// for i in 0..10 {
 322     ///     vec.push(i);
 323     /// }
 324     ///
 325     /// // ...but this may make the vector reallocate
 326     /// vec.push(11);
 327     /// ```
 328     #[inline]
 329     #[stable(feature = "rust1", since = "1.0.0")]
 330     pub fn with_capacity(capacity: usize) -> Vec<T> {
 331         Vec {
 332             buf: RawVec::with_capacity(capacity),
 333             len: 0,
 334         }
 335     }
 336
 337     /// Creates a `Vec<T>` directly from the raw components of another vector.
 338     ///
 339     /// # Safety
 340     ///
 341     /// This is highly unsafe, due to the number of invariants that aren't
 342     /// checked:
 343     ///
 344     /// * `ptr` needs to have been previously allocated via `String`/`Vec<T>`
 345     ///   (at least, it's highly likely to be incorrect if it wasn't).
 346     /// * `length` needs to be the length that less than or equal to `capacity`.
 347     /// * `capacity` needs to be the capacity that the pointer was allocated with.
 348     ///
 349     /// Violating these may cause problems like corrupting the allocator's
 350     /// internal datastructures.
 351     ///
 352     /// # Examples
 353     ///
 354     /// ```
 355     /// use std::ptr;
 356     /// use std::mem;
 357     ///
 358     /// fn main() {
 359     ///     let mut v = vec![1, 2, 3];
 360     ///
 361     ///     // Pull out the various important pieces of information about `v`
 362     ///     let p = v.as_mut_ptr();
 363     ///     let len = v.len();
 364     ///     let cap = v.capacity();
 365     ///
 366     ///     unsafe {
 367     ///         // Cast `v` into the void: no destructor run, so we are in
 368     ///         // complete control of the allocation to which `p` points.
 369     ///         mem::forget(v);
 370     ///
 371     ///         // Overwrite memory with 4, 5, 6
 372     ///         for i in 0..len as isize {
 373     ///             ptr::write(p.offset(i), 4 + i);
 374     ///         }
 375     ///
 376     ///         // Put everything back together into a Vec
 377     ///         let rebuilt = Vec::from_raw_parts(p, len, cap);
 378     ///         assert_eq!(rebuilt, [4, 5, 6]);
 379     ///     }
 380     /// }
 381     /// ```
 382     #[stable(feature = "rust1", since = "1.0.0")]
 383     pub unsafe fn from_raw_parts(ptr: *mut T, length: usize, capacity: usize) -> Vec<T> {
 384         Vec {
 385             buf: RawVec::from_raw_parts(ptr, capacity),
 386             len: length,
 387         }
 388     }
 389
 390     /// Returns the number of elements the vector can hold without
 391     /// reallocating.
 392     ///
 393     /// # Examples
 394     ///
 395     /// ```
 396     /// let vec: Vec<i32> = Vec::with_capacity(10);
 397     /// assert_eq!(vec.capacity(), 10);
 398     /// ```
 399     #[inline]
 400     #[stable(feature = "rust1", since = "1.0.0")]
 401     pub fn capacity(&self) -> usize {
 402         self.buf.cap()
 403     }
 404
 405     /// Reserves capacity for at least `additional` more elements to be inserted
 406     /// in the given `Vec<T>`. The collection may reserve more space to avoid
 407     /// frequent reallocations.
 408     ///
 409     /// # Panics
 410     ///
 411     /// Panics if the new capacity overflows `usize`.
 412     ///
 413     /// # Examples
 414     ///
 415     /// ```
 416     /// let mut vec = vec![1];
 417     /// vec.reserve(10);
 418     /// assert!(vec.capacity() >= 11);
 419     /// ```
 420     #[stable(feature = "rust1", since = "1.0.0")]
 421     pub fn reserve(&mut self, additional: usize) {
 422         self.buf.reserve(self.len, additional);
 423     }
 424
 425     /// Reserves the minimum capacity for exactly `additional` more elements to
 426     /// be inserted in the given `Vec<T>`. Does nothing if the capacity is already
 427     /// sufficient.
 428     ///
 429     /// Note that the allocator may give the collection more space than it
 430     /// requests. Therefore capacity can not be relied upon to be precisely
 431     /// minimal. Prefer `reserve` if future insertions are expected.
 432     ///
 433     /// # Panics
 434     ///
 435     /// Panics if the new capacity overflows `usize`.
 436     ///
 437     /// # Examples
 438     ///
 439     /// ```
 440     /// let mut vec = vec![1];
 441     /// vec.reserve_exact(10);
 442     /// assert!(vec.capacity() >= 11);
 443     /// ```
 444     #[stable(feature = "rust1", since = "1.0.0")]
 445     pub fn reserve_exact(&mut self, additional: usize) {
 446         self.buf.reserve_exact(self.len, additional);
 447     }
 448
 449     /// Shrinks the capacity of the vector as much as possible.
 450     ///
 451     /// It will drop down as close as possible to the length but the allocator
 452     /// may still inform the vector that there is space for a few more elements.
 453     ///
 454     /// # Examples
 455     ///
 456     /// ```
 457     /// let mut vec = Vec::with_capacity(10);
 458     /// vec.extend([1, 2, 3].iter().cloned());
 459     /// assert_eq!(vec.capacity(), 10);
 460     /// vec.shrink_to_fit();
 461     /// assert!(vec.capacity() >= 3);
 462     /// ```
 463     #[stable(feature = "rust1", since = "1.0.0")]
 464     pub fn shrink_to_fit(&mut self) {
 465         self.buf.shrink_to_fit(self.len);
 466     }
 467
 468     /// Converts the vector into Box<[T]>.
 469     ///
 470     /// Note that this will drop any excess capacity. Calling this and
 471     /// converting back to a vector with `into_vec()` is equivalent to calling
 472     /// `shrink_to_fit()`.
 473     #[stable(feature = "rust1", since = "1.0.0")]
 474     pub fn into_boxed_slice(mut self) -> Box<[T]> {
 475         unsafe {
 476             self.shrink_to_fit();
 477             let buf = ptr::read(&self.buf);
 478             mem::forget(self);
 479             buf.into_box()
 480         }
 481     }
 482
 483     /// Shorten a vector to be `len` elements long, dropping excess elements.
 484     ///
 485     /// If `len` is greater than the vector's current length, this has no
 486     /// effect.
 487     ///
 488     /// # Examples
 489     ///
 490     /// ```
 491     /// let mut vec = vec![1, 2, 3, 4, 5];
 492     /// vec.truncate(2);
 493     /// assert_eq!(vec, [1, 2]);
 494     /// ```
 495     #[stable(feature = "rust1", since = "1.0.0")]
 496     pub fn truncate(&mut self, len: usize) {
 497         unsafe {
 498             // drop any extra elements
 499             while len < self.len {
 500                 // decrement len before the read(), so a panic on Drop doesn't
 501                 // re-drop the just-failed value.
 502                 self.len -= 1;
 503                 ptr::read(self.get_unchecked(self.len));
 504             }
 505         }
 506     }
 507
 508     /// Extracts a slice containing the entire vector.
 509     ///
 510     /// Equivalent to `&s[..]`.
 511     #[inline]
 512     #[stable(feature = "vec_as_slice", since = "1.7.0")]
 513     pub fn as_slice(&self) -> &[T] {
 514         self
 515     }
 516
 517     /// Extracts a mutable slice of the entire vector.
 518     ///
 519     /// Equivalent to `&mut s[..]`.
 520     #[inline]
 521     #[stable(feature = "vec_as_slice", since = "1.7.0")]
 522     pub fn as_mut_slice(&mut self) -> &mut [T] {
 523         &mut self[..]
 524     }
 525
 526     /// Sets the length of a vector.
 527     ///
 528     /// This will explicitly set the size of the vector, without actually
 529     /// modifying its buffers, so it is up to the caller to ensure that the
 530     /// vector is actually the specified size.
 531     ///
 532     /// # Examples
 533     ///
 534     /// ```
 535     /// let mut v = vec![1, 2, 3, 4];
 536     /// unsafe {
 537     ///     v.set_len(1);
 538     /// }
 539     /// ```
 540     #[inline]
 541     #[stable(feature = "rust1", since = "1.0.0")]
 542     pub unsafe fn set_len(&mut self, len: usize) {
 543         self.len = len;
 544     }
 545
 546     /// Removes an element from anywhere in the vector and return it, replacing
 547     /// it with the last element.
 548     ///
 549     /// This does not preserve ordering, but is O(1).
 550     ///
 551     /// # Panics
 552     ///
 553     /// Panics if `index` is out of bounds.
 554     ///
 555     /// # Examples
 556     ///
 557     /// ```
 558     /// let mut v = vec!["foo", "bar", "baz", "qux"];
 559     ///
 560     /// assert_eq!(v.swap_remove(1), "bar");
 561     /// assert_eq!(v, ["foo", "qux", "baz"]);
 562     ///
 563     /// assert_eq!(v.swap_remove(0), "foo");
 564     /// assert_eq!(v, ["baz", "qux"]);
 565     /// ```
 566     #[inline]
 567     #[stable(feature = "rust1", since = "1.0.0")]
 568     pub fn swap_remove(&mut self, index: usize) -> T {
 569         let length = self.len();
 570         self.swap(index, length - 1);
 571         self.pop().unwrap()
 572     }
 573
 574     /// Inserts an element at position `index` within the vector, shifting all
 575     /// elements after it to the right.
 576     ///
 577     /// # Panics
 578     ///
 579     /// Panics if `index` is greater than the vector's length.
 580     ///
 581     /// # Examples
 582     ///
 583     /// ```
 584     /// let mut vec = vec![1, 2, 3];
 585     /// vec.insert(1, 4);
 586     /// assert_eq!(vec, [1, 4, 2, 3]);
 587     /// vec.insert(4, 5);
 588     /// assert_eq!(vec, [1, 4, 2, 3, 5]);
 589     /// ```
 590     #[stable(feature = "rust1", since = "1.0.0")]
 591     pub fn insert(&mut self, index: usize, element: T) {
 592         let len = self.len();
 593         assert!(index <= len);
 594
 595         // space for the new element
 596         if len == self.buf.cap() {
 597             self.buf.double();
 598         }
 599
 600         unsafe {
 601             // infallible
 602             // The spot to put the new value
 603             {
 604                 let p = self.as_mut_ptr().offset(index as isize);
 605                 // Shift everything over to make space. (Duplicating the
 606                 // `index`th element into two consecutive places.)
 607                 ptr::copy(p, p.offset(1), len - index);
 608                 // Write it in, overwriting the first copy of the `index`th
 609                 // element.
 610                 ptr::write(p, element);
 611             }
 612             self.set_len(len + 1);
 613         }
 614     }
 615
 616     /// Removes and returns the element at position `index` within the vector,
 617     /// shifting all elements after it to the left.
 618     ///
 619     /// # Panics
 620     ///
 621     /// Panics if `index` is out of bounds.
 622     ///
 623     /// # Examples
 624     ///
 625     /// ```
 626     /// let mut v = vec![1, 2, 3];
 627     /// assert_eq!(v.remove(1), 2);
 628     /// assert_eq!(v, [1, 3]);
 629     /// ```
 630     #[stable(feature = "rust1", since = "1.0.0")]
 631     pub fn remove(&mut self, index: usize) -> T {
 632         let len = self.len();
 633         assert!(index < len);
 634         unsafe {
 635             // infallible
 636             let ret;
 637             {
 638                 // the place we are taking from.
 639                 let ptr = self.as_mut_ptr().offset(index as isize);
 640                 // copy it out, unsafely having a copy of the value on
 641                 // the stack and in the vector at the same time.
 642                 ret = ptr::read(ptr);
 643
 644                 // Shift everything down to fill in that spot.
 645                 ptr::copy(ptr.offset(1), ptr, len - index - 1);
 646             }
 647             self.set_len(len - 1);
 648             ret
 649         }
 650     }
 651
 652     /// Retains only the elements specified by the predicate.
 653     ///
 654     /// In other words, remove all elements `e` such that `f(&e)` returns false.
 655     /// This method operates in place and preserves the order of the retained
 656     /// elements.
 657     ///
 658     /// # Examples
 659     ///
 660     /// ```
 661     /// let mut vec = vec![1, 2, 3, 4];
 662     /// vec.retain(|&x| x%2 == 0);
 663     /// assert_eq!(vec, [2, 4]);
 664     /// ```
 665     #[stable(feature = "rust1", since = "1.0.0")]
 666     pub fn retain<F>(&mut self, mut f: F)
 667         where F: FnMut(&T) -> bool
 668     {
 669         let len = self.len();
 670         let mut del = 0;
 671         {
 672             let v = &mut **self;
 673
 674             for i in 0..len {
 675                 if !f(&v[i]) {
 676                     del += 1;
 677                 } else if del > 0 {
 678                     v.swap(i - del, i);
 679                 }
 680             }
 681         }
 682         if del > 0 {
 683             self.truncate(len - del);
 684         }
 685     }
 686
 687     /// Appends an element to the back of a collection.
 688     ///
 689     /// # Panics
 690     ///
 691     /// Panics if the number of elements in the vector overflows a `usize`.
 692     ///
 693     /// # Examples
 694     ///
 695     /// ```
 696     /// let mut vec = vec![1, 2];
 697     /// vec.push(3);
 698     /// assert_eq!(vec, [1, 2, 3]);
 699     /// ```
 700     #[inline]
 701     #[stable(feature = "rust1", since = "1.0.0")]
 702     pub fn push(&mut self, value: T) {
 703         // This will panic or abort if we would allocate > isize::MAX bytes
 704         // or if the length increment would overflow for zero-sized types.
 705         if self.len == self.buf.cap() {
 706             self.buf.double();
 707         }
 708         unsafe {
 709             let end = self.as_mut_ptr().offset(self.len as isize);
 710             ptr::write(end, value);
 711             self.len += 1;
 712         }
 713     }
 714
 715     /// Removes the last element from a vector and returns it, or `None` if it
 716     /// is empty.
 717     ///
 718     /// # Examples
 719     ///
 720     /// ```
 721     /// let mut vec = vec![1, 2, 3];
 722     /// assert_eq!(vec.pop(), Some(3));
 723     /// assert_eq!(vec, [1, 2]);
 724     /// ```
 725     #[inline]
 726     #[stable(feature = "rust1", since = "1.0.0")]
 727     pub fn pop(&mut self) -> Option<T> {
 728         if self.len == 0 {
 729             None
 730         } else {
 731             unsafe {
 732                 self.len -= 1;
 733                 Some(ptr::read(self.get_unchecked(self.len())))
 734             }
 735         }
 736     }
 737
 738     /// Moves all the elements of `other` into `Self`, leaving `other` empty.
 739     ///
 740     /// # Panics
 741     ///
 742     /// Panics if the number of elements in the vector overflows a `usize`.
 743     ///
 744     /// # Examples
 745     ///
 746     /// ```
 747     /// let mut vec = vec![1, 2, 3];
 748     /// let mut vec2 = vec![4, 5, 6];
 749     /// vec.append(&mut vec2);
 750     /// assert_eq!(vec, [1, 2, 3, 4, 5, 6]);
 751     /// assert_eq!(vec2, []);
 752     /// ```
 753     #[inline]
 754     #[stable(feature = "append", since = "1.4.0")]
 755     pub fn append(&mut self, other: &mut Self) {
 756         self.reserve(other.len());
 757         let len = self.len();
 758         unsafe {
 759             ptr::copy_nonoverlapping(other.as_ptr(), self.get_unchecked_mut(len), other.len());
 760         }
 761
 762         self.len += other.len();
 763         unsafe {
 764             other.set_len(0);
 765         }
 766     }
 767
 768     /// Create a draining iterator that removes the specified range in the vector
 769     /// and yields the removed items.
 770     ///
 771     /// Note 1: The element range is removed even if the iterator is not
 772     /// consumed until the end.
 773     ///
 774     /// Note 2: It is unspecified how many elements are removed from the vector,
 775     /// if the `Drain` value is leaked.
 776     ///
 777     /// # Panics
 778     ///
 779     /// Panics if the starting point is greater than the end point or if
 780     /// the end point is greater than the length of the vector.
 781     ///
 782     /// # Examples
 783     ///
 784     /// ```
 785     /// let mut v = vec![1, 2, 3];
 786     /// let u: Vec<_> = v.drain(1..).collect();
 787     /// assert_eq!(v, &[1]);
 788     /// assert_eq!(u, &[2, 3]);
 789     ///
 790     /// // A full range clears the vector
 791     /// v.drain(..);
 792     /// assert_eq!(v, &[]);
 793     /// ```
 794     #[stable(feature = "drain", since = "1.6.0")]
 795     pub fn drain<R>(&mut self, range: R) -> Drain<T>
 796         where R: RangeArgument<usize>
 797     {
 798         // Memory safety
 799         //
 800         // When the Drain is first created, it shortens the length of
 801         // the source vector to make sure no uninitalized or moved-from elements
 802         // are accessible at all if the Drain's destructor never gets to run.
 803         //
 804         // Drain will ptr::read out the values to remove.
 805         // When finished, remaining tail of the vec is copied back to cover
 806         // the hole, and the vector length is restored to the new length.
 807         //
 808         let len = self.len();
 809         let start = *range.start().unwrap_or(&0);
 810         let end = *range.end().unwrap_or(&len);
 811         assert!(start <= end);
 812         assert!(end <= len);
 813
 814         unsafe {
 815             // set self.vec length's to start, to be safe in case Drain is leaked
 816             self.set_len(start);
 817             // Use the borrow in the IterMut to indicate borrowing behavior of the
 818             // whole Drain iterator (like &mut T).
 819             let range_slice = slice::from_raw_parts_mut(self.as_mut_ptr().offset(start as isize),
 820                                                         end - start);
 821             Drain {
 822                 tail_start: end,
 823                 tail_len: len - end,
 824                 iter: range_slice.iter_mut(),
 825                 vec: self as *mut _,
 826             }
 827         }
 828     }
 829
 830     /// Clears the vector, removing all values.
 831     ///
 832     /// # Examples
 833     ///
 834     /// ```
 835     /// let mut v = vec![1, 2, 3];
 836     ///
 837     /// v.clear();
 838     ///
 839     /// assert!(v.is_empty());
 840     /// ```
 841     #[inline]
 842     #[stable(feature = "rust1", since = "1.0.0")]
 843     pub fn clear(&mut self) {
 844         self.truncate(0)
 845     }
 846
 847     /// Returns the number of elements in the vector.
 848     ///
 849     /// # Examples
 850     ///
 851     /// ```
 852     /// let a = vec![1, 2, 3];
 853     /// assert_eq!(a.len(), 3);
 854     /// ```
 855     #[inline]
 856     #[stable(feature = "rust1", since = "1.0.0")]
 857     pub fn len(&self) -> usize {
 858         self.len
 859     }
 860
 861     /// Returns `true` if the vector contains no elements.
 862     ///
 863     /// # Examples
 864     ///
 865     /// ```
 866     /// let mut v = Vec::new();
 867     /// assert!(v.is_empty());
 868     ///
 869     /// v.push(1);
 870     /// assert!(!v.is_empty());
 871     /// ```
 872     #[stable(feature = "rust1", since = "1.0.0")]
 873     pub fn is_empty(&self) -> bool {
 874         self.len() == 0
 875     }
 876
 877     /// Splits the collection into two at the given index.
 878     ///
 879     /// Returns a newly allocated `Self`. `self` contains elements `[0, at)`,
 880     /// and the returned `Self` contains elements `[at, len)`.
 881     ///
 882     /// Note that the capacity of `self` does not change.
 883     ///
 884     /// # Panics
 885     ///
 886     /// Panics if `at > len`.
 887     ///
 888     /// # Examples
 889     ///
 890     /// ```
 891     /// let mut vec = vec![1,2,3];
 892     /// let vec2 = vec.split_off(1);
 893     /// assert_eq!(vec, [1]);
 894     /// assert_eq!(vec2, [2, 3]);
 895     /// ```
 896     #[inline]
 897     #[stable(feature = "split_off", since = "1.4.0")]
 898     pub fn split_off(&mut self, at: usize) -> Self {
 899         assert!(at <= self.len(), "`at` out of bounds");
 900
 901         let other_len = self.len - at;
 902         let mut other = Vec::with_capacity(other_len);
 903
 904         // Unsafely `set_len` and copy items to `other`.
 905         unsafe {
 906             self.set_len(at);
 907             other.set_len(other_len);
 908
 909             ptr::copy_nonoverlapping(self.as_ptr().offset(at as isize),
 910                                      other.as_mut_ptr(),
 911                                      other.len());
 912         }
 913         other
 914     }
 915 }
 916
 917 impl<T: Clone> Vec<T> {
 918     /// Resizes the `Vec` in-place so that `len()` is equal to `new_len`.
 919     ///
 920     /// If `new_len` is greater than `len()`, the `Vec` is extended by the
 921     /// difference, with each additional slot filled with `value`.
 922     /// If `new_len` is less than `len()`, the `Vec` is simply truncated.
 923     ///
 924     /// # Examples
 925     ///
 926     /// ```
 927     /// let mut vec = vec!["hello"];
 928     /// vec.resize(3, "world");
 929     /// assert_eq!(vec, ["hello", "world", "world"]);
 930     ///
 931     /// let mut vec = vec![1, 2, 3, 4];
 932     /// vec.resize(2, 0);
 933     /// assert_eq!(vec, [1, 2]);
 934     /// ```
 935     #[stable(feature = "vec_resize", since = "1.5.0")]
 936     pub fn resize(&mut self, new_len: usize, value: T) {
 937         let len = self.len();
 938
 939         if new_len > len {
 940             self.extend_with_element(new_len - len, value);
 941         } else {
 942             self.truncate(new_len);
 943         }
 944     }
 945
 946     /// Extend the vector by `n` additional clones of `value`.
 947     fn extend_with_element(&mut self, n: usize, value: T) {
 948         self.reserve(n);
 949
 950         unsafe {
 951             let len = self.len();
 952             let mut ptr = self.as_mut_ptr().offset(len as isize);
 953             // Write all elements except the last one
 954             for i in 1..n {
 955                 ptr::write(ptr, value.clone());
 956                 ptr = ptr.offset(1);
 957                 // Increment the length in every step in case clone() panics
 958                 self.set_len(len + i);
 959             }
 960
 961             if n > 0 {
 962                 // We can write the last element directly without cloning needlessly
 963                 ptr::write(ptr, value);
 964                 self.set_len(len + n);
 965             }
 966         }
 967     }
 968
 969     #[allow(missing_docs)]
 970     #[inline]
 971     #[unstable(feature = "vec_push_all",
 972                reason = "likely to be replaced by a more optimized extend",
 973                issue = "27744")]
 974     #[rustc_deprecated(reason = "renamed to extend_from_slice",
 975                        since = "1.6.0")]
 976     pub fn push_all(&mut self, other: &[T]) {
 977         self.extend_from_slice(other)
 978     }
 979
 980     /// Appends all elements in a slice to the `Vec`.
 981     ///
 982     /// Iterates over the slice `other`, clones each element, and then appends
 983     /// it to this `Vec`. The `other` vector is traversed in-order.
 984     ///
 985     /// Note that this function is same as `extend` except that it is
 986     /// specialized to work with slices instead. If and when Rust gets
 987     /// specialization this function will likely be deprecated (but still
 988     /// available).
 989     ///
 990     /// # Examples
 991     ///
 992     /// ```
 993     /// let mut vec = vec![1];
 994     /// vec.extend_from_slice(&[2, 3, 4]);
 995     /// assert_eq!(vec, [1, 2, 3, 4]);
 996     /// ```
 997     #[stable(feature = "vec_extend_from_slice", since = "1.6.0")]
 998     pub fn extend_from_slice(&mut self, other: &[T]) {
 999         self.reserve(other.len());
1000
1001         for i in 0..other.len() {
1002             let len = self.len();
1003
1004             // Unsafe code so this can be optimised to a memcpy (or something
1005             // similarly fast) when T is Copy. LLVM is easily confused, so any
1006             // extra operations during the loop can prevent this optimisation.
1007             unsafe {
1008                 ptr::write(self.get_unchecked_mut(len), other.get_unchecked(i).clone());
1009                 self.set_len(len + 1);
1010             }
1011         }
1012     }
1013 }
1014
1015 impl<T: PartialEq> Vec<T> {
1016     /// Removes consecutive repeated elements in the vector.
1017     ///
1018     /// If the vector is sorted, this removes all duplicates.
1019     ///
1020     /// # Examples
1021     ///
1022     /// ```
1023     /// let mut vec = vec![1, 2, 2, 3, 2];
1024     ///
1025     /// vec.dedup();
1026     ///
1027     /// assert_eq!(vec, [1, 2, 3, 2]);
1028     /// ```
1029     #[stable(feature = "rust1", since = "1.0.0")]
1030     pub fn dedup(&mut self) {
1031         unsafe {
1032             // Although we have a mutable reference to `self`, we cannot make
1033             // *arbitrary* changes. The `PartialEq` comparisons could panic, so we
1034             // must ensure that the vector is in a valid state at all time.
1035             //
1036             // The way that we handle this is by using swaps; we iterate
1037             // over all the elements, swapping as we go so that at the end
1038             // the elements we wish to keep are in the front, and those we
1039             // wish to reject are at the back. We can then truncate the
1040             // vector. This operation is still O(n).
1041             //
1042             // Example: We start in this state, where `r` represents "next
1043             // read" and `w` represents "next_write`.
1044             //
1045             //           r
1046             //     +---+---+---+---+---+---+
1047             //     | 0 | 1 | 1 | 2 | 3 | 3 |
1048             //     +---+---+---+---+---+---+
1049             //           w
1050             //
1051             // Comparing self[r] against self[w-1], this is not a duplicate, so
1052             // we swap self[r] and self[w] (no effect as r==w) and then increment both
1053             // r and w, leaving us with:
1054             //
1055             //               r
1056             //     +---+---+---+---+---+---+
1057             //     | 0 | 1 | 1 | 2 | 3 | 3 |
1058             //     +---+---+---+---+---+---+
1059             //               w
1060             //
1061             // Comparing self[r] against self[w-1], this value is a duplicate,
1062             // so we increment `r` but leave everything else unchanged:
1063             //
1064             //                   r
1065             //     +---+---+---+---+---+---+
1066             //     | 0 | 1 | 1 | 2 | 3 | 3 |
1067             //     +---+---+---+---+---+---+
1068             //               w
1069             //
1070             // Comparing self[r] against self[w-1], this is not a duplicate,
1071             // so swap self[r] and self[w] and advance r and w:
1072             //
1073             //                       r
1074             //     +---+---+---+---+---+---+
1075             //     | 0 | 1 | 2 | 1 | 3 | 3 |
1076             //     +---+---+---+---+---+---+
1077             //                   w
1078             //
1079             // Not a duplicate, repeat:
1080             //
1081             //                           r
1082             //     +---+---+---+---+---+---+
1083             //     | 0 | 1 | 2 | 3 | 1 | 3 |
1084             //     +---+---+---+---+---+---+
1085             //                       w
1086             //
1087             // Duplicate, advance r. End of vec. Truncate to w.
1088
1089             let ln = self.len();
1090             if ln <= 1 {
1091                 return;
1092             }
1093
1094             // Avoid bounds checks by using raw pointers.
1095             let p = self.as_mut_ptr();
1096             let mut r: usize = 1;
1097             let mut w: usize = 1;
1098
1099             while r < ln {
1100                 let p_r = p.offset(r as isize);
1101                 let p_wm1 = p.offset((w - 1) as isize);
1102                 if *p_r != *p_wm1 {
1103                     if r != w {
1104                         let p_w = p_wm1.offset(1);
1105                         mem::swap(&mut *p_r, &mut *p_w);
1106                     }
1107                     w += 1;
1108                 }
1109                 r += 1;
1110             }
1111
1112             self.truncate(w);
1113         }
1114     }
1115 }
1116
1117 ////////////////////////////////////////////////////////////////////////////////
1118 // Internal methods and functions
1119 ////////////////////////////////////////////////////////////////////////////////
1120
1121 #[doc(hidden)]
1122 #[stable(feature = "rust1", since = "1.0.0")]
1123 pub fn from_elem<T: Clone>(elem: T, n: usize) -> Vec<T> {
1124     let mut v = Vec::with_capacity(n);
1125     v.extend_with_element(n, elem);
1126     v
1127 }
1128
1129 ////////////////////////////////////////////////////////////////////////////////
1130 // Common trait implementations for Vec
1131 ////////////////////////////////////////////////////////////////////////////////
1132
1133 #[stable(feature = "rust1", since = "1.0.0")]
1134 impl<T: Clone> Clone for Vec<T> {
1135     #[cfg(not(test))]
1136     fn clone(&self) -> Vec<T> {
1137         <[T]>::to_vec(&**self)
1138     }
1139
1140     // HACK(japaric): with cfg(test) the inherent `[T]::to_vec` method, which is
1141     // required for this method definition, is not available. Instead use the
1142     // `slice::to_vec`  function which is only available with cfg(test)
1143     // NB see the slice::hack module in slice.rs for more information
1144     #[cfg(test)]
1145     fn clone(&self) -> Vec<T> {
1146         ::slice::to_vec(&**self)
1147     }
1148
1149     fn clone_from(&mut self, other: &Vec<T>) {
1150         // drop anything in self that will not be overwritten
1151         self.truncate(other.len());
1152         let len = self.len();
1153
1154         // reuse the contained values' allocations/resources.
1155         self.clone_from_slice(&other[..len]);
1156
1157         // self.len <= other.len due to the truncate above, so the
1158         // slice here is always in-bounds.
1159         self.extend_from_slice(&other[len..]);
1160     }
1161 }
1162
1163 #[stable(feature = "rust1", since = "1.0.0")]
1164 impl<T: Hash> Hash for Vec<T> {
1165     #[inline]
1166     fn hash<H: hash::Hasher>(&self, state: &mut H) {
1167         Hash::hash(&**self, state)
1168     }
1169 }
1170
1171 #[stable(feature = "rust1", since = "1.0.0")]
1172 impl<T> Index<usize> for Vec<T> {
1173     type Output = T;
1174
1175     #[inline]
1176     fn index(&self, index: usize) -> &T {
1177         // NB built-in indexing via `&[T]`
1178         &(**self)[index]
1179     }
1180 }
1181
1182 #[stable(feature = "rust1", since = "1.0.0")]
1183 impl<T> IndexMut<usize> for Vec<T> {
1184     #[inline]
1185     fn index_mut(&mut self, index: usize) -> &mut T {
1186         // NB built-in indexing via `&mut [T]`
1187         &mut (**self)[index]
1188     }
1189 }
1190
1191
1192 #[stable(feature = "rust1", since = "1.0.0")]
1193 impl<T> ops::Index<ops::Range<usize>> for Vec<T> {
1194     type Output = [T];
1195
1196     #[inline]
1197     fn index(&self, index: ops::Range<usize>) -> &[T] {
1198         Index::index(&**self, index)
1199     }
1200 }
1201 #[stable(feature = "rust1", since = "1.0.0")]
1202 impl<T> ops::Index<ops::RangeTo<usize>> for Vec<T> {
1203     type Output = [T];
1204
1205     #[inline]
1206     fn index(&self, index: ops::RangeTo<usize>) -> &[T] {
1207         Index::index(&**self, index)
1208     }
1209 }
1210 #[stable(feature = "rust1", since = "1.0.0")]
1211 impl<T> ops::Index<ops::RangeFrom<usize>> for Vec<T> {
1212     type Output = [T];
1213
1214     #[inline]
1215     fn index(&self, index: ops::RangeFrom<usize>) -> &[T] {
1216         Index::index(&**self, index)
1217     }
1218 }
1219 #[stable(feature = "rust1", since = "1.0.0")]
1220 impl<T> ops::Index<ops::RangeFull> for Vec<T> {
1221     type Output = [T];
1222
1223     #[inline]
1224     fn index(&self, _index: ops::RangeFull) -> &[T] {
1225         self
1226     }
1227 }
1228
1229 #[stable(feature = "rust1", since = "1.0.0")]
1230 impl<T> ops::IndexMut<ops::Range<usize>> for Vec<T> {
1231     #[inline]
1232     fn index_mut(&mut self, index: ops::Range<usize>) -> &mut [T] {
1233         IndexMut::index_mut(&mut **self, index)
1234     }
1235 }
1236 #[stable(feature = "rust1", since = "1.0.0")]
1237 impl<T> ops::IndexMut<ops::RangeTo<usize>> for Vec<T> {
1238     #[inline]
1239     fn index_mut(&mut self, index: ops::RangeTo<usize>) -> &mut [T] {
1240         IndexMut::index_mut(&mut **self, index)
1241     }
1242 }
1243 #[stable(feature = "rust1", since = "1.0.0")]
1244 impl<T> ops::IndexMut<ops::RangeFrom<usize>> for Vec<T> {
1245     #[inline]
1246     fn index_mut(&mut self, index: ops::RangeFrom<usize>) -> &mut [T] {
1247         IndexMut::index_mut(&mut **self, index)
1248     }
1249 }
1250 #[stable(feature = "rust1", since = "1.0.0")]
1251 impl<T> ops::IndexMut<ops::RangeFull> for Vec<T> {
1252     #[inline]
1253     fn index_mut(&mut self, _index: ops::RangeFull) -> &mut [T] {
1254         self
1255     }
1256 }
1257
1258 #[stable(feature = "rust1", since = "1.0.0")]
1259 impl<T> ops::Deref for Vec<T> {
1260     type Target = [T];
1261
1262     fn deref(&self) -> &[T] {
1263         unsafe {
1264             let p = self.buf.ptr();
1265             assume(!p.is_null());
1266             slice::from_raw_parts(p, self.len)
1267         }
1268     }
1269 }
1270
1271 #[stable(feature = "rust1", since = "1.0.0")]
1272 impl<T> ops::DerefMut for Vec<T> {
1273     fn deref_mut(&mut self) -> &mut [T] {
1274         unsafe {
1275             let ptr = self.buf.ptr();
1276             assume(!ptr.is_null());
1277             slice::from_raw_parts_mut(ptr, self.len)
1278         }
1279     }
1280 }
1281
1282 #[stable(feature = "rust1", since = "1.0.0")]
1283 impl<T> FromIterator<T> for Vec<T> {
1284     #[inline]
1285     fn from_iter<I: IntoIterator<Item = T>>(iterable: I) -> Vec<T> {
1286         // Unroll the first iteration, as the vector is going to be
1287         // expanded on this iteration in every case when the iterable is not
1288         // empty, but the loop in extend_desugared() is not going to see the
1289         // vector being full in the few subsequent loop iterations.
1290         // So we get better branch prediction.
1291         let mut iterator = iterable.into_iter();
1292         let mut vector = match iterator.next() {
1293             None => return Vec::new(),
1294             Some(element) => {
1295                 let (lower, _) = iterator.size_hint();
1296                 let mut vector = Vec::with_capacity(lower.saturating_add(1));
1297                 unsafe {
1298                     ptr::write(vector.get_unchecked_mut(0), element);
1299                     vector.set_len(1);
1300                 }
1301                 vector
1302             }
1303         };
1304         vector.extend_desugared(iterator);
1305         vector
1306     }
1307 }
1308
1309 #[stable(feature = "rust1", since = "1.0.0")]
1310 impl<T> IntoIterator for Vec<T> {
1311     type Item = T;
1312     type IntoIter = IntoIter<T>;
1313
1314     /// Creates a consuming iterator, that is, one that moves each value out of
1315     /// the vector (from start to end). The vector cannot be used after calling
1316     /// this.
1317     ///
1318     /// # Examples
1319     ///
1320     /// ```
1321     /// let v = vec!["a".to_string(), "b".to_string()];
1322     /// for s in v.into_iter() {
1323     ///     // s has type String, not &String
1324     ///     println!("{}", s);
1325     /// }
1326     /// ```
1327     #[inline]
1328     fn into_iter(mut self) -> IntoIter<T> {
1329         unsafe {
1330             let ptr = self.as_mut_ptr();
1331             assume(!ptr.is_null());
1332             let begin = ptr as *const T;
1333             let end = if mem::size_of::<T>() == 0 {
1334                 arith_offset(ptr as *const i8, self.len() as isize) as *const T
1335             } else {
1336                 ptr.offset(self.len() as isize) as *const T
1337             };
1338             let buf = ptr::read(&self.buf);
1339             mem::forget(self);
1340             IntoIter {
1341                 _buf: buf,
1342                 ptr: begin,
1343                 end: end,
1344             }
1345         }
1346     }
1347 }
1348
1349 #[stable(feature = "rust1", since = "1.0.0")]
1350 impl<'a, T> IntoIterator for &'a Vec<T> {
1351     type Item = &'a T;
1352     type IntoIter = slice::Iter<'a, T>;
1353
1354     fn into_iter(self) -> slice::Iter<'a, T> {
1355         self.iter()
1356     }
1357 }
1358
1359 #[stable(feature = "rust1", since = "1.0.0")]
1360 impl<'a, T> IntoIterator for &'a mut Vec<T> {
1361     type Item = &'a mut T;
1362     type IntoIter = slice::IterMut<'a, T>;
1363
1364     fn into_iter(mut self) -> slice::IterMut<'a, T> {
1365         self.iter_mut()
1366     }
1367 }
1368
1369 #[stable(feature = "rust1", since = "1.0.0")]
1370 impl<T> Extend<T> for Vec<T> {
1371     #[inline]
1372     fn extend<I: IntoIterator<Item = T>>(&mut self, iterable: I) {
1373         self.extend_desugared(iterable.into_iter())
1374     }
1375 }
1376
1377 impl<T> Vec<T> {
1378     fn extend_desugared<I: Iterator<Item = T>>(&mut self, mut iterator: I) {
1379         // This function should be the moral equivalent of:
1380         //
1381         //      for item in iterator {
1382         //          self.push(item);
1383         //      }
1384         while let Some(element) = iterator.next() {
1385             let len = self.len();
1386             if len == self.capacity() {
1387                 let (lower, _) = iterator.size_hint();
1388                 self.reserve(lower.saturating_add(1));
1389             }
1390             unsafe {
1391                 ptr::write(self.get_unchecked_mut(len), element);
1392                 // NB can't overflow since we would have had to alloc the address space
1393                 self.set_len(len + 1);
1394             }
1395         }
1396     }
1397 }
1398
1399 #[stable(feature = "extend_ref", since = "1.2.0")]
1400 impl<'a, T: 'a + Copy> Extend<&'a T> for Vec<T> {
1401     fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I) {
1402         self.extend(iter.into_iter().cloned());
1403     }
1404 }
1405
1406 macro_rules! __impl_slice_eq1 {
1407     ($Lhs: ty, $Rhs: ty) => {
1408         __impl_slice_eq1! { $Lhs, $Rhs, Sized }
1409     };
1410     ($Lhs: ty, $Rhs: ty, $Bound: ident) => {
1411         #[stable(feature = "rust1", since = "1.0.0")]
1412         impl<'a, 'b, A: $Bound, B> PartialEq<$Rhs> for $Lhs where A: PartialEq<B> {
1413             #[inline]
1414             fn eq(&self, other: &$Rhs) -> bool { self[..] == other[..] }
1415             #[inline]
1416             fn ne(&self, other: &$Rhs) -> bool { self[..] != other[..] }
1417         }
1418     }
1419 }
1420
1421 __impl_slice_eq1! { Vec<A>, Vec<B> }
1422 __impl_slice_eq1! { Vec<A>, &'b [B] }
1423 __impl_slice_eq1! { Vec<A>, &'b mut [B] }
1424 __impl_slice_eq1! { Cow<'a, [A]>, &'b [B], Clone }
1425 __impl_slice_eq1! { Cow<'a, [A]>, &'b mut [B], Clone }
1426 __impl_slice_eq1! { Cow<'a, [A]>, Vec<B>, Clone }
1427
1428 macro_rules! array_impls {
1429     ($($N: expr)+) => {
1430         $(
1431             // NOTE: some less important impls are omitted to reduce code bloat
1432             __impl_slice_eq1! { Vec<A>, [B; $N] }
1433             __impl_slice_eq1! { Vec<A>, &'b [B; $N] }
1434             // __impl_slice_eq1! { Vec<A>, &'b mut [B; $N] }
1435             // __impl_slice_eq1! { Cow<'a, [A]>, [B; $N], Clone }
1436             // __impl_slice_eq1! { Cow<'a, [A]>, &'b [B; $N], Clone }
1437             // __impl_slice_eq1! { Cow<'a, [A]>, &'b mut [B; $N], Clone }
1438         )+
1439     }
1440 }
1441
1442 array_impls! {
1443      0  1  2  3  4  5  6  7  8  9
1444     10 11 12 13 14 15 16 17 18 19
1445     20 21 22 23 24 25 26 27 28 29
1446     30 31 32
1447 }
1448
1449 #[stable(feature = "rust1", since = "1.0.0")]
1450 impl<T: PartialOrd> PartialOrd for Vec<T> {
1451     #[inline]
1452     fn partial_cmp(&self, other: &Vec<T>) -> Option<Ordering> {
1453         PartialOrd::partial_cmp(&**self, &**other)
1454     }
1455 }
1456
1457 #[stable(feature = "rust1", since = "1.0.0")]
1458 impl<T: Eq> Eq for Vec<T> {}
1459
1460 #[stable(feature = "rust1", since = "1.0.0")]
1461 impl<T: Ord> Ord for Vec<T> {
1462     #[inline]
1463     fn cmp(&self, other: &Vec<T>) -> Ordering {
1464         Ord::cmp(&**self, &**other)
1465     }
1466 }
1467
1468 #[stable(feature = "rust1", since = "1.0.0")]
1469 impl<T> Drop for Vec<T> {
1470     #[unsafe_destructor_blind_to_params]
1471     fn drop(&mut self) {
1472         if self.buf.unsafe_no_drop_flag_needs_drop() {
1473             unsafe {
1474                 // The branch on needs_drop() is an -O1 performance optimization.
1475                 // Without the branch, dropping Vec<u8> takes linear time.
1476                 if needs_drop::<T>() {
1477                     for x in self.iter_mut() {
1478                         ptr::drop_in_place(x);
1479                     }
1480                 }
1481             }
1482         }
1483         // RawVec handles deallocation
1484     }
1485 }
1486
1487 #[stable(feature = "rust1", since = "1.0.0")]
1488 impl<T> Default for Vec<T> {
1489     fn default() -> Vec<T> {
1490         Vec::new()
1491     }
1492 }
1493
1494 #[stable(feature = "rust1", since = "1.0.0")]
1495 impl<T: fmt::Debug> fmt::Debug for Vec<T> {
1496     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1497         fmt::Debug::fmt(&**self, f)
1498     }
1499 }
1500
1501 #[stable(feature = "rust1", since = "1.0.0")]
1502 impl<T> AsRef<Vec<T>> for Vec<T> {
1503     fn as_ref(&self) -> &Vec<T> {
1504         self
1505     }
1506 }
1507
1508 #[stable(feature = "vec_as_mut", since = "1.5.0")]
1509 impl<T> AsMut<Vec<T>> for Vec<T> {
1510     fn as_mut(&mut self) -> &mut Vec<T> {
1511         self
1512     }
1513 }
1514
1515 #[stable(feature = "rust1", since = "1.0.0")]
1516 impl<T> AsRef<[T]> for Vec<T> {
1517     fn as_ref(&self) -> &[T] {
1518         self
1519     }
1520 }
1521
1522 #[stable(feature = "vec_as_mut", since = "1.5.0")]
1523 impl<T> AsMut<[T]> for Vec<T> {
1524     fn as_mut(&mut self) -> &mut [T] {
1525         self
1526     }
1527 }
1528
1529 #[stable(feature = "rust1", since = "1.0.0")]
1530 impl<'a, T: Clone> From<&'a [T]> for Vec<T> {
1531     #[cfg(not(test))]
1532     fn from(s: &'a [T]) -> Vec<T> {
1533         s.to_vec()
1534     }
1535     #[cfg(test)]
1536     fn from(s: &'a [T]) -> Vec<T> {
1537         ::slice::to_vec(s)
1538     }
1539 }
1540
1541 #[stable(feature = "rust1", since = "1.0.0")]
1542 impl<'a> From<&'a str> for Vec<u8> {
1543     fn from(s: &'a str) -> Vec<u8> {
1544         From::from(s.as_bytes())
1545     }
1546 }
1547
1548 ////////////////////////////////////////////////////////////////////////////////
1549 // Clone-on-write
1550 ////////////////////////////////////////////////////////////////////////////////
1551
1552 #[stable(feature = "cow_from_vec", since = "1.7.0")]
1553 impl<'a, T: Clone> From<&'a [T]> for Cow<'a, [T]> {
1554     fn from(s: &'a [T]) -> Cow<'a, [T]> {
1555         Cow::Borrowed(s)
1556     }
1557 }
1558
1559 #[stable(feature = "cow_from_vec", since = "1.7.0")]
1560 impl<'a, T: Clone> From<Vec<T>> for Cow<'a, [T]> {
1561     fn from(v: Vec<T>) -> Cow<'a, [T]> {
1562         Cow::Owned(v)
1563     }
1564 }
1565
1566 #[stable(feature = "rust1", since = "1.0.0")]
1567 impl<'a, T> FromIterator<T> for Cow<'a, [T]> where T: Clone {
1568     fn from_iter<I: IntoIterator<Item = T>>(it: I) -> Cow<'a, [T]> {
1569         Cow::Owned(FromIterator::from_iter(it))
1570     }
1571 }
1572
1573 #[stable(feature = "rust1", since = "1.0.0")]
1574 #[allow(deprecated)]
1575 impl<'a, T: 'a> IntoCow<'a, [T]> for Vec<T> where T: Clone {
1576     fn into_cow(self) -> Cow<'a, [T]> {
1577         Cow::Owned(self)
1578     }
1579 }
1580
1581 #[stable(feature = "rust1", since = "1.0.0")]
1582 #[allow(deprecated)]
1583 impl<'a, T> IntoCow<'a, [T]> for &'a [T] where T: Clone {
1584     fn into_cow(self) -> Cow<'a, [T]> {
1585         Cow::Borrowed(self)
1586     }
1587 }
1588
1589 ////////////////////////////////////////////////////////////////////////////////
1590 // Iterators
1591 ////////////////////////////////////////////////////////////////////////////////
1592
1593 /// An iterator that moves out of a vector.
1594 #[stable(feature = "rust1", since = "1.0.0")]
1595 pub struct IntoIter<T> {
1596     _buf: RawVec<T>,
1597     ptr: *const T,
1598     end: *const T,
1599 }
1600
1601 #[stable(feature = "rust1", since = "1.0.0")]
1602 unsafe impl<T: Send> Send for IntoIter<T> {}
1603 #[stable(feature = "rust1", since = "1.0.0")]
1604 unsafe impl<T: Sync> Sync for IntoIter<T> {}
1605
1606 #[stable(feature = "rust1", since = "1.0.0")]
1607 impl<T> Iterator for IntoIter<T> {
1608     type Item = T;
1609
1610     #[inline]
1611     fn next(&mut self) -> Option<T> {
1612         unsafe {
1613             if self.ptr == self.end {
1614                 None
1615             } else {
1616                 if mem::size_of::<T>() == 0 {
1617                     // purposefully don't use 'ptr.offset' because for
1618                     // vectors with 0-size elements this would return the
1619                     // same pointer.
1620                     self.ptr = arith_offset(self.ptr as *const i8, 1) as *const T;
1621
1622                     // Use a non-null pointer value
1623                     Some(ptr::read(EMPTY as *mut T))
1624                 } else {
1625                     let old = self.ptr;
1626                     self.ptr = self.ptr.offset(1);
1627
1628                     Some(ptr::read(old))
1629                 }
1630             }
1631         }
1632     }
1633
1634     #[inline]
1635     fn size_hint(&self) -> (usize, Option<usize>) {
1636         let diff = (self.end as usize) - (self.ptr as usize);
1637         let size = mem::size_of::<T>();
1638         let exact = diff /
1639                     (if size == 0 {
1640                          1
1641                      } else {
1642                          size
1643                      });
1644         (exact, Some(exact))
1645     }
1646
1647     #[inline]
1648     fn count(self) -> usize {
1649         self.size_hint().0
1650     }
1651 }
1652
1653 #[stable(feature = "rust1", since = "1.0.0")]
1654 impl<T> DoubleEndedIterator for IntoIter<T> {
1655     #[inline]
1656     fn next_back(&mut self) -> Option<T> {
1657         unsafe {
1658             if self.end == self.ptr {
1659                 None
1660             } else {
1661                 if mem::size_of::<T>() == 0 {
1662                     // See above for why 'ptr.offset' isn't used
1663                     self.end = arith_offset(self.end as *const i8, -1) as *const T;
1664
1665                     // Use a non-null pointer value
1666                     Some(ptr::read(EMPTY as *mut T))
1667                 } else {
1668                     self.end = self.end.offset(-1);
1669
1670                     Some(ptr::read(self.end))
1671                 }
1672             }
1673         }
1674     }
1675 }
1676
1677 #[stable(feature = "rust1", since = "1.0.0")]
1678 impl<T> ExactSizeIterator for IntoIter<T> {}
1679
1680 #[stable(feature = "vec_into_iter_clone", since = "1.8.0")]
1681 impl<T: Clone> Clone for IntoIter<T> {
1682     fn clone(&self) -> IntoIter<T> {
1683         unsafe {
1684             slice::from_raw_parts(self.ptr, self.len()).to_owned().into_iter()
1685         }
1686     }
1687 }
1688
1689 #[stable(feature = "rust1", since = "1.0.0")]
1690 impl<T> Drop for IntoIter<T> {
1691     #[unsafe_destructor_blind_to_params]
1692     fn drop(&mut self) {
1693         // destroy the remaining elements
1694         for _x in self {}
1695
1696         // RawVec handles deallocation
1697     }
1698 }
1699
1700 /// A draining iterator for `Vec<T>`.
1701 #[stable(feature = "drain", since = "1.6.0")]
1702 pub struct Drain<'a, T: 'a> {
1703     /// Index of tail to preserve
1704     tail_start: usize,
1705     /// Length of tail
1706     tail_len: usize,
1707     /// Current remaining range to remove
1708     iter: slice::IterMut<'a, T>,
1709     vec: *mut Vec<T>,
1710 }
1711
1712 #[stable(feature = "drain", since = "1.6.0")]
1713 unsafe impl<'a, T: Sync> Sync for Drain<'a, T> {}
1714 #[stable(feature = "drain", since = "1.6.0")]
1715 unsafe impl<'a, T: Send> Send for Drain<'a, T> {}
1716
1717 #[stable(feature = "rust1", since = "1.0.0")]
1718 impl<'a, T> Iterator for Drain<'a, T> {
1719     type Item = T;
1720
1721     #[inline]
1722     fn next(&mut self) -> Option<T> {
1723         self.iter.next().map(|elt| unsafe { ptr::read(elt as *const _) })
1724     }
1725
1726     fn size_hint(&self) -> (usize, Option<usize>) {
1727         self.iter.size_hint()
1728     }
1729 }
1730
1731 #[stable(feature = "rust1", since = "1.0.0")]
1732 impl<'a, T> DoubleEndedIterator for Drain<'a, T> {
1733     #[inline]
1734     fn next_back(&mut self) -> Option<T> {
1735         self.iter.next_back().map(|elt| unsafe { ptr::read(elt as *const _) })
1736     }
1737 }
1738
1739 #[stable(feature = "rust1", since = "1.0.0")]
1740 impl<'a, T> Drop for Drain<'a, T> {
1741     fn drop(&mut self) {
1742         // exhaust self first
1743         while let Some(_) = self.next() {}
1744
1745         if self.tail_len > 0 {
1746             unsafe {
1747                 let source_vec = &mut *self.vec;
1748                 // memmove back untouched tail, update to new length
1749                 let start = source_vec.len();
1750                 let tail = self.tail_start;
1751                 let src = source_vec.as_ptr().offset(tail as isize);
1752                 let dst = source_vec.as_mut_ptr().offset(start as isize);
1753                 ptr::copy(src, dst, self.tail_len);
1754                 source_vec.set_len(start + self.tail_len);
1755             }
1756         }
1757     }
1758 }
1759
1760
1761 #[stable(feature = "rust1", since = "1.0.0")]
1762 impl<'a, T> ExactSizeIterator for Drain<'a, T> {}