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 growable list type with heap-allocated contents, written `Vec<T>` but pronounced 'vector.'
  12 //!
  13 //! Vectors have `O(1)` indexing, push (to the end) and pop (from the end).
  14 //!
  15 //! # Examples
  16 //!
  17 //! Explicitly creating a `Vec<T>` with `new()`:
  18 //!
  19 //! ```
  20 //! let xs: Vec<i32> = Vec::new();
  21 //! ```
  22 //!
  23 //! Using the `vec!` macro:
  24 //!
  25 //! ```
  26 //! let ys: Vec<i32> = vec![];
  27 //!
  28 //! let zs = vec![1i32, 2, 3, 4, 5];
  29 //! ```
  30 //!
  31 //! Push:
  32 //!
  33 //! ```
  34 //! let mut xs = vec![1i32, 2];
  35 //!
  36 //! xs.push(3);
  37 //! ```
  38 //!
  39 //! And pop:
  40 //!
  41 //! ```
  42 //! let mut xs = vec![1i32, 2];
  43 //!
  44 //! let two = xs.pop();
  45 //! ```
  46
  47 #![stable(feature = "rust1", since = "1.0.0")]
  48
  49 use core::prelude::*;
  50
  51 use alloc::boxed::Box;
  52 use alloc::heap::{EMPTY, allocate, reallocate, deallocate};
  53 use core::borrow::{Cow, IntoCow};
  54 use core::cmp::max;
  55 use core::cmp::{Ordering};
  56 use core::default::Default;
  57 use core::fmt;
  58 use core::hash::{self, Hash};
  59 use core::iter::{repeat, FromIterator, IntoIterator};
  60 use core::marker::{ContravariantLifetime, InvariantType};
  61 use core::mem;
  62 use core::nonzero::NonZero;
  63 use core::num::{Int, UnsignedInt};
  64 use core::ops::{Index, IndexMut, Deref, Add};
  65 use core::ops;
  66 use core::ptr;
  67 use core::raw::Slice as RawSlice;
  68 use core::slice;
  69 use core::usize;
  70
  71 /// A growable list type, written `Vec<T>` but pronounced 'vector.'
  72 ///
  73 /// # Examples
  74 ///
  75 /// ```
  76 /// let mut vec = Vec::new();
  77 /// vec.push(1);
  78 /// vec.push(2);
  79 ///
  80 /// assert_eq!(vec.len(), 2);
  81 /// assert_eq!(vec[0], 1);
  82 ///
  83 /// assert_eq!(vec.pop(), Some(2));
  84 /// assert_eq!(vec.len(), 1);
  85 ///
  86 /// vec[0] = 7;
  87 /// assert_eq!(vec[0], 7);
  88 ///
  89 /// vec.push_all(&[1, 2, 3]);
  90 ///
  91 /// for x in vec.iter() {
  92 ///     println!("{}", x);
  93 /// }
  94 /// assert_eq!(vec, vec![7, 1, 2, 3]);
  95 /// ```
  96 ///
  97 /// The `vec!` macro is provided to make initialization more convenient:
  98 ///
  99 /// ```
 100 /// let mut vec = vec![1, 2, 3];
 101 /// vec.push(4);
 102 /// assert_eq!(vec, vec![1, 2, 3, 4]);
 103 /// ```
 104 ///
 105 /// Use a `Vec<T>` as an efficient stack:
 106 ///
 107 /// ```
 108 /// let mut stack = Vec::new();
 109 ///
 110 /// stack.push(1);
 111 /// stack.push(2);
 112 /// stack.push(3);
 113 ///
 114 /// loop {
 115 ///     let top = match stack.pop() {
 116 ///         None => break, // empty
 117 ///         Some(x) => x,
 118 ///     };
 119 ///     // Prints 3, 2, 1
 120 ///     println!("{}", top);
 121 /// }
 122 /// ```
 123 ///
 124 /// # Capacity and reallocation
 125 ///
 126 /// The capacity of a vector is the amount of space allocated for any future elements that will be
 127 /// added onto the vector. This is not to be confused with the *length* of a vector, which
 128 /// specifies the number of actual elements within the vector. If a vector's length exceeds its
 129 /// capacity, its capacity will automatically be increased, but its elements will have to be
 130 /// reallocated.
 131 ///
 132 /// For example, a vector with capacity 10 and length 0 would be an empty vector with space for 10
 133 /// more elements. Pushing 10 or fewer elements onto the vector will not change its capacity or
 134 /// cause reallocation to occur. However, if the vector's length is increased to 11, it will have
 135 /// to reallocate, which can be slow. For this reason, it is recommended to use
 136 /// `Vec::with_capacity` whenever possible to specify how big the vector is expected to get.
 137 #[unsafe_no_drop_flag]
 138 #[stable(feature = "rust1", since = "1.0.0")]
 139 pub struct Vec<T> {
 140     ptr: NonZero<*mut T>,
 141     len: usize,
 142     cap: usize,
 143 }
 144
 145 unsafe impl<T: Send> Send for Vec<T> { }
 146 unsafe impl<T: Sync> Sync for Vec<T> { }
 147
 148 ////////////////////////////////////////////////////////////////////////////////
 149 // Inherent methods
 150 ////////////////////////////////////////////////////////////////////////////////
 151
 152 impl<T> Vec<T> {
 153     /// Constructs a new, empty `Vec<T>`.
 154     ///
 155     /// The vector will not allocate until elements are pushed onto it.
 156     ///
 157     /// # Examples
 158     ///
 159     /// ```
 160     /// let mut vec: Vec<int> = Vec::new();
 161     /// ```
 162     #[inline]
 163     #[stable(feature = "rust1", since = "1.0.0")]
 164     pub fn new() -> Vec<T> {
 165         // We want ptr to never be NULL so instead we set it to some arbitrary
 166         // non-null value which is fine since we never call deallocate on the ptr
 167         // if cap is 0. The reason for this is because the pointer of a slice
 168         // being NULL would break the null pointer optimization for enums.
 169         Vec { ptr: unsafe { NonZero::new(EMPTY as *mut T) }, len: 0, cap: 0 }
 170     }
 171
 172     /// Constructs a new, empty `Vec<T>` with the specified capacity.
 173     ///
 174     /// The vector will be able to hold exactly `capacity` elements without reallocating. If
 175     /// `capacity` is 0, the vector will not allocate.
 176     ///
 177     /// It is important to note that this function does not specify the *length* of the returned
 178     /// vector, but only the *capacity*. (For an explanation of the difference between length and
 179     /// capacity, see the main `Vec<T>` docs above, 'Capacity and reallocation'.)
 180     ///
 181     /// # Examples
 182     ///
 183     /// ```
 184     /// let mut vec: Vec<_> = Vec::with_capacity(10);
 185     ///
 186     /// // The vector contains no items, even though it has capacity for more
 187     /// assert_eq!(vec.len(), 0);
 188     ///
 189     /// // These are all done without reallocating...
 190     /// for i in 0..10 {
 191     ///     vec.push(i);
 192     /// }
 193     ///
 194     /// // ...but this may make the vector reallocate
 195     /// vec.push(11);
 196     /// ```
 197     #[inline]
 198     #[stable(feature = "rust1", since = "1.0.0")]
 199     pub fn with_capacity(capacity: usize) -> Vec<T> {
 200         if mem::size_of::<T>() == 0 {
 201             Vec { ptr: unsafe { NonZero::new(EMPTY as *mut T) }, len: 0, cap: usize::MAX }
 202         } else if capacity == 0 {
 203             Vec::new()
 204         } else {
 205             let size = capacity.checked_mul(mem::size_of::<T>())
 206                                .expect("capacity overflow");
 207             let ptr = unsafe { allocate(size, mem::min_align_of::<T>()) };
 208             if ptr.is_null() { ::alloc::oom() }
 209             Vec { ptr: unsafe { NonZero::new(ptr as *mut T) }, len: 0, cap: capacity }
 210         }
 211     }
 212
 213     /// Creates a `Vec<T>` directly from the raw components of another vector.
 214     ///
 215     /// This is highly unsafe, due to the number of invariants that aren't checked.
 216     ///
 217     /// # Examples
 218     ///
 219     /// ```
 220     /// use std::ptr;
 221     /// use std::mem;
 222     ///
 223     /// fn main() {
 224     ///     let mut v = vec![1, 2, 3];
 225     ///
 226     ///     // Pull out the various important pieces of information about `v`
 227     ///     let p = v.as_mut_ptr();
 228     ///     let len = v.len();
 229     ///     let cap = v.capacity();
 230     ///
 231     ///     unsafe {
 232     ///         // Cast `v` into the void: no destructor run, so we are in
 233     ///         // complete control of the allocation to which `p` points.
 234     ///         mem::forget(v);
 235     ///
 236     ///         // Overwrite memory with 4, 5, 6
 237     ///         for i in 0..len as isize {
 238     ///             ptr::write(p.offset(i), 4 + i);
 239     ///         }
 240     ///
 241     ///         // Put everything back together into a Vec
 242     ///         let rebuilt = Vec::from_raw_parts(p, len, cap);
 243     ///         assert_eq!(rebuilt, vec![4, 5, 6]);
 244     ///     }
 245     /// }
 246     /// ```
 247     #[stable(feature = "rust1", since = "1.0.0")]
 248     pub unsafe fn from_raw_parts(ptr: *mut T, length: usize,
 249                                  capacity: usize) -> Vec<T> {
 250         Vec { ptr: NonZero::new(ptr), len: length, cap: capacity }
 251     }
 252
 253     /// Creates a vector by copying the elements from a raw pointer.
 254     ///
 255     /// This function will copy `elts` contiguous elements starting at `ptr` into a new allocation
 256     /// owned by the returned `Vec<T>`. The elements of the buffer are copied into the vector
 257     /// without cloning, as if `ptr::read()` were called on them.
 258     #[inline]
 259     #[unstable(feature = "collections",
 260                reason = "may be better expressed via composition")]
 261     pub unsafe fn from_raw_buf(ptr: *const T, elts: usize) -> Vec<T> {
 262         let mut dst = Vec::with_capacity(elts);
 263         dst.set_len(elts);
 264         ptr::copy_nonoverlapping_memory(dst.as_mut_ptr(), ptr, elts);
 265         dst
 266     }
 267
 268     /// Returns the number of elements the vector can hold without
 269     /// reallocating.
 270     ///
 271     /// # Examples
 272     ///
 273     /// ```
 274     /// let vec: Vec<int> = Vec::with_capacity(10);
 275     /// assert_eq!(vec.capacity(), 10);
 276     /// ```
 277     #[inline]
 278     #[stable(feature = "rust1", since = "1.0.0")]
 279     pub fn capacity(&self) -> usize {
 280         self.cap
 281     }
 282
 283     /// Reserves capacity for at least `additional` more elements to be inserted in the given
 284     /// `Vec<T>`. The collection may reserve more space to avoid frequent reallocations.
 285     ///
 286     /// # Panics
 287     ///
 288     /// Panics if the new capacity overflows `usize`.
 289     ///
 290     /// # Examples
 291     ///
 292     /// ```
 293     /// let mut vec: Vec<int> = vec![1];
 294     /// vec.reserve(10);
 295     /// assert!(vec.capacity() >= 11);
 296     /// ```
 297     #[stable(feature = "rust1", since = "1.0.0")]
 298     pub fn reserve(&mut self, additional: usize) {
 299         if self.cap - self.len < additional {
 300             let err_msg = "Vec::reserve: `usize` overflow";
 301             let new_cap = self.len.checked_add(additional).expect(err_msg)
 302                 .checked_next_power_of_two().expect(err_msg);
 303             self.grow_capacity(new_cap);
 304         }
 305     }
 306
 307     /// Reserves the minimum capacity for exactly `additional` more elements to
 308     /// be inserted in the given `Vec<T>`. Does nothing if the capacity is already
 309     /// sufficient.
 310     ///
 311     /// Note that the allocator may give the collection more space than it
 312     /// requests. Therefore capacity can not be relied upon to be precisely
 313     /// minimal. Prefer `reserve` if future insertions are expected.
 314     ///
 315     /// # Panics
 316     ///
 317     /// Panics if the new capacity overflows `usize`.
 318     ///
 319     /// # Examples
 320     ///
 321     /// ```
 322     /// let mut vec: Vec<int> = vec![1];
 323     /// vec.reserve_exact(10);
 324     /// assert!(vec.capacity() >= 11);
 325     /// ```
 326     #[stable(feature = "rust1", since = "1.0.0")]
 327     pub fn reserve_exact(&mut self, additional: usize) {
 328         if self.cap - self.len < additional {
 329             match self.len.checked_add(additional) {
 330                 None => panic!("Vec::reserve: `usize` overflow"),
 331                 Some(new_cap) => self.grow_capacity(new_cap)
 332             }
 333         }
 334     }
 335
 336     /// Shrinks the capacity of the vector as much as possible.
 337     ///
 338     /// It will drop down as close as possible to the length but the allocator
 339     /// may still inform the vector that there is space for a few more elements.
 340     ///
 341     /// # Examples
 342     ///
 343     /// ```
 344     /// let mut vec: Vec<int> = Vec::with_capacity(10);
 345     /// vec.push_all(&[1, 2, 3]);
 346     /// assert_eq!(vec.capacity(), 10);
 347     /// vec.shrink_to_fit();
 348     /// assert!(vec.capacity() >= 3);
 349     /// ```
 350     #[stable(feature = "rust1", since = "1.0.0")]
 351     pub fn shrink_to_fit(&mut self) {
 352         if mem::size_of::<T>() == 0 { return }
 353
 354         if self.len == 0 {
 355             if self.cap != 0 {
 356                 unsafe {
 357                     dealloc(*self.ptr, self.cap)
 358                 }
 359                 self.cap = 0;
 360             }
 361         } else if self.cap != self.len {
 362             unsafe {
 363                 // Overflow check is unnecessary as the vector is already at
 364                 // least this large.
 365                 let ptr = reallocate(*self.ptr as *mut u8,
 366                                      self.cap * mem::size_of::<T>(),
 367                                      self.len * mem::size_of::<T>(),
 368                                      mem::min_align_of::<T>()) as *mut T;
 369                 if ptr.is_null() { ::alloc::oom() }
 370                 self.ptr = NonZero::new(ptr);
 371             }
 372             self.cap = self.len;
 373         }
 374     }
 375
 376     /// Convert the vector into Box<[T]>.
 377     ///
 378     /// Note that this will drop any excess capacity. Calling this and
 379     /// converting back to a vector with `into_vec()` is equivalent to calling
 380     /// `shrink_to_fit()`.
 381     #[unstable(feature = "collections")]
 382     pub fn into_boxed_slice(mut self) -> Box<[T]> {
 383         self.shrink_to_fit();
 384         unsafe {
 385             let xs: Box<[T]> = mem::transmute(&mut *self);
 386             mem::forget(self);
 387             xs
 388         }
 389     }
 390
 391     /// Shorten a vector, dropping excess elements.
 392     ///
 393     /// If `len` is greater than the vector's current length, this has no
 394     /// effect.
 395     ///
 396     /// # Examples
 397     ///
 398     /// ```
 399     /// let mut vec = vec![1, 2, 3, 4];
 400     /// vec.truncate(2);
 401     /// assert_eq!(vec, vec![1, 2]);
 402     /// ```
 403     #[stable(feature = "rust1", since = "1.0.0")]
 404     pub fn truncate(&mut self, len: usize) {
 405         unsafe {
 406             // drop any extra elements
 407             while len < self.len {
 408                 // decrement len before the read(), so a panic on Drop doesn't
 409                 // re-drop the just-failed value.
 410                 self.len -= 1;
 411                 ptr::read(self.get_unchecked(self.len));
 412             }
 413         }
 414     }
 415
 416     /// Returns a mutable slice of the elements of `self`.
 417     ///
 418     /// # Examples
 419     ///
 420     /// ```
 421     /// fn foo(slice: &mut [int]) {}
 422     ///
 423     /// let mut vec = vec![1, 2];
 424     /// foo(vec.as_mut_slice());
 425     /// ```
 426     #[inline]
 427     #[stable(feature = "rust1", since = "1.0.0")]
 428     pub fn as_mut_slice(&mut self) -> &mut [T] {
 429         unsafe {
 430             mem::transmute(RawSlice {
 431                 data: *self.ptr,
 432                 len: self.len,
 433             })
 434         }
 435     }
 436
 437     /// Creates a consuming iterator, that is, one that moves each value out of
 438     /// the vector (from start to end). The vector cannot be used after calling
 439     /// this.
 440     ///
 441     /// # Examples
 442     ///
 443     /// ```
 444     /// let v = vec!["a".to_string(), "b".to_string()];
 445     /// for s in v.into_iter() {
 446     ///     // s has type String, not &String
 447     ///     println!("{}", s);
 448     /// }
 449     /// ```
 450     #[inline]
 451     #[stable(feature = "rust1", since = "1.0.0")]
 452     pub fn into_iter(self) -> IntoIter<T> {
 453         unsafe {
 454             let ptr = *self.ptr;
 455             let cap = self.cap;
 456             let begin = ptr as *const T;
 457             let end = if mem::size_of::<T>() == 0 {
 458                 (ptr as usize + self.len()) as *const T
 459             } else {
 460                 ptr.offset(self.len() as isize) as *const T
 461             };
 462             mem::forget(self);
 463             IntoIter { allocation: ptr, cap: cap, ptr: begin, end: end }
 464         }
 465     }
 466
 467     /// Sets the length of a vector.
 468     ///
 469     /// This will explicitly set the size of the vector, without actually
 470     /// modifying its buffers, so it is up to the caller to ensure that the
 471     /// vector is actually the specified size.
 472     ///
 473     /// # Examples
 474     ///
 475     /// ```
 476     /// let mut v = vec![1, 2, 3, 4];
 477     /// unsafe {
 478     ///     v.set_len(1);
 479     /// }
 480     /// ```
 481     #[inline]
 482     #[stable(feature = "rust1", since = "1.0.0")]
 483     pub unsafe fn set_len(&mut self, len: usize) {
 484         self.len = len;
 485     }
 486
 487     /// Removes an element from anywhere in the vector and return it, replacing
 488     /// it with the last element.
 489     ///
 490     /// This does not preserve ordering, but is O(1).
 491     ///
 492     /// # Panics
 493     ///
 494     /// Panics if `index` is out of bounds.
 495     ///
 496     /// # Examples
 497     ///
 498     /// ```
 499     /// let mut v = vec!["foo", "bar", "baz", "qux"];
 500     ///
 501     /// assert_eq!(v.swap_remove(1), "bar");
 502     /// assert_eq!(v, vec!["foo", "qux", "baz"]);
 503     ///
 504     /// assert_eq!(v.swap_remove(0), "foo");
 505     /// assert_eq!(v, vec!["baz", "qux"]);
 506     /// ```
 507     #[inline]
 508     #[stable(feature = "rust1", since = "1.0.0")]
 509     pub fn swap_remove(&mut self, index: usize) -> T {
 510         let length = self.len();
 511         self.swap(index, length - 1);
 512         self.pop().unwrap()
 513     }
 514
 515     /// Inserts an element at position `index` within the vector, shifting all
 516     /// elements after position `i` one position to the right.
 517     ///
 518     /// # Panics
 519     ///
 520     /// Panics if `index` is not between `0` and the vector's length (both
 521     /// bounds inclusive).
 522     ///
 523     /// # Examples
 524     ///
 525     /// ```
 526     /// let mut vec = vec![1, 2, 3];
 527     /// vec.insert(1, 4);
 528     /// assert_eq!(vec, vec![1, 4, 2, 3]);
 529     /// vec.insert(4, 5);
 530     /// assert_eq!(vec, vec![1, 4, 2, 3, 5]);
 531     /// ```
 532     #[stable(feature = "rust1", since = "1.0.0")]
 533     pub fn insert(&mut self, index: usize, element: T) {
 534         let len = self.len();
 535         assert!(index <= len);
 536         // space for the new element
 537         self.reserve(1);
 538
 539         unsafe { // infallible
 540             // The spot to put the new value
 541             {
 542                 let p = self.as_mut_ptr().offset(index as isize);
 543                 // Shift everything over to make space. (Duplicating the
 544                 // `index`th element into two consecutive places.)
 545                 ptr::copy_memory(p.offset(1), &*p, len - index);
 546                 // Write it in, overwriting the first copy of the `index`th
 547                 // element.
 548                 ptr::write(&mut *p, element);
 549             }
 550             self.set_len(len + 1);
 551         }
 552     }
 553
 554     /// Removes and returns the element at position `index` within the vector,
 555     /// shifting all elements after position `index` one position to the left.
 556     ///
 557     /// # Panics
 558     ///
 559     /// Panics if `i` is out of bounds.
 560     ///
 561     /// # Examples
 562     ///
 563     /// ```
 564     /// let mut v = vec![1, 2, 3];
 565     /// assert_eq!(v.remove(1), 2);
 566     /// assert_eq!(v, vec![1, 3]);
 567     /// ```
 568     #[stable(feature = "rust1", since = "1.0.0")]
 569     pub fn remove(&mut self, index: usize) -> T {
 570         let len = self.len();
 571         assert!(index < len);
 572         unsafe { // infallible
 573             let ret;
 574             {
 575                 // the place we are taking from.
 576                 let ptr = self.as_mut_ptr().offset(index as isize);
 577                 // copy it out, unsafely having a copy of the value on
 578                 // the stack and in the vector at the same time.
 579                 ret = ptr::read(ptr);
 580
 581                 // Shift everything down to fill in that spot.
 582                 ptr::copy_memory(ptr, &*ptr.offset(1), len - index - 1);
 583             }
 584             self.set_len(len - 1);
 585             ret
 586         }
 587     }
 588
 589     /// Retains only the elements specified by the predicate.
 590     ///
 591     /// In other words, remove all elements `e` such that `f(&e)` returns false.
 592     /// This method operates in place and preserves the order of the retained
 593     /// elements.
 594     ///
 595     /// # Examples
 596     ///
 597     /// ```
 598     /// let mut vec = vec![1, 2, 3, 4];
 599     /// vec.retain(|&x| x%2 == 0);
 600     /// assert_eq!(vec, vec![2, 4]);
 601     /// ```
 602     #[stable(feature = "rust1", since = "1.0.0")]
 603     pub fn retain<F>(&mut self, mut f: F) where F: FnMut(&T) -> bool {
 604         let len = self.len();
 605         let mut del = 0;
 606         {
 607             let v = &mut **self;
 608
 609             for i in 0..len {
 610                 if !f(&v[i]) {
 611                     del += 1;
 612                 } else if del > 0 {
 613                     v.swap(i-del, i);
 614                 }
 615             }
 616         }
 617         if del > 0 {
 618             self.truncate(len - del);
 619         }
 620     }
 621
 622     /// Appends an element to the back of a collection.
 623     ///
 624     /// # Panics
 625     ///
 626     /// Panics if the number of elements in the vector overflows a `usize`.
 627     ///
 628     /// # Examples
 629     ///
 630     /// ```rust
 631     /// let mut vec = vec!(1, 2);
 632     /// vec.push(3);
 633     /// assert_eq!(vec, vec!(1, 2, 3));
 634     /// ```
 635     #[inline]
 636     #[stable(feature = "rust1", since = "1.0.0")]
 637     pub fn push(&mut self, value: T) {
 638         if mem::size_of::<T>() == 0 {
 639             // zero-size types consume no memory, so we can't rely on the
 640             // address space running out
 641             self.len = self.len.checked_add(1).expect("length overflow");
 642             unsafe { mem::forget(value); }
 643             return
 644         }
 645         if self.len == self.cap {
 646             let old_size = self.cap * mem::size_of::<T>();
 647             let size = max(old_size, 2 * mem::size_of::<T>()) * 2;
 648             if old_size > size { panic!("capacity overflow") }
 649             unsafe {
 650                 let ptr = alloc_or_realloc(*self.ptr, old_size, size);
 651                 if ptr.is_null() { ::alloc::oom() }
 652                 self.ptr = NonZero::new(ptr);
 653             }
 654             self.cap = max(self.cap, 2) * 2;
 655         }
 656
 657         unsafe {
 658             let end = (*self.ptr).offset(self.len as isize);
 659             ptr::write(&mut *end, value);
 660             self.len += 1;
 661         }
 662     }
 663
 664     /// Removes the last element from a vector and returns it, or `None` if it is empty.
 665     ///
 666     /// # Examples
 667     ///
 668     /// ```rust
 669     /// let mut vec = vec![1, 2, 3];
 670     /// assert_eq!(vec.pop(), Some(3));
 671     /// assert_eq!(vec, vec![1, 2]);
 672     /// ```
 673     #[inline]
 674     #[stable(feature = "rust1", since = "1.0.0")]
 675     pub fn pop(&mut self) -> Option<T> {
 676         if self.len == 0 {
 677             None
 678         } else {
 679             unsafe {
 680                 self.len -= 1;
 681                 Some(ptr::read(self.get_unchecked(self.len())))
 682             }
 683         }
 684     }
 685
 686     /// Moves all the elements of `other` into `Self`, leaving `other` empty.
 687     ///
 688     /// # Panics
 689     ///
 690     /// Panics if the number of elements in the vector overflows a `usize`.
 691     ///
 692     /// # Examples
 693     /// ```rust
 694     /// let mut vec = vec![1, 2, 3];
 695     /// let mut vec2 = vec![4, 5, 6];
 696     /// vec.append(&mut vec2);
 697     /// assert_eq!(vec, vec![1, 2, 3, 4, 5, 6]);
 698     /// assert_eq!(vec2, vec![]);
 699     /// ```
 700     #[inline]
 701     #[unstable(feature = "collections",
 702                reason = "new API, waiting for dust to settle")]
 703     pub fn append(&mut self, other: &mut Self) {
 704         if mem::size_of::<T>() == 0 {
 705             // zero-size types consume no memory, so we can't rely on the
 706             // address space running out
 707             self.len = self.len.checked_add(other.len()).expect("length overflow");
 708             unsafe { other.set_len(0) }
 709             return;
 710         }
 711         self.reserve(other.len());
 712         let len = self.len();
 713         unsafe {
 714             ptr::copy_nonoverlapping_memory(
 715                 self.get_unchecked_mut(len),
 716                 other.as_ptr(),
 717                 other.len());
 718         }
 719
 720         self.len += other.len();
 721         unsafe { other.set_len(0); }
 722     }
 723
 724     /// Creates a draining iterator that clears the `Vec` and iterates over
 725     /// the removed items from start to end.
 726     ///
 727     /// # Examples
 728     ///
 729     /// ```
 730     /// let mut v = vec!["a".to_string(), "b".to_string()];
 731     /// for s in v.drain() {
 732     ///     // s has type String, not &String
 733     ///     println!("{}", s);
 734     /// }
 735     /// assert!(v.is_empty());
 736     /// ```
 737     #[inline]
 738     #[unstable(feature = "collections",
 739                reason = "matches collection reform specification, waiting for dust to settle")]
 740     pub fn drain(&mut self) -> Drain<T> {
 741         unsafe {
 742             let begin = *self.ptr as *const T;
 743             let end = if mem::size_of::<T>() == 0 {
 744                 (*self.ptr as usize + self.len()) as *const T
 745             } else {
 746                 (*self.ptr).offset(self.len() as isize) as *const T
 747             };
 748             self.set_len(0);
 749             Drain {
 750                 ptr: begin,
 751                 end: end,
 752                 marker: ContravariantLifetime,
 753             }
 754         }
 755     }
 756
 757     /// Clears the vector, removing all values.
 758     ///
 759     /// # Examples
 760     ///
 761     /// ```
 762     /// let mut v = vec![1, 2, 3];
 763     ///
 764     /// v.clear();
 765     ///
 766     /// assert!(v.is_empty());
 767     /// ```
 768     #[inline]
 769     #[stable(feature = "rust1", since = "1.0.0")]
 770     pub fn clear(&mut self) {
 771         self.truncate(0)
 772     }
 773
 774     /// Returns the number of elements in the vector.
 775     ///
 776     /// # Examples
 777     ///
 778     /// ```
 779     /// let a = vec![1, 2, 3];
 780     /// assert_eq!(a.len(), 3);
 781     /// ```
 782     #[inline]
 783     #[stable(feature = "rust1", since = "1.0.0")]
 784     pub fn len(&self) -> usize { self.len }
 785
 786     /// Returns `true` if the vector contains no elements.
 787     ///
 788     /// # Examples
 789     ///
 790     /// ```
 791     /// let mut v = Vec::new();
 792     /// assert!(v.is_empty());
 793     ///
 794     /// v.push(1);
 795     /// assert!(!v.is_empty());
 796     /// ```
 797     #[stable(feature = "rust1", since = "1.0.0")]
 798     pub fn is_empty(&self) -> bool { self.len() == 0 }
 799
 800     /// Converts a `Vec<T>` to a `Vec<U>` where `T` and `U` have the same
 801     /// size and in case they are not zero-sized the same minimal alignment.
 802     ///
 803     /// # Panics
 804     ///
 805     /// Panics if `T` and `U` have differing sizes or are not zero-sized and
 806     /// have differing minimal alignments.
 807     ///
 808     /// # Examples
 809     ///
 810     /// ```
 811     /// let v = vec![0, 1, 2];
 812     /// let w = v.map_in_place(|i| i + 3);
 813     /// assert_eq!(w.as_slice(), [3, 4, 5].as_slice());
 814     ///
 815     /// #[derive(PartialEq, Debug)]
 816     /// struct Newtype(u8);
 817     /// let bytes = vec![0x11, 0x22];
 818     /// let newtyped_bytes = bytes.map_in_place(|x| Newtype(x));
 819     /// assert_eq!(newtyped_bytes.as_slice(), [Newtype(0x11), Newtype(0x22)].as_slice());
 820     /// ```
 821     #[unstable(feature = "collections",
 822                reason = "API may change to provide stronger guarantees")]
 823     pub fn map_in_place<U, F>(self, mut f: F) -> Vec<U> where F: FnMut(T) -> U {
 824         // FIXME: Assert statically that the types `T` and `U` have the same
 825         // size.
 826         assert!(mem::size_of::<T>() == mem::size_of::<U>());
 827
 828         let mut vec = self;
 829
 830         if mem::size_of::<T>() != 0 {
 831             // FIXME: Assert statically that the types `T` and `U` have the
 832             // same minimal alignment in case they are not zero-sized.
 833
 834             // These asserts are necessary because the `min_align_of` of the
 835             // types are passed to the allocator by `Vec`.
 836             assert!(mem::min_align_of::<T>() == mem::min_align_of::<U>());
 837
 838             // This `as isize` cast is safe, because the size of the elements of the
 839             // vector is not 0, and:
 840             //
 841             // 1) If the size of the elements in the vector is 1, the `int` may
 842             //    overflow, but it has the correct bit pattern so that the
 843             //    `.offset()` function will work.
 844             //
 845             //    Example:
 846             //        Address space 0x0-0xF.
 847             //        `u8` array at: 0x1.
 848             //        Size of `u8` array: 0x8.
 849             //        Calculated `offset`: -0x8.
 850             //        After `array.offset(offset)`: 0x9.
 851             //        (0x1 + 0x8 = 0x1 - 0x8)
 852             //
 853             // 2) If the size of the elements in the vector is >1, the `usize` ->
 854             //    `int` conversion can't overflow.
 855             let offset = vec.len() as isize;
 856             let start = vec.as_mut_ptr();
 857
 858             let mut pv = PartialVecNonZeroSized {
 859                 vec: vec,
 860
 861                 start_t: start,
 862                 // This points inside the vector, as the vector has length
 863                 // `offset`.
 864                 end_t: unsafe { start.offset(offset) },
 865                 start_u: start as *mut U,
 866                 end_u: start as *mut U,
 867             };
 868             //  start_t
 869             //  start_u
 870             //  |
 871             // +-+-+-+-+-+-+
 872             // |T|T|T|...|T|
 873             // +-+-+-+-+-+-+
 874             //  |           |
 875             //  end_u       end_t
 876
 877             while pv.end_u as *mut T != pv.end_t {
 878                 unsafe {
 879                     //  start_u start_t
 880                     //  |       |
 881                     // +-+-+-+-+-+-+-+-+-+
 882                     // |U|...|U|T|T|...|T|
 883                     // +-+-+-+-+-+-+-+-+-+
 884                     //          |         |
 885                     //          end_u     end_t
 886
 887                     let t = ptr::read(pv.start_t);
 888                     //  start_u start_t
 889                     //  |       |
 890                     // +-+-+-+-+-+-+-+-+-+
 891                     // |U|...|U|X|T|...|T|
 892                     // +-+-+-+-+-+-+-+-+-+
 893                     //          |         |
 894                     //          end_u     end_t
 895                     // We must not panic here, one cell is marked as `T`
 896                     // although it is not `T`.
 897
 898                     pv.start_t = pv.start_t.offset(1);
 899                     //  start_u   start_t
 900                     //  |         |
 901                     // +-+-+-+-+-+-+-+-+-+
 902                     // |U|...|U|X|T|...|T|
 903                     // +-+-+-+-+-+-+-+-+-+
 904                     //          |         |
 905                     //          end_u     end_t
 906                     // We may panic again.
 907
 908                     // The function given by the user might panic.
 909                     let u = f(t);
 910
 911                     ptr::write(pv.end_u, u);
 912                     //  start_u   start_t
 913                     //  |         |
 914                     // +-+-+-+-+-+-+-+-+-+
 915                     // |U|...|U|U|T|...|T|
 916                     // +-+-+-+-+-+-+-+-+-+
 917                     //          |         |
 918                     //          end_u     end_t
 919                     // We should not panic here, because that would leak the `U`
 920                     // pointed to by `end_u`.
 921
 922                     pv.end_u = pv.end_u.offset(1);
 923                     //  start_u   start_t
 924                     //  |         |
 925                     // +-+-+-+-+-+-+-+-+-+
 926                     // |U|...|U|U|T|...|T|
 927                     // +-+-+-+-+-+-+-+-+-+
 928                     //            |       |
 929                     //            end_u   end_t
 930                     // We may panic again.
 931                 }
 932             }
 933
 934             //  start_u     start_t
 935             //  |           |
 936             // +-+-+-+-+-+-+
 937             // |U|...|U|U|U|
 938             // +-+-+-+-+-+-+
 939             //              |
 940             //              end_t
 941             //              end_u
 942             // Extract `vec` and prevent the destructor of
 943             // `PartialVecNonZeroSized` from running. Note that none of the
 944             // function calls can panic, thus no resources can be leaked (as the
 945             // `vec` member of `PartialVec` is the only one which holds
 946             // allocations -- and it is returned from this function. None of
 947             // this can panic.
 948             unsafe {
 949                 let vec_len = pv.vec.len();
 950                 let vec_cap = pv.vec.capacity();
 951                 let vec_ptr = pv.vec.as_mut_ptr() as *mut U;
 952                 mem::forget(pv);
 953                 Vec::from_raw_parts(vec_ptr, vec_len, vec_cap)
 954             }
 955         } else {
 956             // Put the `Vec` into the `PartialVecZeroSized` structure and
 957             // prevent the destructor of the `Vec` from running. Since the
 958             // `Vec` contained zero-sized objects, it did not allocate, so we
 959             // are not leaking memory here.
 960             let mut pv = PartialVecZeroSized::<T,U> {
 961                 num_t: vec.len(),
 962                 num_u: 0,
 963                 marker_t: InvariantType,
 964                 marker_u: InvariantType,
 965             };
 966             unsafe { mem::forget(vec); }
 967
 968             while pv.num_t != 0 {
 969                 unsafe {
 970                     // Create a `T` out of thin air and decrement `num_t`. This
 971                     // must not panic between these steps, as otherwise a
 972                     // destructor of `T` which doesn't exist runs.
 973                     let t = mem::uninitialized();
 974                     pv.num_t -= 1;
 975
 976                     // The function given by the user might panic.
 977                     let u = f(t);
 978
 979                     // Forget the `U` and increment `num_u`. This increment
 980                     // cannot overflow the `usize` as we only do this for a
 981                     // number of times that fits into a `usize` (and start with
 982                     // `0`). Again, we should not panic between these steps.
 983                     mem::forget(u);
 984                     pv.num_u += 1;
 985                 }
 986             }
 987             // Create a `Vec` from our `PartialVecZeroSized` and make sure the
 988             // destructor of the latter will not run. None of this can panic.
 989             let mut result = Vec::new();
 990             unsafe {
 991                 result.set_len(pv.num_u);
 992                 mem::forget(pv);
 993             }
 994             result
 995         }
 996     }
 997
 998     /// Splits the collection into two at the given index.
 999     ///
