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