1000     /// Returns a newly allocated `Self`. `self` contains elements `[0, at)`,
1001     /// and the returned `Self` contains elements `[at, len)`.
1002     ///
1003     /// Note that the capacity of `self` does not change.
1004     ///
1005     /// # Examples
1006     /// ```rust
1007     /// let mut vec = vec![1,2,3];
1008     /// let vec2 = vec.split_off(1);
1009     /// assert_eq!(vec, vec![1]);
1010     /// assert_eq!(vec2, vec![2, 3]);
1011     /// ```
1012     #[inline]
1013     #[unstable(feature = "collections",
1014                reason = "new API, waiting for dust to settle")]
1015     pub fn split_off(&mut self, at: usize) -> Self {
1016         assert!(at < self.len(), "`at` out of bounds");
1017
1018         let other_len = self.len - at;
1019         let mut other = Vec::with_capacity(other_len);
1020
1021         // Unsafely `set_len` and copy items to `other`.
1022         unsafe {
1023             self.set_len(at);
1024             other.set_len(other_len);
1025
1026             ptr::copy_nonoverlapping_memory(
1027                 other.as_mut_ptr(),
1028                 self.as_ptr().offset(at as isize),
1029                 other.len());
1030         }
1031         other
1032     }
1033
1034 }
1035
1036 impl<T: Clone> Vec<T> {
1037     /// Resizes the `Vec` in-place so that `len()` is equal to `new_len`.
1038     ///
1039     /// Calls either `extend()` or `truncate()` depending on whether `new_len`
1040     /// is larger than the current value of `len()` or not.
1041     ///
1042     /// # Examples
1043     ///
1044     /// ```
1045     /// let mut vec = vec!["hello"];
1046     /// vec.resize(3, "world");
1047     /// assert_eq!(vec, vec!["hello", "world", "world"]);
1048     ///
1049     /// let mut vec = vec![1, 2, 3, 4];
1050     /// vec.resize(2, 0);
1051     /// assert_eq!(vec, vec![1, 2]);
1052     /// ```
1053     #[unstable(feature = "collections",
1054                reason = "matches collection reform specification; waiting for dust to settle")]
1055     pub fn resize(&mut self, new_len: usize, value: T) {
1056         let len = self.len();
1057
1058         if new_len > len {
1059             self.extend(repeat(value).take(new_len - len));
1060         } else {
1061             self.truncate(new_len);
1062         }
1063     }
1064
1065     /// Appends all elements in a slice to the `Vec`.
1066     ///
1067     /// Iterates over the slice `other`, clones each element, and then appends
1068     /// it to this `Vec`. The `other` vector is traversed in-order.
1069     ///
1070     /// # Examples
1071     ///
1072     /// ```
1073     /// let mut vec = vec![1];
1074     /// vec.push_all(&[2, 3, 4]);
1075     /// assert_eq!(vec, vec![1, 2, 3, 4]);
1076     /// ```
1077     #[inline]
1078     #[unstable(feature = "collections",
1079                reason = "likely to be replaced by a more optimized extend")]
1080     pub fn push_all(&mut self, other: &[T]) {
1081         self.reserve(other.len());
1082
1083         for i in 0..other.len() {
1084             let len = self.len();
1085
1086             // Unsafe code so this can be optimised to a memcpy (or something similarly
1087             // fast) when T is Copy. LLVM is easily confused, so any extra operations
1088             // during the loop can prevent this optimisation.
1089             unsafe {
1090                 ptr::write(
1091                     self.get_unchecked_mut(len),
1092                     other.get_unchecked(i).clone());
1093                 self.set_len(len + 1);
1094             }
1095         }
1096     }
1097 }
1098
1099 impl<T: PartialEq> Vec<T> {
1100     /// Removes consecutive repeated elements in the vector.
1101     ///
1102     /// If the vector is sorted, this removes all duplicates.
1103     ///
1104     /// # Examples
1105     ///
1106     /// ```
1107     /// let mut vec = vec![1, 2, 2, 3, 2];
1108     ///
1109     /// vec.dedup();
1110     ///
1111     /// assert_eq!(vec, vec![1, 2, 3, 2]);
1112     /// ```
1113     #[stable(feature = "rust1", since = "1.0.0")]
1114     pub fn dedup(&mut self) {
1115         unsafe {
1116             // Although we have a mutable reference to `self`, we cannot make
1117             // *arbitrary* changes. The `PartialEq` comparisons could panic, so we
1118             // must ensure that the vector is in a valid state at all time.
1119             //
1120             // The way that we handle this is by using swaps; we iterate
1121             // over all the elements, swapping as we go so that at the end
1122             // the elements we wish to keep are in the front, and those we
1123             // wish to reject are at the back. We can then truncate the
1124             // vector. This operation is still O(n).
1125             //
1126             // Example: We start in this state, where `r` represents "next
1127             // read" and `w` represents "next_write`.
1128             //
1129             //           r
1130             //     +---+---+---+---+---+---+
1131             //     | 0 | 1 | 1 | 2 | 3 | 3 |
1132             //     +---+---+---+---+---+---+
1133             //           w
1134             //
1135             // Comparing self[r] against self[w-1], this is not a duplicate, so
1136             // we swap self[r] and self[w] (no effect as r==w) and then increment both
1137             // r and w, leaving us with:
1138             //
1139             //               r
1140             //     +---+---+---+---+---+---+
1141             //     | 0 | 1 | 1 | 2 | 3 | 3 |
1142             //     +---+---+---+---+---+---+
1143             //               w
1144             //
1145             // Comparing self[r] against self[w-1], this value is a duplicate,
1146             // so we increment `r` but leave everything else unchanged:
1147             //
1148             //                   r
1149             //     +---+---+---+---+---+---+
1150             //     | 0 | 1 | 1 | 2 | 3 | 3 |
1151             //     +---+---+---+---+---+---+
1152             //               w
1153             //
1154             // Comparing self[r] against self[w-1], this is not a duplicate,
1155             // so swap self[r] and self[w] and advance r and w:
1156             //
1157             //                       r
1158             //     +---+---+---+---+---+---+
1159             //     | 0 | 1 | 2 | 1 | 3 | 3 |
1160             //     +---+---+---+---+---+---+
1161             //                   w
1162             //
1163             // Not a duplicate, repeat:
1164             //
1165             //                           r
1166             //     +---+---+---+---+---+---+
1167             //     | 0 | 1 | 2 | 3 | 1 | 3 |
1168             //     +---+---+---+---+---+---+
1169             //                       w
1170             //
1171             // Duplicate, advance r. End of vec. Truncate to w.
1172
1173             let ln = self.len();
1174             if ln < 1 { return; }
1175
1176             // Avoid bounds checks by using unsafe pointers.
1177             let p = self.as_mut_ptr();
1178             let mut r = 1;
1179             let mut w = 1;
1180
1181             while r < ln {
1182                 let p_r = p.offset(r as isize);
1183                 let p_wm1 = p.offset((w - 1) as isize);
1184                 if *p_r != *p_wm1 {
1185                     if r != w {
1186                         let p_w = p_wm1.offset(1);
1187                         mem::swap(&mut *p_r, &mut *p_w);
1188                     }
1189                     w += 1;
1190                 }
1191                 r += 1;
1192             }
1193
1194             self.truncate(w);
1195         }
1196     }
1197 }
1198
1199 ////////////////////////////////////////////////////////////////////////////////
1200 // Internal methods and functions
1201 ////////////////////////////////////////////////////////////////////////////////
1202
1203 impl<T> Vec<T> {
1204     /// Reserves capacity for exactly `capacity` elements in the given vector.
1205     ///
1206     /// If the capacity for `self` is already equal to or greater than the
1207     /// requested capacity, then no action is taken.
1208     fn grow_capacity(&mut self, capacity: usize) {
1209         if mem::size_of::<T>() == 0 { return }
1210
1211         if capacity > self.cap {
1212             let size = capacity.checked_mul(mem::size_of::<T>())
1213                                .expect("capacity overflow");
1214             unsafe {
1215                 let ptr = alloc_or_realloc(*self.ptr, self.cap * mem::size_of::<T>(), size);
1216                 if ptr.is_null() { ::alloc::oom() }
1217                 self.ptr = NonZero::new(ptr);
1218             }
1219             self.cap = capacity;
1220         }
1221     }
1222 }
1223
1224 // FIXME: #13996: need a way to mark the return value as `noalias`
1225 #[inline(never)]
1226 unsafe fn alloc_or_realloc<T>(ptr: *mut T, old_size: usize, size: usize) -> *mut T {
1227     if old_size == 0 {
1228         allocate(size, mem::min_align_of::<T>()) as *mut T
1229     } else {
1230         reallocate(ptr as *mut u8, old_size, size, mem::min_align_of::<T>()) as *mut T
1231     }
1232 }
1233
1234 #[inline]
1235 unsafe fn dealloc<T>(ptr: *mut T, len: usize) {
1236     if mem::size_of::<T>() != 0 {
1237         deallocate(ptr as *mut u8,
1238                    len * mem::size_of::<T>(),
1239                    mem::min_align_of::<T>())
1240     }
1241 }
1242
1243 ////////////////////////////////////////////////////////////////////////////////
1244 // Common trait implementations for Vec
1245 ////////////////////////////////////////////////////////////////////////////////
1246
1247 #[unstable(feature = "collections")]
1248 impl<T:Clone> Clone for Vec<T> {
1249     fn clone(&self) -> Vec<T> { ::slice::SliceExt::to_vec(&**self) }
1250
1251     fn clone_from(&mut self, other: &Vec<T>) {
1252         // drop anything in self that will not be overwritten
1253         if self.len() > other.len() {
1254             self.truncate(other.len())
1255         }
1256
1257         // reuse the contained values' allocations/resources.
1258         for (place, thing) in self.iter_mut().zip(other.iter()) {
1259             place.clone_from(thing)
1260         }
1261
1262         // self.len <= other.len due to the truncate above, so the
1263         // slice here is always in-bounds.
1264         let slice = &other[self.len()..];
1265         self.push_all(slice);
1266     }
1267 }
1268
1269 impl<S: hash::Writer + hash::Hasher, T: Hash<S>> Hash<S> for Vec<T> {
1270     #[inline]
1271     fn hash(&self, state: &mut S) {
1272         Hash::hash(&**self, state)
1273     }
1274 }
1275
1276 #[stable(feature = "rust1", since = "1.0.0")]
1277 impl<T> Index<usize> for Vec<T> {
1278     type Output = T;
1279
1280     #[inline]
1281     fn index(&self, index: &usize) -> &T {
1282         // NB built-in indexing via `&[T]`
1283         &(**self)[*index]
1284     }
1285 }
1286
1287 #[stable(feature = "rust1", since = "1.0.0")]
1288 impl<T> IndexMut<usize> for Vec<T> {
1289     #[inline]
1290     fn index_mut(&mut self, index: &usize) -> &mut T {
1291         // NB built-in indexing via `&mut [T]`
1292         &mut (**self)[*index]
1293     }
1294 }
1295
1296
1297 #[stable(feature = "rust1", since = "1.0.0")]
1298 impl<T> ops::Index<ops::Range<usize>> for Vec<T> {
1299     type Output = [T];
1300     #[inline]
1301     fn index(&self, index: &ops::Range<usize>) -> &[T] {
1302         Index::index(&**self, index)
1303     }
1304 }
1305 #[stable(feature = "rust1", since = "1.0.0")]
1306 impl<T> ops::Index<ops::RangeTo<usize>> for Vec<T> {
1307     type Output = [T];
1308     #[inline]
1309     fn index(&self, index: &ops::RangeTo<usize>) -> &[T] {
1310         Index::index(&**self, index)
1311     }
1312 }
1313 #[stable(feature = "rust1", since = "1.0.0")]
1314 impl<T> ops::Index<ops::RangeFrom<usize>> for Vec<T> {
1315     type Output = [T];
1316     #[inline]
1317     fn index(&self, index: &ops::RangeFrom<usize>) -> &[T] {
1318         Index::index(&**self, index)
1319     }
1320 }
1321 #[stable(feature = "rust1", since = "1.0.0")]
1322 impl<T> ops::Index<ops::RangeFull> for Vec<T> {
1323     type Output = [T];
1324     #[inline]
1325     fn index(&self, _index: &ops::RangeFull) -> &[T] {
1326         self.as_slice()
1327     }
1328 }
1329
1330 #[stable(feature = "rust1", since = "1.0.0")]
1331 impl<T> ops::IndexMut<ops::Range<usize>> for Vec<T> {
1332     #[inline]
1333     fn index_mut(&mut self, index: &ops::Range<usize>) -> &mut [T] {
1334         IndexMut::index_mut(&mut **self, index)
1335     }
1336 }
1337 #[stable(feature = "rust1", since = "1.0.0")]
1338 impl<T> ops::IndexMut<ops::RangeTo<usize>> for Vec<T> {
1339     #[inline]
1340     fn index_mut(&mut self, index: &ops::RangeTo<usize>) -> &mut [T] {
1341         IndexMut::index_mut(&mut **self, index)
1342     }
1343 }
1344 #[stable(feature = "rust1", since = "1.0.0")]
1345 impl<T> ops::IndexMut<ops::RangeFrom<usize>> for Vec<T> {
1346     #[inline]
1347     fn index_mut(&mut self, index: &ops::RangeFrom<usize>) -> &mut [T] {
1348         IndexMut::index_mut(&mut **self, index)
1349     }
1350 }
1351 #[stable(feature = "rust1", since = "1.0.0")]
1352 impl<T> ops::IndexMut<ops::RangeFull> for Vec<T> {
1353     #[inline]
1354     fn index_mut(&mut self, _index: &ops::RangeFull) -> &mut [T] {
1355         self.as_mut_slice()
1356     }
1357 }
1358
1359 #[stable(feature = "rust1", since = "1.0.0")]
1360 impl<T> ops::Deref for Vec<T> {
1361     type Target = [T];
1362
1363     fn deref(&self) -> &[T] { self.as_slice() }
1364 }
1365
1366 #[stable(feature = "rust1", since = "1.0.0")]
1367 impl<T> ops::DerefMut for Vec<T> {
1368     fn deref_mut(&mut self) -> &mut [T] { self.as_mut_slice() }
1369 }
1370
1371 #[stable(feature = "rust1", since = "1.0.0")]
1372 impl<T> FromIterator<T> for Vec<T> {
1373     #[inline]
1374     fn from_iter<I:Iterator<Item=T>>(iterator: I) -> Vec<T> {
1375         let (lower, _) = iterator.size_hint();
1376         let mut vector = Vec::with_capacity(lower);
1377         for element in iterator {
1378             vector.push(element)
1379         }
1380         vector
1381     }
1382 }
1383
1384 impl<T> IntoIterator for Vec<T> {
1385     type Iter = IntoIter<T>;
1386
1387     fn into_iter(self) -> IntoIter<T> {
1388         self.into_iter()
1389     }
1390 }
1391
1392 impl<'a, T> IntoIterator for &'a Vec<T> {
1393     type Iter = slice::Iter<'a, T>;
1394
1395     fn into_iter(self) -> slice::Iter<'a, T> {
1396         self.iter()
1397     }
1398 }
1399
1400 impl<'a, T> IntoIterator for &'a mut Vec<T> {
1401     type Iter = slice::IterMut<'a, T>;
1402
1403     fn into_iter(mut self) -> slice::IterMut<'a, T> {
1404         self.iter_mut()
1405     }
1406 }
1407
1408 #[unstable(feature = "collections", reason = "waiting on Extend stability")]
1409 impl<T> Extend<T> for Vec<T> {
1410     #[inline]
1411     fn extend<I: Iterator<Item=T>>(&mut self, iterator: I) {
1412         let (lower, _) = iterator.size_hint();
1413         self.reserve(lower);
1414         for element in iterator {
1415             self.push(element)
1416         }
1417     }
1418 }
1419
1420 impl<A, B> PartialEq<Vec<B>> for Vec<A> where A: PartialEq<B> {
1421     #[inline]
1422     fn eq(&self, other: &Vec<B>) -> bool { PartialEq::eq(&**self, &**other) }
1423     #[inline]
1424     fn ne(&self, other: &Vec<B>) -> bool { PartialEq::ne(&**self, &**other) }
1425 }
1426
1427 macro_rules! impl_eq {
1428     ($lhs:ty, $rhs:ty) => {
1429         impl<'b, A, B> PartialEq<$rhs> for $lhs where A: PartialEq<B> {
1430             #[inline]
1431             fn eq(&self, other: &$rhs) -> bool { PartialEq::eq(&**self, &**other) }
1432             #[inline]
1433             fn ne(&self, other: &$rhs) -> bool { PartialEq::ne(&**self, &**other) }
1434         }
1435
1436         impl<'b, A, B> PartialEq<$lhs> for $rhs where B: PartialEq<A> {
1437             #[inline]
1438             fn eq(&self, other: &$lhs) -> bool { PartialEq::eq(&**self, &**other) }
1439             #[inline]
1440             fn ne(&self, other: &$lhs) -> bool { PartialEq::ne(&**self, &**other) }
1441         }
1442     }
1443 }
1444
1445 impl_eq! { Vec<A>, &'b [B] }
1446 impl_eq! { Vec<A>, &'b mut [B] }
1447
1448 impl<'a, A, B> PartialEq<Vec<B>> for CowVec<'a, A> where A: PartialEq<B> + Clone {
1449     #[inline]
1450     fn eq(&self, other: &Vec<B>) -> bool { PartialEq::eq(&**self, &**other) }
1451     #[inline]
1452     fn ne(&self, other: &Vec<B>) -> bool { PartialEq::ne(&**self, &**other) }
1453 }
1454
1455 impl<'a, A, B> PartialEq<CowVec<'a, A>> for Vec<B> where A: Clone, B: PartialEq<A> {
1456     #[inline]
1457     fn eq(&self, other: &CowVec<'a, A>) -> bool { PartialEq::eq(&**self, &**other) }
1458     #[inline]
1459     fn ne(&self, other: &CowVec<'a, A>) -> bool { PartialEq::ne(&**self, &**other) }
1460 }
1461
1462 macro_rules! impl_eq_for_cowvec {
1463     ($rhs:ty) => {
1464         impl<'a, 'b, A, B> PartialEq<$rhs> for CowVec<'a, A> where A: PartialEq<B> + Clone {
1465             #[inline]
1466             fn eq(&self, other: &$rhs) -> bool { PartialEq::eq(&**self, &**other) }
1467             #[inline]
1468             fn ne(&self, other: &$rhs) -> bool { PartialEq::ne(&**self, &**other) }
1469         }
1470
1471         impl<'a, 'b, A, B> PartialEq<CowVec<'a, A>> for $rhs where A: Clone, B: PartialEq<A> {
1472             #[inline]
1473             fn eq(&self, other: &CowVec<'a, A>) -> bool { PartialEq::eq(&**self, &**other) }
1474             #[inline]
1475             fn ne(&self, other: &CowVec<'a, A>) -> bool { PartialEq::ne(&**self, &**other) }
1476         }
1477     }
1478 }
1479
1480 impl_eq_for_cowvec! { &'b [B] }
1481 impl_eq_for_cowvec! { &'b mut [B] }
1482
1483 #[unstable(feature = "collections",
1484            reason = "waiting on PartialOrd stability")]
1485 impl<T: PartialOrd> PartialOrd for Vec<T> {
1486     #[inline]
1487     fn partial_cmp(&self, other: &Vec<T>) -> Option<Ordering> {
1488         PartialOrd::partial_cmp(&**self, &**other)
1489     }
1490 }
1491
1492 #[unstable(feature = "collections", reason = "waiting on Eq stability")]
1493 impl<T: Eq> Eq for Vec<T> {}
1494
1495 #[unstable(feature = "collections", reason = "waiting on Ord stability")]
1496 impl<T: Ord> Ord for Vec<T> {
1497     #[inline]
1498     fn cmp(&self, other: &Vec<T>) -> Ordering {
1499         Ord::cmp(&**self, &**other)
1500     }
1501 }
1502
1503 impl<T> AsSlice<T> for Vec<T> {
1504     /// Returns a slice into `self`.
1505     ///
1506     /// # Examples
1507     ///
1508     /// ```
1509     /// fn foo(slice: &[int]) {}
1510     ///
1511     /// let vec = vec![1, 2];
1512     /// foo(vec.as_slice());
1513     /// ```
1514     #[inline]
1515     #[stable(feature = "rust1", since = "1.0.0")]
1516     fn as_slice(&self) -> &[T] {
1517         unsafe {
1518             mem::transmute(RawSlice {
1519                 data: *self.ptr,
1520                 len: self.len
1521             })
1522         }
1523     }
1524 }
1525
1526 #[unstable(feature = "collections",
1527            reason = "recent addition, needs more experience")]
1528 impl<'a, T: Clone> Add<&'a [T]> for Vec<T> {
1529     type Output = Vec<T>;
1530
1531     #[inline]
1532     fn add(mut self, rhs: &[T]) -> Vec<T> {
1533         self.push_all(rhs);
1534         self
1535     }
1536 }
1537
1538 #[unsafe_destructor]
1539 #[stable(feature = "rust1", since = "1.0.0")]
1540 impl<T> Drop for Vec<T> {
1541     fn drop(&mut self) {
1542         // This is (and should always remain) a no-op if the fields are
1543         // zeroed (when moving out, because of #[unsafe_no_drop_flag]).
1544         if self.cap != 0 {
1545             unsafe {
1546                 for x in &*self {
1547                     ptr::read(x);
1548                 }
1549                 dealloc(*self.ptr, self.cap)
1550             }
1551         }
1552     }
1553 }
1554
1555 #[stable(feature = "rust1", since = "1.0.0")]
1556 impl<T> Default for Vec<T> {
1557     #[stable(feature = "rust1", since = "1.0.0")]
1558     fn default() -> Vec<T> {
1559         Vec::new()
1560     }
1561 }
1562
1563 #[stable(feature = "rust1", since = "1.0.0")]
1564 impl<T: fmt::Debug> fmt::Debug for Vec<T> {
1565     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1566         fmt::Debug::fmt(&**self, f)
1567     }
1568 }
1569
1570 ////////////////////////////////////////////////////////////////////////////////
1571 // Clone-on-write
1572 ////////////////////////////////////////////////////////////////////////////////
1573
1574 #[unstable(feature = "collections",
1575            reason = "unclear how valuable this alias is")]
1576 /// A clone-on-write vector
1577 pub type CowVec<'a, T> = Cow<'a, Vec<T>, [T]>;
1578
1579 #[unstable(feature = "collections")]
1580 impl<'a, T> FromIterator<T> for CowVec<'a, T> where T: Clone {
1581     fn from_iter<I: Iterator<Item=T>>(it: I) -> CowVec<'a, T> {
1582         Cow::Owned(FromIterator::from_iter(it))
1583     }
1584 }
1585
1586 impl<'a, T: 'a> IntoCow<'a, Vec<T>, [T]> for Vec<T> where T: Clone {
1587     fn into_cow(self) -> CowVec<'a, T> {
1588         Cow::Owned(self)
1589     }
1590 }
1591
1592 impl<'a, T> IntoCow<'a, Vec<T>, [T]> for &'a [T] where T: Clone {
1593     fn into_cow(self) -> CowVec<'a, T> {
1594         Cow::Borrowed(self)
1595     }
1596 }
1597
1598 ////////////////////////////////////////////////////////////////////////////////
1599 // Iterators
1600 ////////////////////////////////////////////////////////////////////////////////
1601
1602 /// An iterator that moves out of a vector.
1603 #[stable(feature = "rust1", since = "1.0.0")]
1604 pub struct IntoIter<T> {
1605     allocation: *mut T, // the block of memory allocated for the vector
1606     cap: usize, // the capacity of the vector
1607     ptr: *const T,
1608     end: *const T
1609 }
1610
1611 unsafe impl<T: Send> Send for IntoIter<T> { }
1612 unsafe impl<T: Sync> Sync for IntoIter<T> { }
1613
1614 impl<T> IntoIter<T> {
1615     #[inline]
1616     /// Drops all items that have not yet been moved and returns the empty vector.
1617     #[unstable(feature = "collections")]
1618     pub fn into_inner(mut self) -> Vec<T> {
1619         unsafe {
1620             for _x in self.by_ref() { }
1621             let IntoIter { allocation, cap, ptr: _ptr, end: _end } = self;
1622             mem::forget(self);
1623             Vec { ptr: NonZero::new(allocation), cap: cap, len: 0 }
1624         }
1625     }
1626 }
1627
1628 #[stable(feature = "rust1", since = "1.0.0")]
1629 impl<T> Iterator for IntoIter<T> {
1630     type Item = T;
1631
1632     #[inline]
1633     fn next(&mut self) -> Option<T> {
1634         unsafe {
1635             if self.ptr == self.end {
1636                 None
1637             } else {
1638                 if mem::size_of::<T>() == 0 {
1639                     // purposefully don't use 'ptr.offset' because for
1640                     // vectors with 0-size elements this would return the
1641                     // same pointer.
1642                     self.ptr = mem::transmute(self.ptr as usize + 1);
1643
1644                     // Use a non-null pointer value
1645                     Some(ptr::read(EMPTY as *mut T))
1646                 } else {
1647                     let old = self.ptr;
1648                     self.ptr = self.ptr.offset(1);
1649
1650                     Some(ptr::read(old))
1651                 }
1652             }
1653         }
1654     }
1655
1656     #[inline]
1657     fn size_hint(&self) -> (usize, Option<usize>) {
1658         let diff = (self.end as usize) - (self.ptr as usize);
1659         let size = mem::size_of::<T>();
1660         let exact = diff / (if size == 0 {1} else {size});
1661         (exact, Some(exact))
1662     }
1663 }
1664
1665 #[stable(feature = "rust1", since = "1.0.0")]
1666 impl<T> DoubleEndedIterator for IntoIter<T> {
1667     #[inline]
1668     fn next_back(&mut self) -> Option<T> {
1669         unsafe {
1670             if self.end == self.ptr {
1671                 None
1672             } else {
1673                 if mem::size_of::<T>() == 0 {
1674                     // See above for why 'ptr.offset' isn't used
1675                     self.end = mem::transmute(self.end as usize - 1);
1676
1677                     // Use a non-null pointer value
1678                     Some(ptr::read(EMPTY as *mut T))
1679                 } else {
1680                     self.end = self.end.offset(-1);
1681
1682                     Some(ptr::read(mem::transmute(self.end)))
1683                 }
1684             }
1685         }
1686     }
1687 }
1688
1689 #[stable(feature = "rust1", since = "1.0.0")]
1690 impl<T> ExactSizeIterator for IntoIter<T> {}
1691
1692 #[unsafe_destructor]
1693 #[stable(feature = "rust1", since = "1.0.0")]
1694 impl<T> Drop for IntoIter<T> {
1695     fn drop(&mut self) {
1696         // destroy the remaining elements
1697         if self.cap != 0 {
1698             for _x in self.by_ref() {}
1699             unsafe {
1700                 dealloc(self.allocation, self.cap);
1701             }
1702         }
1703     }
1704 }
1705
1706 /// An iterator that drains a vector.
1707 #[unsafe_no_drop_flag]
1708 #[unstable(feature = "collections",
1709            reason = "recently added as part of collections reform 2")]
1710 pub struct Drain<'a, T> {
1711     ptr: *const T,
1712     end: *const T,
1713     marker: ContravariantLifetime<'a>,
1714 }
1715
1716 #[stable(feature = "rust1", since = "1.0.0")]
1717 impl<'a, T> Iterator for Drain<'a, T> {
1718     type Item = T;
1719
1720     #[inline]
1721     fn next(&mut self) -> Option<T> {
1722         unsafe {
1723             if self.ptr == self.end {
1724                 None
1725             } else {
1726                 if mem::size_of::<T>() == 0 {
1727                     // purposefully don't use 'ptr.offset' because for
1728                     // vectors with 0-size elements this would return the
1729                     // same pointer.
1730                     self.ptr = mem::transmute(self.ptr as usize + 1);
1731
1732                     // Use a non-null pointer value
1733                     Some(ptr::read(EMPTY as *mut T))
1734                 } else {
1735                     let old = self.ptr;
1736                     self.ptr = self.ptr.offset(1);
1737
1738                     Some(ptr::read(old))
1739                 }
1740             }
1741         }
1742     }
1743
1744     #[inline]
1745     fn size_hint(&self) -> (usize, Option<usize>) {
1746         let diff = (self.end as usize) - (self.ptr as usize);
1747         let size = mem::size_of::<T>();
1748         let exact = diff / (if size == 0 {1} else {size});
1749         (exact, Some(exact))
1750     }
1751 }
1752
1753 #[stable(feature = "rust1", since = "1.0.0")]
1754 impl<'a, T> DoubleEndedIterator for Drain<'a, T> {
1755     #[inline]
1756     fn next_back(&mut self) -> Option<T> {
1757         unsafe {
1758             if self.end == self.ptr {
1759                 None
1760             } else {
1761                 if mem::size_of::<T>() == 0 {
1762                     // See above for why 'ptr.offset' isn't used
1763                     self.end = mem::transmute(self.end as usize - 1);
1764
1765                     // Use a non-null pointer value
1766                     Some(ptr::read(EMPTY as *mut T))
1767                 } else {
1768                     self.end = self.end.offset(-1);
1769
1770                     Some(ptr::read(self.end))
1771                 }
1772             }
1773         }
1774     }
1775 }
1776
1777 #[stable(feature = "rust1", since = "1.0.0")]
1778 impl<'a, T> ExactSizeIterator for Drain<'a, T> {}
1779
1780 #[unsafe_destructor]
1781 #[stable(feature = "rust1", since = "1.0.0")]
1782 impl<'a, T> Drop for Drain<'a, T> {
1783     fn drop(&mut self) {
1784         // self.ptr == self.end == null if drop has already been called,
1785         // so we can use #[unsafe_no_drop_flag].
1786
1787         // destroy the remaining elements
1788         for _x in self.by_ref() {}
1789     }
1790 }
1791
1792 ////////////////////////////////////////////////////////////////////////////////
1793 // Conversion from &[T] to &Vec<T>
1794 ////////////////////////////////////////////////////////////////////////////////
1795
1796 /// Wrapper type providing a `&Vec<T>` reference via `Deref`.
1797 #[unstable(feature = "collections")]
1798 pub struct DerefVec<'a, T> {
1799     x: Vec<T>,
1800     l: ContravariantLifetime<'a>
1801 }
1802
1803 #[unstable(feature = "collections")]
1804 impl<'a, T> Deref for DerefVec<'a, T> {
1805     type Target = Vec<T>;
1806
1807     fn deref<'b>(&'b self) -> &'b Vec<T> {
1808         &self.x
1809     }
1810 }
1811
1812 // Prevent the inner `Vec<T>` from attempting to deallocate memory.
1813 #[unsafe_destructor]
1814 #[stable(feature = "rust1", since = "1.0.0")]
1815 impl<'a, T> Drop for DerefVec<'a, T> {
1816     fn drop(&mut self) {
1817         self.x.len = 0;
1818         self.x.cap = 0;
1819     }
1820 }
1821
1822 /// Convert a slice to a wrapper type providing a `&Vec<T>` reference.
1823 #[unstable(feature = "collections")]
1824 pub fn as_vec<'a, T>(x: &'a [T]) -> DerefVec<'a, T> {
1825     unsafe {
1826         DerefVec {
1827             x: Vec::from_raw_parts(x.as_ptr() as *mut T, x.len(), x.len()),
1828             l: ContravariantLifetime::<'a>
1829         }
1830     }
1831 }
1832
1833 ////////////////////////////////////////////////////////////////////////////////
1834 // Partial vec, used for map_in_place
1835 ////////////////////////////////////////////////////////////////////////////////
1836
1837 /// An owned, partially type-converted vector of elements with non-zero size.
1838 ///
1839 /// `T` and `U` must have the same, non-zero size. They must also have the same
1840 /// alignment.
1841 ///
1842 /// When the destructor of this struct runs, all `U`s from `start_u` (incl.) to
1843 /// `end_u` (excl.) and all `T`s from `start_t` (incl.) to `end_t` (excl.) are
1844 /// destructed. Additionally the underlying storage of `vec` will be freed.
1845 struct PartialVecNonZeroSized<T,U> {
1846     vec: Vec<T>,
1847
1848     start_u: *mut U,
1849     end_u: *mut U,
1850     start_t: *mut T,
1851     end_t: *mut T,
1852 }
1853
1854 /// An owned, partially type-converted vector of zero-sized elements.
1855 ///
1856 /// When the destructor of this struct runs, all `num_t` `T`s and `num_u` `U`s
1857 /// are destructed.
1858 struct PartialVecZeroSized<T,U> {
1859     num_t: usize,
1860     num_u: usize,
1861     marker_t: InvariantType<T>,
1862     marker_u: InvariantType<U>,
1863 }
1864
1865 #[unsafe_destructor]
1866 impl<T,U> Drop for PartialVecNonZeroSized<T,U> {
1867     fn drop(&mut self) {
1868         unsafe {
1869             // `vec` hasn't been modified until now. As it has a length
1870             // currently, this would run destructors of `T`s which might not be
1871             // there. So at first, set `vec`s length to `0`. This must be done
1872             // at first to remain memory-safe as the destructors of `U` or `T`
1873             // might cause unwinding where `vec`s destructor would be executed.
1874             self.vec.set_len(0);
1875
1876             // We have instances of `U`s and `T`s in `vec`. Destruct them.
1877             while self.start_u != self.end_u {
1878                 let _ = ptr::read(self.start_u); // Run a `U` destructor.
1879                 self.start_u = self.start_u.offset(1);
1880             }
1881             while self.start_t != self.end_t {
1882                 let _ = ptr::read(self.start_t); // Run a `T` destructor.
1883                 self.start_t = self.start_t.offset(1);
1884             }
1885             // After this destructor ran, the destructor of `vec` will run,
1886             // deallocating the underlying memory.
1887         }
1888     }
1889 }
1890
1891 #[unsafe_destructor]
1892 impl<T,U> Drop for PartialVecZeroSized<T,U> {
1893     fn drop(&mut self) {
1894         unsafe {
1895             // Destruct the instances of `T` and `U` this struct owns.
1896             while self.num_t != 0 {
1897                 let _: T = mem::uninitialized(); // Run a `T` destructor.
1898                 self.num_t -= 1;
1899             }
1900             while self.num_u != 0 {
1901                 let _: U = mem::uninitialized(); // Run a `U` destructor.
1902                 self.num_u -= 1;
1903             }
1904         }
1905     }
1906 }
1907
1908 #[cfg(test)]
1909 mod tests {
1910     use prelude::*;
1911     use core::mem::size_of;
1912     use core::iter::repeat;
1913     use test::Bencher;
1914     use super::as_vec;
1915
1916     struct DropCounter<'a> {
1917         count: &'a mut u32
1918     }
1919
1920     #[unsafe_destructor]
1921     impl<'a> Drop for DropCounter<'a> {
1922         fn drop(&mut self) {
1923             *self.count += 1;
1924         }
1925     }
1926
1927     #[test]
1928     fn test_as_vec() {
1929         let xs = [1u8, 2u8, 3u8];
1930         assert_eq!(&**as_vec(&xs), xs);
1931     }
1932
1933     #[test]
1934     fn test_as_vec_dtor() {
1935         let (mut count_x, mut count_y) = (0, 0);
1936         {
1937             let xs = &[DropCounter { count: &mut count_x }, DropCounter { count: &mut count_y }];
1938             assert_eq!(as_vec(xs).len(), 2);
1939         }
1940         assert_eq!(count_x, 1);
1941         assert_eq!(count_y, 1);
1942     }
1943
1944     #[test]
1945     fn test_small_vec_struct() {
1946         assert!(size_of::<Vec<u8>>() == size_of::<usize>() * 3);
1947     }
1948
1949     #[test]
1950     fn test_double_drop() {
1951         struct TwoVec<T> {
1952             x: Vec<T>,
1953             y: Vec<T>
1954         }
1955
1956         let (mut count_x, mut count_y) = (0, 0);
1957         {
1958             let mut tv = TwoVec {
1959                 x: Vec::new(),
1960                 y: Vec::new()
1961             };
1962             tv.x.push(DropCounter {count: &mut count_x});
1963             tv.y.push(DropCounter {count: &mut count_y});
1964
1965             // If Vec had a drop flag, here is where it would be zeroed.
1966             // Instead, it should rely on its internal state to prevent
1967             // doing anything significant when dropped multiple times.
1968             drop(tv.x);
1969
1970             // Here tv goes out of scope, tv.y should be dropped, but not tv.x.
1971         }
1972
1973         assert_eq!(count_x, 1);
1974         assert_eq!(count_y, 1);
1975     }
1976
1977     #[test]
1978     fn test_reserve() {
1979         let mut v = Vec::new();
1980         assert_eq!(v.capacity(), 0);
1981
1982         v.reserve(2);
1983         assert!(v.capacity() >= 2);
1984
1985         for i in 0..16 {
1986             v.push(i);
1987         }
1988
1989         assert!(v.capacity() >= 16);
1990         v.reserve(16);
1991         assert!(v.capacity() >= 32);
1992
1993         v.push(16);
1994
1995         v.reserve(16);
1996         assert!(v.capacity() >= 33)
1997     }
1998
1999     #[test]
2000     fn test_extend() {
2001         let mut v = Vec::new();
2002         let mut w = Vec::new();
2003
2004         v.extend(0..3);
2005         for i in 0..3 { w.push(i) }
2006
2007         assert_eq!(v, w);
2008
2009         v.extend(3..10);
2010         for i in 3..10 { w.push(i) }
2011
2012         assert_eq!(v, w);
2013     }
2014
2015     #[test]
2016     fn test_slice_from_mut() {
2017         let mut values = vec![1, 2, 3, 4, 5];
2018         {
2019             let slice = &mut values[2 ..];
2020             assert!(slice == [3, 4, 5]);
2021             for p in slice {
2022                 *p += 2;
2023             }
2024         }
2025
2026         assert!(values == [1, 2, 5, 6, 7]);
2027     }
2028
2029     #[test]
2030     fn test_slice_to_mut() {
2031         let mut values = vec![1, 2, 3, 4, 5];
2032         {
2033             let slice = &mut values[.. 2];
2034             assert!(slice == [1, 2]);
2035             for p in slice {
2036                 *p += 1;
2037             }
2038         }
2039
2040         assert!(values == [2, 3, 3, 4, 5]);
2041     }
2042
2043     #[test]
2044     fn test_split_at_mut() {
2045         let mut values = vec![1, 2, 3, 4, 5];
2046         {
2047             let (left, right) = values.split_at_mut(2);
2048             {
2049                 let left: &[_] = left;
2050                 assert!(&left[..left.len()] == &[1, 2][]);
2051             }
2052             for p in left {
2053                 *p += 1;
2054             }
2055
2056             {
2057                 let right: &[_] = right;
2058                 assert!(&right[..right.len()] == &[3, 4, 5][]);
2059             }
2060             for p in right {
2061                 *p += 2;
2062             }
2063         }
2064
2065         assert!(values == vec![2, 3, 5, 6, 7]);
2066     }
2067
2068     #[test]
2069     fn test_clone() {
2070         let v: Vec<i32> = vec![];
2071         let w = vec!(1, 2, 3);
2072
2073         assert_eq!(v, v.clone());
2074
2075         let z = w.clone();
2076         assert_eq!(w, z);
2077         // they should be disjoint in memory.
2078         assert!(w.as_ptr() != z.as_ptr())
2079     }
2080
2081     #[test]
2082     fn test_clone_from() {
2083         let mut v = vec!();
2084         let three = vec!(box 1, box 2, box 3);
2085         let two = vec!(box 4, box 5);
2086         // zero, long
2087         v.clone_from(&three);
2088         assert_eq!(v, three);
2089
2090         // equal
2091         v.clone_from(&three);
2092         assert_eq!(v, three);
2093
2094         // long, short
2095         v.clone_from(&two);
2096         assert_eq!(v, two);
2097
2098         // short, long
2099         v.clone_from(&three);
2100         assert_eq!(v, three)
2101     }
2102
2103     #[test]
2104     fn test_retain() {
2105         let mut vec = vec![1, 2, 3, 4];
2106         vec.retain(|&x| x % 2 == 0);
2107         assert!(vec == vec![2, 4]);
2108     }
2109
2110     #[test]
2111     fn zero_sized_values() {
2112         let mut v = Vec::new();
2113         assert_eq!(v.len(), 0);
2114         v.push(());
2115         assert_eq!(v.len(), 1);
2116         v.push(());
2117         assert_eq!(v.len(), 2);
2118         assert_eq!(v.pop(), Some(()));
2119         assert_eq!(v.pop(), Some(()));
2120         assert_eq!(v.pop(), None);
2121
2122         assert_eq!(v.iter().count(), 0);
2123         v.push(());
2124         assert_eq!(v.iter().count(), 1);
2125         v.push(());
2126         assert_eq!(v.iter().count(), 2);
2127
2128         for &() in &v {}
2129
2130         assert_eq!(v.iter_mut().count(), 2);
2131         v.push(());
2132         assert_eq!(v.iter_mut().count(), 3);
2133         v.push(());
2134         assert_eq!(v.iter_mut().count(), 4);
2135
2136         for &mut () in &mut v {}
2137         unsafe { v.set_len(0); }
2138         assert_eq!(v.iter_mut().count(), 0);
2139     }
2140
2141     #[test]
2142     fn test_partition() {
2143         assert_eq!(vec![].into_iter().partition(|x: &i32| *x < 3), (vec![], vec![]));
2144         assert_eq!(vec![1, 2, 3].into_iter().partition(|x| *x < 4), (vec![1, 2, 3], vec![]));
2145         assert_eq!(vec![1, 2, 3].into_iter().partition(|x| *x < 2), (vec![1], vec![2, 3]));
2146         assert_eq!(vec![1, 2, 3].into_iter().partition(|x| *x < 0), (vec![], vec![1, 2, 3]));
2147     }
2148
2149     #[test]
2150     fn test_zip_unzip() {
2151         let z1 = vec![(1, 4), (2, 5), (3, 6)];
2152
2153         let (left, right): (Vec<_>, Vec<_>) = z1.iter().map(|&x| x).unzip();
2154
2155         assert_eq!((1, 4), (left[0], right[0]));
2156         assert_eq!((2, 5), (left[1], right[1]));
2157         assert_eq!((3, 6), (left[2], right[2]));
2158     }
2159
2160     #[test]
2161     fn test_unsafe_ptrs() {
2162         unsafe {
2163             // Test on-stack copy-from-buf.
2164             let a = [1, 2, 3];
2165             let ptr = a.as_ptr();
2166             let b = Vec::from_raw_buf(ptr, 3);
2167             assert_eq!(b, vec![1, 2, 3]);
2168
2169             // Test on-heap copy-from-buf.
2170             let c = vec![1, 2, 3, 4, 5];
2171             let ptr = c.as_ptr();
2172             let d = Vec::from_raw_buf(ptr, 5);
2173             assert_eq!(d, vec![1, 2, 3, 4, 5]);
2174         }
2175     }
2176
2177     #[test]
2178     fn test_vec_truncate_drop() {
2179         static mut drops: u32 = 0;
2180         struct Elem(i32);
2181         impl Drop for Elem {
2182             fn drop(&mut self) {
2183                 unsafe { drops += 1; }
2184             }
2185         }
2186
2187         let mut v = vec![Elem(1), Elem(2), Elem(3), Elem(4), Elem(5)];
2188         assert_eq!(unsafe { drops }, 0);
2189         v.truncate(3);
2190         assert_eq!(unsafe { drops }, 2);
2191         v.truncate(0);
2192         assert_eq!(unsafe { drops }, 5);
2193     }
2194
2195     #[test]
2196     #[should_fail]
2197     fn test_vec_truncate_fail() {
2198         struct BadElem(i32);
2199         impl Drop for BadElem {
2200             fn drop(&mut self) {
2201                 let BadElem(ref mut x) = *self;
2202                 if *x == 0xbadbeef {
2203                     panic!("BadElem panic: 0xbadbeef")
2204                 }
2205             }
2206         }
2207
2208         let mut v = vec![BadElem(1), BadElem(2), BadElem(0xbadbeef), BadElem(4)];
2209         v.truncate(0);
2210     }
2211
2212     #[test]
2213     fn test_index() {
2214         let vec = vec![1, 2, 3];
2215         assert!(vec[1] == 2);
2216     }
2217
2218     #[test]
2219     #[should_fail]
2220     fn test_index_out_of_bounds() {
2221         let vec = vec![1, 2, 3];
2222         let _ = vec[3];
2223     }
2224
2225     #[test]
2226     #[should_fail]
2227     fn test_slice_out_of_bounds_1() {
2228         let x = vec![1, 2, 3, 4, 5];
2229         &x[-1..];
2230     }
2231
2232     #[test]
2233     #[should_fail]
2234     fn test_slice_out_of_bounds_2() {
2235         let x = vec![1, 2, 3, 4, 5];
2236         &x[..6];
2237     }
2238
2239     #[test]
2240     #[should_fail]
2241     fn test_slice_out_of_bounds_3() {
2242         let x = vec![1, 2, 3, 4, 5];
2243         &x[-1..4];
2244     }
2245
2246     #[test]
2247     #[should_fail]
2248     fn test_slice_out_of_bounds_4() {
2249         let x = vec![1, 2, 3, 4, 5];
2250         &x[1..6];
2251     }
2252
2253     #[test]
2254     #[should_fail]
2255     fn test_slice_out_of_bounds_5() {
2256         let x = vec![1, 2, 3, 4, 5];
2257         &x[3..2];
2258     }
2259
2260     #[test]
2261     #[should_fail]
2262     fn test_swap_remove_empty() {
2263         let mut vec= Vec::<i32>::new();
2264         vec.swap_remove(0);
2265     }
2266
2267     #[test]
2268     fn test_move_iter_unwrap() {
2269         let mut vec = Vec::with_capacity(7);
2270         vec.push(1);
2271         vec.push(2);
2272         let ptr = vec.as_ptr();
2273         vec = vec.into_iter().into_inner();
2274         assert_eq!(vec.as_ptr(), ptr);
2275         assert_eq!(vec.capacity(), 7);
2276         assert_eq!(vec.len(), 0);
2277     }
2278
2279     #[test]
2280     #[should_fail]
2281     fn test_map_in_place_incompatible_types_fail() {
2282         let v = vec![0, 1, 2];
2283         v.map_in_place(|_| ());
2284     }
2285
2286     #[test]
2287     fn test_map_in_place() {
2288         let v = vec![0, 1, 2];
2289         assert_eq!(v.map_in_place(|i: u32| i as i32 - 1), [-1, 0, 1]);
2290     }
2291
2292     #[test]
2293     fn test_map_in_place_zero_sized() {
2294         let v = vec![(), ()];
2295         #[derive(PartialEq, Debug)]
2296         struct ZeroSized;
2297         assert_eq!(v.map_in_place(|_| ZeroSized), [ZeroSized, ZeroSized]);
2298     }
2299
2300     #[test]
2301     fn test_map_in_place_zero_drop_count() {
2302         use std::sync::atomic::{AtomicUsize, Ordering, ATOMIC_USIZE_INIT};
2303
2304         #[derive(Clone, PartialEq, Debug)]
2305         struct Nothing;
2306         impl Drop for Nothing { fn drop(&mut self) { } }
2307
2308         #[derive(Clone, PartialEq, Debug)]
2309         struct ZeroSized;
2310         impl Drop for ZeroSized {
2311             fn drop(&mut self) {
2312                 DROP_COUNTER.fetch_add(1, Ordering::Relaxed);
2313             }
2314         }
2315         const NUM_ELEMENTS: usize = 2;
2316         static DROP_COUNTER: AtomicUsize = ATOMIC_USIZE_INIT;
2317
2318         let v = repeat(Nothing).take(NUM_ELEMENTS).collect::<Vec<_>>();
2319
2320         DROP_COUNTER.store(0, Ordering::Relaxed);
2321
2322         let v = v.map_in_place(|_| ZeroSized);
2323         assert_eq!(DROP_COUNTER.load(Ordering::Relaxed), 0);
2324         drop(v);
2325         assert_eq!(DROP_COUNTER.load(Ordering::Relaxed), NUM_ELEMENTS);
2326     }
2327
2328     #[test]
2329     fn test_move_items() {
2330         let vec = vec![1, 2, 3];
2331         let mut vec2 = vec![];
2332         for i in vec {
2333             vec2.push(i);
2334         }
2335         assert!(vec2 == vec![1, 2, 3]);
2336     }
2337
2338     #[test]
2339     fn test_move_items_reverse() {
2340         let vec = vec![1, 2, 3];
2341         let mut vec2 = vec![];
2342         for i in vec.into_iter().rev() {
2343             vec2.push(i);
2344         }
2345         assert!(vec2 == vec![3, 2, 1]);
2346     }
2347
2348     #[test]
2349     fn test_move_items_zero_sized() {
2350         let vec = vec![(), (), ()];
2351         let mut vec2 = vec![];
2352         for i in vec {
2353             vec2.push(i);
2354         }
2355         assert!(vec2 == vec![(), (), ()]);
2356     }
2357
2358     #[test]
2359     fn test_drain_items() {
2360         let mut vec = vec![1, 2, 3];
2361         let mut vec2 = vec![];
2362         for i in vec.drain() {
2363             vec2.push(i);
2364         }
2365         assert_eq!(vec, []);
2366         assert_eq!(vec2, [ 1, 2, 3 ]);
2367     }
2368
2369     #[test]
2370     fn test_drain_items_reverse() {
2371         let mut vec = vec![1, 2, 3];
2372         let mut vec2 = vec![];
2373         for i in vec.drain().rev() {
2374             vec2.push(i);
2375         }
2376         assert_eq!(vec, []);
2377         assert_eq!(vec2, [3, 2, 1]);
2378     }
2379
2380     #[test]
2381     fn test_drain_items_zero_sized() {
2382         let mut vec = vec![(), (), ()];
2383         let mut vec2 = vec![];
2384         for i in vec.drain() {
2385             vec2.push(i);
2386         }
2387         assert_eq!(vec, []);
2388         assert_eq!(vec2, [(), (), ()]);
2389     }
2390
2391     #[test]
2392     fn test_into_boxed_slice() {
2393         let xs = vec![1, 2, 3];
2394         let ys = xs.into_boxed_slice();
2395         assert_eq!(ys, [1, 2, 3]);
2396     }
2397
2398     #[test]
2399     fn test_append() {
2400         let mut vec = vec![1, 2, 3];
2401         let mut vec2 = vec![4, 5, 6];
2402         vec.append(&mut vec2);
2403         assert_eq!(vec, vec![1, 2, 3, 4, 5, 6]);
2404         assert_eq!(vec2, vec![]);
2405     }
2406
2407     #[test]
2408     fn test_split_off() {
2409         let mut vec = vec![1, 2, 3, 4, 5, 6];
2410         let vec2 = vec.split_off(4);
2411         assert_eq!(vec, vec![1, 2, 3, 4]);
2412         assert_eq!(vec2, vec![5, 6]);
2413     }
2414
2415     #[bench]
2416     fn bench_new(b: &mut Bencher) {
2417         b.iter(|| {
2418             let v: Vec<u32> = Vec::new();
2419             assert_eq!(v.len(), 0);
2420             assert_eq!(v.capacity(), 0);
2421         })
2422     }
2423
2424     fn do_bench_with_capacity(b: &mut Bencher, src_len: usize) {
2425         b.bytes = src_len as u64;
2426
2427         b.iter(|| {
2428             let v: Vec<u32> = Vec::with_capacity(src_len);
2429             assert_eq!(v.len(), 0);
2430             assert_eq!(v.capacity(), src_len);
2431         })
2432     }
2433
2434     #[bench]
2435     fn bench_with_capacity_0000(b: &mut Bencher) {
2436         do_bench_with_capacity(b, 0)
2437     }
2438
2439     #[bench]
2440     fn bench_with_capacity_0010(b: &mut Bencher) {
2441         do_bench_with_capacity(b, 10)
2442     }
2443
2444     #[bench]
2445     fn bench_with_capacity_0100(b: &mut Bencher) {
2446         do_bench_with_capacity(b, 100)
2447     }
2448
2449     #[bench]
2450     fn bench_with_capacity_1000(b: &mut Bencher) {
2451         do_bench_with_capacity(b, 1000)
2452     }
2453
2454     fn do_bench_from_fn(b: &mut Bencher, src_len: usize) {
2455         b.bytes = src_len as u64;
2456
2457         b.iter(|| {
2458             let dst = (0..src_len).collect::<Vec<_>>();
2459             assert_eq!(dst.len(), src_len);
2460             assert!(dst.iter().enumerate().all(|(i, x)| i == *x));
2461         })
2462     }
2463
2464     #[bench]
2465     fn bench_from_fn_0000(b: &mut Bencher) {
2466         do_bench_from_fn(b, 0)
2467     }
2468
2469     #[bench]
2470     fn bench_from_fn_0010(b: &mut Bencher) {
2471         do_bench_from_fn(b, 10)
2472     }
2473
2474     #[bench]
2475     fn bench_from_fn_0100(b: &mut Bencher) {
2476         do_bench_from_fn(b, 100)
2477     }
2478
2479     #[bench]
2480     fn bench_from_fn_1000(b: &mut Bencher) {
2481         do_bench_from_fn(b, 1000)
2482     }
2483
2484     fn do_bench_from_elem(b: &mut Bencher, src_len: usize) {
2485         b.bytes = src_len as u64;
2486
2487         b.iter(|| {
2488             let dst: Vec<usize> = repeat(5).take(src_len).collect();
2489             assert_eq!(dst.len(), src_len);
2490             assert!(dst.iter().all(|x| *x == 5));
2491         })
2492     }
2493
2494     #[bench]
2495     fn bench_from_elem_0000(b: &mut Bencher) {
2496         do_bench_from_elem(b, 0)
2497     }
2498
2499     #[bench]
2500     fn bench_from_elem_0010(b: &mut Bencher) {
2501         do_bench_from_elem(b, 10)
2502     }
2503
2504     #[bench]
2505     fn bench_from_elem_0100(b: &mut Bencher) {
2506         do_bench_from_elem(b, 100)
2507     }
2508
2509     #[bench]
2510     fn bench_from_elem_1000(b: &mut Bencher) {
2511         do_bench_from_elem(b, 1000)
2512     }
2513
2514     fn do_bench_from_slice(b: &mut Bencher, src_len: usize) {
2515         let src: Vec<_> = FromIterator::from_iter(0..src_len);
2516
2517         b.bytes = src_len as u64;
2518
2519         b.iter(|| {
2520             let dst = src.clone()[].to_vec();
2521             assert_eq!(dst.len(), src_len);
2522             assert!(dst.iter().enumerate().all(|(i, x)| i == *x));
2523         });
2524     }
2525
2526     #[bench]
2527     fn bench_from_slice_0000(b: &mut Bencher) {
2528         do_bench_from_slice(b, 0)
2529     }
2530
2531     #[bench]
2532     fn bench_from_slice_0010(b: &mut Bencher) {
2533         do_bench_from_slice(b, 10)
2534     }
2535
2536     #[bench]
2537     fn bench_from_slice_0100(b: &mut Bencher) {
2538         do_bench_from_slice(b, 100)
2539     }
2540
2541     #[bench]
2542     fn bench_from_slice_1000(b: &mut Bencher) {
2543         do_bench_from_slice(b, 1000)
2544     }
2545
2546     fn do_bench_from_iter(b: &mut Bencher, src_len: usize) {
2547         let src: Vec<_> = FromIterator::from_iter(0..src_len);
2548
2549         b.bytes = src_len as u64;
2550
2551         b.iter(|| {
2552             let dst: Vec<_> = FromIterator::from_iter(src.clone().into_iter());
2553             assert_eq!(dst.len(), src_len);
2554             assert!(dst.iter().enumerate().all(|(i, x)| i == *x));
2555         });
2556     }
2557
2558     #[bench]
2559     fn bench_from_iter_0000(b: &mut Bencher) {
2560         do_bench_from_iter(b, 0)
2561     }
2562
2563     #[bench]
2564     fn bench_from_iter_0010(b: &mut Bencher) {
2565         do_bench_from_iter(b, 10)
2566     }
2567
2568     #[bench]
2569     fn bench_from_iter_0100(b: &mut Bencher) {
2570         do_bench_from_iter(b, 100)
2571     }
2572
2573     #[bench]
2574     fn bench_from_iter_1000(b: &mut Bencher) {
2575         do_bench_from_iter(b, 1000)
2576     }
2577
2578     fn do_bench_extend(b: &mut Bencher, dst_len: usize, src_len: usize) {
2579         let dst: Vec<_> = FromIterator::from_iter(0..dst_len);
2580         let src: Vec<_> = FromIterator::from_iter(dst_len..dst_len + src_len);
2581
2582         b.bytes = src_len as u64;
2583
2584         b.iter(|| {
2585             let mut dst = dst.clone();
2586             dst.extend(src.clone().into_iter());
2587             assert_eq!(dst.len(), dst_len + src_len);
2588             assert!(dst.iter().enumerate().all(|(i, x)| i == *x));
2589         });
2590     }
2591
2592     #[bench]
2593     fn bench_extend_0000_0000(b: &mut Bencher) {
2594         do_bench_extend(b, 0, 0)
2595     }
2596
2597     #[bench]
2598     fn bench_extend_0000_0010(b: &mut Bencher) {
2599         do_bench_extend(b, 0, 10)
2600     }
2601
2602     #[bench]
2603     fn bench_extend_0000_0100(b: &mut Bencher) {
2604         do_bench_extend(b, 0, 100)
2605     }
2606
2607     #[bench]
2608     fn bench_extend_0000_1000(b: &mut Bencher) {
2609         do_bench_extend(b, 0, 1000)
2610     }
2611
2612     #[bench]
2613     fn bench_extend_0010_0010(b: &mut Bencher) {
2614         do_bench_extend(b, 10, 10)
2615     }
2616
2617     #[bench]
2618     fn bench_extend_0100_0100(b: &mut Bencher) {
2619         do_bench_extend(b, 100, 100)
2620     }
2621
2622     #[bench]
2623     fn bench_extend_1000_1000(b: &mut Bencher) {
2624         do_bench_extend(b, 1000, 1000)
2625     }
2626
2627     fn do_bench_push_all(b: &mut Bencher, dst_len: usize, src_len: usize) {
2628         let dst: Vec<_> = FromIterator::from_iter(0..dst_len);
2629         let src: Vec<_> = FromIterator::from_iter(dst_len..dst_len + src_len);
2630
2631         b.bytes = src_len as u64;
2632
2633         b.iter(|| {
2634             let mut dst = dst.clone();
2635             dst.push_all(&src);
2636             assert_eq!(dst.len(), dst_len + src_len);
2637             assert!(dst.iter().enumerate().all(|(i, x)| i == *x));
2638         });
2639     }
2640
2641     #[bench]
2642     fn bench_push_all_0000_0000(b: &mut Bencher) {
2643         do_bench_push_all(b, 0, 0)
2644     }
2645
2646     #[bench]
2647     fn bench_push_all_0000_0010(b: &mut Bencher) {
2648         do_bench_push_all(b, 0, 10)
2649     }
2650
2651     #[bench]
2652     fn bench_push_all_0000_0100(b: &mut Bencher) {
2653         do_bench_push_all(b, 0, 100)
2654     }
2655
2656     #[bench]
2657     fn bench_push_all_0000_1000(b: &mut Bencher) {
2658         do_bench_push_all(b, 0, 1000)
2659     }
2660
2661     #[bench]
2662     fn bench_push_all_0010_0010(b: &mut Bencher) {
2663         do_bench_push_all(b, 10, 10)
2664     }
2665
2666     #[bench]
2667     fn bench_push_all_0100_0100(b: &mut Bencher) {
2668         do_bench_push_all(b, 100, 100)
2669     }
2670
2671     #[bench]
2672     fn bench_push_all_1000_1000(b: &mut Bencher) {
2673         do_bench_push_all(b, 1000, 1000)
2674     }
2675
2676     fn do_bench_push_all_move(b: &mut Bencher, dst_len: usize, src_len: usize) {
2677         let dst: Vec<_> = FromIterator::from_iter(0..dst_len);
2678         let src: Vec<_> = FromIterator::from_iter(dst_len..dst_len + src_len);
2679
2680         b.bytes = src_len as u64;
2681
2682         b.iter(|| {
2683             let mut dst = dst.clone();
2684             dst.extend(src.clone().into_iter());
2685             assert_eq!(dst.len(), dst_len + src_len);
2686             assert!(dst.iter().enumerate().all(|(i, x)| i == *x));
2687         });
2688     }
2689
2690     #[bench]
2691     fn bench_push_all_move_0000_0000(b: &mut Bencher) {
2692         do_bench_push_all_move(b, 0, 0)
2693     }
2694
2695     #[bench]
2696     fn bench_push_all_move_0000_0010(b: &mut Bencher) {
2697         do_bench_push_all_move(b, 0, 10)
2698     }
2699
2700     #[bench]
2701     fn bench_push_all_move_0000_0100(b: &mut Bencher) {
2702         do_bench_push_all_move(b, 0, 100)
2703     }
2704
2705     #[bench]
2706     fn bench_push_all_move_0000_1000(b: &mut Bencher) {
2707         do_bench_push_all_move(b, 0, 1000)
2708     }
2709
2710     #[bench]
2711     fn bench_push_all_move_0010_0010(b: &mut Bencher) {
2712         do_bench_push_all_move(b, 10, 10)
2713     }
2714
2715     #[bench]
2716     fn bench_push_all_move_0100_0100(b: &mut Bencher) {
2717         do_bench_push_all_move(b, 100, 100)
2718     }
2719
2720     #[bench]
2721     fn bench_push_all_move_1000_1000(b: &mut Bencher) {
2722         do_bench_push_all_move(b, 1000, 1000)
2723     }
2724
2725     fn do_bench_clone(b: &mut Bencher, src_len: usize) {
2726         let src: Vec<usize> = FromIterator::from_iter(0..src_len);
2727
2728         b.bytes = src_len as u64;
2729
2730         b.iter(|| {
2731             let dst = src.clone();
2732             assert_eq!(dst.len(), src_len);
2733             assert!(dst.iter().enumerate().all(|(i, x)| i == *x));
2734         });
2735     }
2736
2737     #[bench]
2738     fn bench_clone_0000(b: &mut Bencher) {
2739         do_bench_clone(b, 0)
2740     }
2741
2742     #[bench]
2743     fn bench_clone_0010(b: &mut Bencher) {
2744         do_bench_clone(b, 10)
2745     }
2746
2747     #[bench]
2748     fn bench_clone_0100(b: &mut Bencher) {
2749         do_bench_clone(b, 100)
2750     }
2751
2752     #[bench]
2753     fn bench_clone_1000(b: &mut Bencher) {
2754         do_bench_clone(b, 1000)
2755     }
2756
2757     fn do_bench_clone_from(b: &mut Bencher, times: usize, dst_len: usize, src_len: usize) {
2758         let dst: Vec<_> = FromIterator::from_iter(0..src_len);
2759         let src: Vec<_> = FromIterator::from_iter(dst_len..dst_len + src_len);
2760
2761         b.bytes = (times * src_len) as u64;
2762
2763         b.iter(|| {
2764             let mut dst = dst.clone();
2765
2766             for _ in 0..times {
2767                 dst.clone_from(&src);
2768
2769                 assert_eq!(dst.len(), src_len);
2770                 assert!(dst.iter().enumerate().all(|(i, x)| dst_len + i == *x));
2771             }
2772         });
2773     }
2774
2775     #[bench]
2776     fn bench_clone_from_01_0000_0000(b: &mut Bencher) {
2777         do_bench_clone_from(b, 1, 0, 0)
2778     }
2779
2780     #[bench]
2781     fn bench_clone_from_01_0000_0010(b: &mut Bencher) {
2782         do_bench_clone_from(b, 1, 0, 10)
2783     }
2784
2785     #[bench]
2786     fn bench_clone_from_01_0000_0100(b: &mut Bencher) {
2787         do_bench_clone_from(b, 1, 0, 100)
2788     }
2789
2790     #[bench]
2791     fn bench_clone_from_01_0000_1000(b: &mut Bencher) {
2792         do_bench_clone_from(b, 1, 0, 1000)
2793     }
2794
2795     #[bench]
2796     fn bench_clone_from_01_0010_0010(b: &mut Bencher) {
2797         do_bench_clone_from(b, 1, 10, 10)
2798     }
2799
2800     #[bench]
2801     fn bench_clone_from_01_0100_0100(b: &mut Bencher) {
2802         do_bench_clone_from(b, 1, 100, 100)
2803     }
2804
2805     #[bench]
2806     fn bench_clone_from_01_1000_1000(b: &mut Bencher) {
2807         do_bench_clone_from(b, 1, 1000, 1000)
2808     }
2809
2810     #[bench]
2811     fn bench_clone_from_01_0010_0100(b: &mut Bencher) {
2812         do_bench_clone_from(b, 1, 10, 100)
2813     }
2814
2815     #[bench]
2816     fn bench_clone_from_01_0100_1000(b: &mut Bencher) {
2817         do_bench_clone_from(b, 1, 100, 1000)
2818     }
2819
2820     #[bench]
2821     fn bench_clone_from_01_0010_0000(b: &mut Bencher) {
2822         do_bench_clone_from(b, 1, 10, 0)
2823     }
2824
2825     #[bench]
2826     fn bench_clone_from_01_0100_0010(b: &mut Bencher) {
2827         do_bench_clone_from(b, 1, 100, 10)
2828     }
2829
2830     #[bench]
2831     fn bench_clone_from_01_1000_0100(b: &mut Bencher) {
2832         do_bench_clone_from(b, 1, 1000, 100)
2833     }
2834
2835     #[bench]
2836     fn bench_clone_from_10_0000_0000(b: &mut Bencher) {
2837         do_bench_clone_from(b, 10, 0, 0)
2838     }
2839
2840     #[bench]
2841     fn bench_clone_from_10_0000_0010(b: &mut Bencher) {
2842         do_bench_clone_from(b, 10, 0, 10)
2843     }
2844
2845     #[bench]
2846     fn bench_clone_from_10_0000_0100(b: &mut Bencher) {
2847         do_bench_clone_from(b, 10, 0, 100)
2848     }
2849
2850     #[bench]
2851     fn bench_clone_from_10_0000_1000(b: &mut Bencher) {
2852         do_bench_clone_from(b, 10, 0, 1000)
2853     }
2854
2855     #[bench]
2856     fn bench_clone_from_10_0010_0010(b: &mut Bencher) {
2857         do_bench_clone_from(b, 10, 10, 10)
2858     }
2859
2860     #[bench]
2861     fn bench_clone_from_10_0100_0100(b: &mut Bencher) {
2862         do_bench_clone_from(b, 10, 100, 100)
2863     }
2864
2865     #[bench]
2866     fn bench_clone_from_10_1000_1000(b: &mut Bencher) {
2867         do_bench_clone_from(b, 10, 1000, 1000)
2868     }
2869
2870     #[bench]
2871     fn bench_clone_from_10_0010_0100(b: &mut Bencher) {
2872         do_bench_clone_from(b, 10, 10, 100)
2873     }
2874
2875     #[bench]
2876     fn bench_clone_from_10_0100_1000(b: &mut Bencher) {
2877         do_bench_clone_from(b, 10, 100, 1000)
2878     }
2879
2880     #[bench]
2881     fn bench_clone_from_10_0010_0000(b: &mut Bencher) {
2882         do_bench_clone_from(b, 10, 10, 0)
2883     }
2884
2885     #[bench]
2886     fn bench_clone_from_10_0100_0010(b: &mut Bencher) {
2887         do_bench_clone_from(b, 10, 100, 10)
2888     }
2889
2890     #[bench]
2891     fn bench_clone_from_10_1000_0100(b: &mut Bencher) {
2892         do_bench_clone_from(b, 10, 1000, 100)
2893     }
2894 }