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.
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.
11 //! A contiguous growable array type with heap-allocated contents, written
12 //! `Vec<T>` but pronounced 'vector.'
14 //! Vectors have `O(1)` indexing, amortized `O(1)` push (to the end) and
15 //! `O(1)` pop (from the end).
19 //! You can explicitly create a `Vec<T>` with `new()`:
22 //! let v: Vec<i32> = Vec::new();
25 //! ...or by using the `vec!` macro:
28 //! let v: Vec<i32> = vec![];
30 //! let v = vec![1, 2, 3, 4, 5];
32 //! let v = vec![0; 10]; // ten zeroes
35 //! You can `push` values onto the end of a vector (which will grow the vector
39 //! let mut v = vec![1, 2];
44 //! Popping values works in much the same way:
47 //! let mut v = vec![1, 2];
49 //! let two = v.pop();
52 //! Vectors also support indexing (through the `Index` and `IndexMut` traits):
55 //! let mut v = vec![1, 2, 3];
60 #![stable(feature = "rust1", since = "1.0.0")]
62 use alloc::boxed::Box;
63 use alloc::heap::EMPTY;
64 use alloc::raw_vec::RawVec;
67 use core::cmp::Ordering;
69 use core::hash::{self, Hash};
70 use core::intrinsics::{arith_offset, assume};
71 use core::iter::FromIterator;
73 use core::ops::{Index, IndexMut};
78 use super::SpecExtend;
79 use super::range::RangeArgument;
81 /// A contiguous growable array type, written `Vec<T>` but pronounced 'vector.'
86 /// let mut vec = Vec::new();
90 /// assert_eq!(vec.len(), 2);
91 /// assert_eq!(vec[0], 1);
93 /// assert_eq!(vec.pop(), Some(2));
94 /// assert_eq!(vec.len(), 1);
97 /// assert_eq!(vec[0], 7);
99 /// vec.extend([1, 2, 3].iter().cloned());
102 /// println!("{}", x);
104 /// assert_eq!(vec, [7, 1, 2, 3]);
107 /// The `vec!` macro is provided to make initialization more convenient:
110 /// let mut vec = vec![1, 2, 3];
112 /// assert_eq!(vec, [1, 2, 3, 4]);
115 /// It can also initialize each element of a `Vec<T>` with a given value:
118 /// let vec = vec![0; 5];
119 /// assert_eq!(vec, [0, 0, 0, 0, 0]);
122 /// Use a `Vec<T>` as an efficient stack:
125 /// let mut stack = Vec::new();
131 /// while let Some(top) = stack.pop() {
132 /// // Prints 3, 2, 1
133 /// println!("{}", top);
139 /// The Vec type allows to access values by index, because it implements the
140 /// `Index` trait. An example will be more explicit:
143 /// let v = vec!(0, 2, 4, 6);
144 /// println!("{}", v[1]); // it will display '2'
147 /// However be careful: if you try to access an index which isn't in the Vec,
148 /// your software will panic! You cannot do this:
151 /// let v = vec!(0, 2, 4, 6);
152 /// println!("{}", v[6]); // it will panic!
155 /// In conclusion: always check if the index you want to get really exists
160 /// A Vec can be mutable. Slices, on the other hand, are read-only objects.
161 /// To get a slice, use "&". Example:
164 /// fn read_slice(slice: &[usize]) {
168 /// let v = vec!(0, 1);
171 /// // ... and that's all!
172 /// // you can also do it like this:
173 /// let x : &[usize] = &v;
176 /// In Rust, it's more common to pass slices as arguments rather than vectors
177 /// when you just want to provide a read access. The same goes for String and
180 /// # Capacity and reallocation
182 /// The capacity of a vector is the amount of space allocated for any future
183 /// elements that will be added onto the vector. This is not to be confused with
184 /// the *length* of a vector, which specifies the number of actual elements
185 /// within the vector. If a vector's length exceeds its capacity, its capacity
186 /// will automatically be increased, but its elements will have to be
189 /// For example, a vector with capacity 10 and length 0 would be an empty vector
190 /// with space for 10 more elements. Pushing 10 or fewer elements onto the
191 /// vector will not change its capacity or cause reallocation to occur. However,
192 /// if the vector's length is increased to 11, it will have to reallocate, which
193 /// can be slow. For this reason, it is recommended to use `Vec::with_capacity`
194 /// whenever possible to specify how big the vector is expected to get.
198 /// Due to its incredibly fundamental nature, Vec makes a lot of guarantees
199 /// about its design. This ensures that it's as low-overhead as possible in
200 /// the general case, and can be correctly manipulated in primitive ways
201 /// by unsafe code. Note that these guarantees refer to an unqualified `Vec<T>`.
202 /// If additional type parameters are added (e.g. to support custom allocators),
203 /// overriding their defaults may change the behavior.
205 /// Most fundamentally, Vec is and always will be a (pointer, capacity, length)
206 /// triplet. No more, no less. The order of these fields is completely
207 /// unspecified, and you should use the appropriate methods to modify these.
208 /// The pointer will never be null, so this type is null-pointer-optimized.
210 /// However, the pointer may not actually point to allocated memory. In particular,
211 /// if you construct a Vec with capacity 0 via `Vec::new()`, `vec![]`,
212 /// `Vec::with_capacity(0)`, or by calling `shrink_to_fit()` on an empty Vec, it
213 /// will not allocate memory. Similarly, if you store zero-sized types inside
214 /// a Vec, it will not allocate space for them. *Note that in this case the
215 /// Vec may not report a `capacity()` of 0*. Vec will allocate if and only
216 /// if `mem::size_of::<T>() * capacity() > 0`. In general, Vec's allocation
217 /// details are subtle enough that it is strongly recommended that you only
218 /// free memory allocated by a Vec by creating a new Vec and dropping it.
220 /// If a Vec *has* allocated memory, then the memory it points to is on the heap
221 /// (as defined by the allocator Rust is configured to use by default), and its
222 /// pointer points to `len()` initialized elements in order (what you would see
223 /// if you coerced it to a slice), followed by `capacity() - len()` logically
224 /// uninitialized elements.
226 /// Vec will never perform a "small optimization" where elements are actually
227 /// stored on the stack for two reasons:
229 /// * It would make it more difficult for unsafe code to correctly manipulate
230 /// a Vec. The contents of a Vec wouldn't have a stable address if it were
231 /// only moved, and it would be more difficult to determine if a Vec had
232 /// actually allocated memory.
234 /// * It would penalize the general case, incurring an additional branch
237 /// Vec will never automatically shrink itself, even if completely empty. This
238 /// ensures no unnecessary allocations or deallocations occur. Emptying a Vec
239 /// and then filling it back up to the same `len()` should incur no calls to
240 /// the allocator. If you wish to free up unused memory, use `shrink_to_fit`.
242 /// `push` and `insert` will never (re)allocate if the reported capacity is
243 /// sufficient. `push` and `insert` *will* (re)allocate if `len() == capacity()`.
244 /// That is, the reported capacity is completely accurate, and can be relied on.
245 /// It can even be used to manually free the memory allocated by a Vec if
246 /// desired. Bulk insertion methods *may* reallocate, even when not necessary.
248 /// Vec does not guarantee any particular growth strategy when reallocating
249 /// when full, nor when `reserve` is called. The current strategy is basic
250 /// and it may prove desirable to use a non-constant growth factor. Whatever
251 /// strategy is used will of course guarantee `O(1)` amortized `push`.
253 /// `vec![x; n]`, `vec![a, b, c, d]`, and `Vec::with_capacity(n)`, will all
254 /// produce a Vec with exactly the requested capacity. If `len() == capacity()`,
255 /// (as is the case for the `vec!` macro), then a `Vec<T>` can be converted
256 /// to and from a `Box<[T]>` without reallocating or moving the elements.
258 /// Vec will not specifically overwrite any data that is removed from it,
259 /// but also won't specifically preserve it. Its uninitialized memory is
260 /// scratch space that it may use however it wants. It will generally just do
261 /// whatever is most efficient or otherwise easy to implement. Do not rely on
262 /// removed data to be erased for security purposes. Even if you drop a Vec, its
263 /// buffer may simply be reused by another Vec. Even if you zero a Vec's memory
264 /// first, that may not actually happen because the optimizer does not consider
265 /// this a side-effect that must be preserved.
267 /// Vec does not currently guarantee the order in which elements are dropped
268 /// (the order has changed in the past, and may change again).
270 #[unsafe_no_drop_flag]
271 #[stable(feature = "rust1", since = "1.0.0")]
277 ////////////////////////////////////////////////////////////////////////////////
279 ////////////////////////////////////////////////////////////////////////////////
282 /// Constructs a new, empty `Vec<T>`.
284 /// The vector will not allocate until elements are pushed onto it.
289 /// # #![allow(unused_mut)]
290 /// let mut vec: Vec<i32> = Vec::new();
293 #[stable(feature = "rust1", since = "1.0.0")]
294 pub fn new() -> Vec<T> {
301 /// Constructs a new, empty `Vec<T>` with the specified capacity.
303 /// The vector will be able to hold exactly `capacity` elements without
304 /// reallocating. If `capacity` is 0, the vector will not allocate.
306 /// It is important to note that this function does not specify the *length*
307 /// of the returned vector, but only the *capacity*. (For an explanation of
308 /// the difference between length and capacity, see the main `Vec<T>` docs
309 /// above, 'Capacity and reallocation'.)
314 /// let mut vec = Vec::with_capacity(10);
316 /// // The vector contains no items, even though it has capacity for more
317 /// assert_eq!(vec.len(), 0);
319 /// // These are all done without reallocating...
324 /// // ...but this may make the vector reallocate
328 #[stable(feature = "rust1", since = "1.0.0")]
329 pub fn with_capacity(capacity: usize) -> Vec<T> {
331 buf: RawVec::with_capacity(capacity),
336 /// Creates a `Vec<T>` directly from the raw components of another vector.
340 /// This is highly unsafe, due to the number of invariants that aren't
343 /// * `ptr` needs to have been previously allocated via `String`/`Vec<T>`
344 /// (at least, it's highly likely to be incorrect if it wasn't).
345 /// * `length` needs to be the length that less than or equal to `capacity`.
346 /// * `capacity` needs to be the capacity that the pointer was allocated with.
348 /// Violating these may cause problems like corrupting the allocator's
349 /// internal datastructures.
358 /// let mut v = vec![1, 2, 3];
360 /// // Pull out the various important pieces of information about `v`
361 /// let p = v.as_mut_ptr();
362 /// let len = v.len();
363 /// let cap = v.capacity();
366 /// // Cast `v` into the void: no destructor run, so we are in
367 /// // complete control of the allocation to which `p` points.
370 /// // Overwrite memory with 4, 5, 6
371 /// for i in 0..len as isize {
372 /// ptr::write(p.offset(i), 4 + i);
375 /// // Put everything back together into a Vec
376 /// let rebuilt = Vec::from_raw_parts(p, len, cap);
377 /// assert_eq!(rebuilt, [4, 5, 6]);
381 #[stable(feature = "rust1", since = "1.0.0")]
382 pub unsafe fn from_raw_parts(ptr: *mut T, length: usize, capacity: usize) -> Vec<T> {
384 buf: RawVec::from_raw_parts(ptr, capacity),
389 /// Returns the number of elements the vector can hold without
395 /// let vec: Vec<i32> = Vec::with_capacity(10);
396 /// assert_eq!(vec.capacity(), 10);
399 #[stable(feature = "rust1", since = "1.0.0")]
400 pub fn capacity(&self) -> usize {
404 /// Reserves capacity for at least `additional` more elements to be inserted
405 /// in the given `Vec<T>`. The collection may reserve more space to avoid
406 /// frequent reallocations.
410 /// Panics if the new capacity overflows `usize`.
415 /// let mut vec = vec![1];
417 /// assert!(vec.capacity() >= 11);
419 #[stable(feature = "rust1", since = "1.0.0")]
420 pub fn reserve(&mut self, additional: usize) {
421 self.buf.reserve(self.len, additional);
424 /// Reserves the minimum capacity for exactly `additional` more elements to
425 /// be inserted in the given `Vec<T>`. Does nothing if the capacity is already
428 /// Note that the allocator may give the collection more space than it
429 /// requests. Therefore capacity can not be relied upon to be precisely
430 /// minimal. Prefer `reserve` if future insertions are expected.
434 /// Panics if the new capacity overflows `usize`.
439 /// let mut vec = vec![1];
440 /// vec.reserve_exact(10);
441 /// assert!(vec.capacity() >= 11);
443 #[stable(feature = "rust1", since = "1.0.0")]
444 pub fn reserve_exact(&mut self, additional: usize) {
445 self.buf.reserve_exact(self.len, additional);
448 /// Shrinks the capacity of the vector as much as possible.
450 /// It will drop down as close as possible to the length but the allocator
451 /// may still inform the vector that there is space for a few more elements.
456 /// let mut vec = Vec::with_capacity(10);
457 /// vec.extend([1, 2, 3].iter().cloned());
458 /// assert_eq!(vec.capacity(), 10);
459 /// vec.shrink_to_fit();
460 /// assert!(vec.capacity() >= 3);
462 #[stable(feature = "rust1", since = "1.0.0")]
463 pub fn shrink_to_fit(&mut self) {
464 self.buf.shrink_to_fit(self.len);
467 /// Converts the vector into Box<[T]>.
469 /// Note that this will drop any excess capacity. Calling this and
470 /// converting back to a vector with `into_vec()` is equivalent to calling
471 /// `shrink_to_fit()`.
472 #[stable(feature = "rust1", since = "1.0.0")]
473 pub fn into_boxed_slice(mut self) -> Box<[T]> {
475 self.shrink_to_fit();
476 let buf = ptr::read(&self.buf);
482 /// Shorten a vector to be `len` elements long, dropping excess elements.
484 /// If `len` is greater than the vector's current length, this has no
490 /// let mut vec = vec![1, 2, 3, 4, 5];
492 /// assert_eq!(vec, [1, 2]);
494 #[stable(feature = "rust1", since = "1.0.0")]
495 pub fn truncate(&mut self, len: usize) {
497 // drop any extra elements
498 while len < self.len {
499 // decrement len before the drop_in_place(), so a panic on Drop
500 // doesn't re-drop the just-failed value.
503 ptr::drop_in_place(self.get_unchecked_mut(len));
508 /// Extracts a slice containing the entire vector.
510 /// Equivalent to `&s[..]`.
512 #[stable(feature = "vec_as_slice", since = "1.7.0")]
513 pub fn as_slice(&self) -> &[T] {
517 /// Extracts a mutable slice of the entire vector.
519 /// Equivalent to `&mut s[..]`.
521 #[stable(feature = "vec_as_slice", since = "1.7.0")]
522 pub fn as_mut_slice(&mut self) -> &mut [T] {
526 /// Sets the length of a vector.
528 /// This will explicitly set the size of the vector, without actually
529 /// modifying its buffers, so it is up to the caller to ensure that the
530 /// vector is actually the specified size.
535 /// let mut v = vec![1, 2, 3, 4];
541 #[stable(feature = "rust1", since = "1.0.0")]
542 pub unsafe fn set_len(&mut self, len: usize) {
546 /// Removes an element from anywhere in the vector and return it, replacing
547 /// it with the last element.
549 /// This does not preserve ordering, but is O(1).
553 /// Panics if `index` is out of bounds.
558 /// let mut v = vec!["foo", "bar", "baz", "qux"];
560 /// assert_eq!(v.swap_remove(1), "bar");
561 /// assert_eq!(v, ["foo", "qux", "baz"]);
563 /// assert_eq!(v.swap_remove(0), "foo");
564 /// assert_eq!(v, ["baz", "qux"]);
567 #[stable(feature = "rust1", since = "1.0.0")]
568 pub fn swap_remove(&mut self, index: usize) -> T {
569 let length = self.len();
570 self.swap(index, length - 1);
574 /// Inserts an element at position `index` within the vector, shifting all
575 /// elements after it to the right.
579 /// Panics if `index` is greater than the vector's length.
584 /// let mut vec = vec![1, 2, 3];
585 /// vec.insert(1, 4);
586 /// assert_eq!(vec, [1, 4, 2, 3]);
587 /// vec.insert(4, 5);
588 /// assert_eq!(vec, [1, 4, 2, 3, 5]);
590 #[stable(feature = "rust1", since = "1.0.0")]
591 pub fn insert(&mut self, index: usize, element: T) {
592 let len = self.len();
593 assert!(index <= len);
595 // space for the new element
596 if len == self.buf.cap() {
602 // The spot to put the new value
604 let p = self.as_mut_ptr().offset(index as isize);
605 // Shift everything over to make space. (Duplicating the
606 // `index`th element into two consecutive places.)
607 ptr::copy(p, p.offset(1), len - index);
608 // Write it in, overwriting the first copy of the `index`th
610 ptr::write(p, element);
612 self.set_len(len + 1);
616 /// Removes and returns the element at position `index` within the vector,
617 /// shifting all elements after it to the left.
621 /// Panics if `index` is out of bounds.
626 /// let mut v = vec![1, 2, 3];
627 /// assert_eq!(v.remove(1), 2);
628 /// assert_eq!(v, [1, 3]);
630 #[stable(feature = "rust1", since = "1.0.0")]
631 pub fn remove(&mut self, index: usize) -> T {
632 let len = self.len();
633 assert!(index < len);
638 // the place we are taking from.
639 let ptr = self.as_mut_ptr().offset(index as isize);
640 // copy it out, unsafely having a copy of the value on
641 // the stack and in the vector at the same time.
642 ret = ptr::read(ptr);
644 // Shift everything down to fill in that spot.
645 ptr::copy(ptr.offset(1), ptr, len - index - 1);
647 self.set_len(len - 1);
652 /// Retains only the elements specified by the predicate.
654 /// In other words, remove all elements `e` such that `f(&e)` returns false.
655 /// This method operates in place and preserves the order of the retained
661 /// let mut vec = vec![1, 2, 3, 4];
662 /// vec.retain(|&x| x%2 == 0);
663 /// assert_eq!(vec, [2, 4]);
665 #[stable(feature = "rust1", since = "1.0.0")]
666 pub fn retain<F>(&mut self, mut f: F)
667 where F: FnMut(&T) -> bool
669 let len = self.len();
683 self.truncate(len - del);
687 /// Appends an element to the back of a collection.
691 /// Panics if the number of elements in the vector overflows a `usize`.
696 /// let mut vec = vec![1, 2];
698 /// assert_eq!(vec, [1, 2, 3]);
701 #[stable(feature = "rust1", since = "1.0.0")]
702 pub fn push(&mut self, value: T) {
703 // This will panic or abort if we would allocate > isize::MAX bytes
704 // or if the length increment would overflow for zero-sized types.
705 if self.len == self.buf.cap() {
709 let end = self.as_mut_ptr().offset(self.len as isize);
710 ptr::write(end, value);
715 /// Removes the last element from a vector and returns it, or `None` if it
721 /// let mut vec = vec![1, 2, 3];
722 /// assert_eq!(vec.pop(), Some(3));
723 /// assert_eq!(vec, [1, 2]);
726 #[stable(feature = "rust1", since = "1.0.0")]
727 pub fn pop(&mut self) -> Option<T> {
733 Some(ptr::read(self.get_unchecked(self.len())))
738 /// Moves all the elements of `other` into `Self`, leaving `other` empty.
742 /// Panics if the number of elements in the vector overflows a `usize`.
747 /// let mut vec = vec![1, 2, 3];
748 /// let mut vec2 = vec![4, 5, 6];
749 /// vec.append(&mut vec2);
750 /// assert_eq!(vec, [1, 2, 3, 4, 5, 6]);
751 /// assert_eq!(vec2, []);
754 #[stable(feature = "append", since = "1.4.0")]
755 pub fn append(&mut self, other: &mut Self) {
756 self.reserve(other.len());
757 let len = self.len();
759 ptr::copy_nonoverlapping(other.as_ptr(), self.get_unchecked_mut(len), other.len());
762 self.len += other.len();
768 /// Create a draining iterator that removes the specified range in the vector
769 /// and yields the removed items.
771 /// Note 1: The element range is removed even if the iterator is not
772 /// consumed until the end.
774 /// Note 2: It is unspecified how many elements are removed from the vector,
775 /// if the `Drain` value is leaked.
779 /// Panics if the starting point is greater than the end point or if
780 /// the end point is greater than the length of the vector.
785 /// let mut v = vec![1, 2, 3];
786 /// let u: Vec<_> = v.drain(1..).collect();
787 /// assert_eq!(v, &[1]);
788 /// assert_eq!(u, &[2, 3]);
790 /// // A full range clears the vector
792 /// assert_eq!(v, &[]);
794 #[stable(feature = "drain", since = "1.6.0")]
795 pub fn drain<R>(&mut self, range: R) -> Drain<T>
796 where R: RangeArgument<usize>
800 // When the Drain is first created, it shortens the length of
801 // the source vector to make sure no uninitalized or moved-from elements
802 // are accessible at all if the Drain's destructor never gets to run.
804 // Drain will ptr::read out the values to remove.
805 // When finished, remaining tail of the vec is copied back to cover
806 // the hole, and the vector length is restored to the new length.
808 let len = self.len();
809 let start = *range.start().unwrap_or(&0);
810 let end = *range.end().unwrap_or(&len);
811 assert!(start <= end);
815 // set self.vec length's to start, to be safe in case Drain is leaked
817 // Use the borrow in the IterMut to indicate borrowing behavior of the
818 // whole Drain iterator (like &mut T).
819 let range_slice = slice::from_raw_parts_mut(self.as_mut_ptr().offset(start as isize),
824 iter: range_slice.iter_mut(),
830 /// Clears the vector, removing all values.
835 /// let mut v = vec![1, 2, 3];
839 /// assert!(v.is_empty());
842 #[stable(feature = "rust1", since = "1.0.0")]
843 pub fn clear(&mut self) {
847 /// Returns the number of elements in the vector.
852 /// let a = vec![1, 2, 3];
853 /// assert_eq!(a.len(), 3);
856 #[stable(feature = "rust1", since = "1.0.0")]
857 pub fn len(&self) -> usize {
861 /// Returns `true` if the vector contains no elements.
866 /// let mut v = Vec::new();
867 /// assert!(v.is_empty());
870 /// assert!(!v.is_empty());
872 #[stable(feature = "rust1", since = "1.0.0")]
873 pub fn is_empty(&self) -> bool {
877 /// Splits the collection into two at the given index.
879 /// Returns a newly allocated `Self`. `self` contains elements `[0, at)`,
880 /// and the returned `Self` contains elements `[at, len)`.
882 /// Note that the capacity of `self` does not change.
886 /// Panics if `at > len`.
891 /// let mut vec = vec![1,2,3];
892 /// let vec2 = vec.split_off(1);
893 /// assert_eq!(vec, [1]);
894 /// assert_eq!(vec2, [2, 3]);
897 #[stable(feature = "split_off", since = "1.4.0")]
898 pub fn split_off(&mut self, at: usize) -> Self {
899 assert!(at <= self.len(), "`at` out of bounds");
901 let other_len = self.len - at;
902 let mut other = Vec::with_capacity(other_len);
904 // Unsafely `set_len` and copy items to `other`.
907 other.set_len(other_len);
909 ptr::copy_nonoverlapping(self.as_ptr().offset(at as isize),
917 impl<T: Clone> Vec<T> {
918 /// Resizes the `Vec` in-place so that `len()` is equal to `new_len`.
920 /// If `new_len` is greater than `len()`, the `Vec` is extended by the
921 /// difference, with each additional slot filled with `value`.
922 /// If `new_len` is less than `len()`, the `Vec` is simply truncated.
927 /// let mut vec = vec!["hello"];
928 /// vec.resize(3, "world");
929 /// assert_eq!(vec, ["hello", "world", "world"]);
931 /// let mut vec = vec![1, 2, 3, 4];
932 /// vec.resize(2, 0);
933 /// assert_eq!(vec, [1, 2]);
935 #[stable(feature = "vec_resize", since = "1.5.0")]
936 pub fn resize(&mut self, new_len: usize, value: T) {
937 let len = self.len();
940 self.extend_with_element(new_len - len, value);
942 self.truncate(new_len);
946 /// Extend the vector by `n` additional clones of `value`.
947 fn extend_with_element(&mut self, n: usize, value: T) {
951 let len = self.len();
952 let mut ptr = self.as_mut_ptr().offset(len as isize);
953 // Write all elements except the last one
955 ptr::write(ptr, value.clone());
957 // Increment the length in every step in case clone() panics
958 self.set_len(len + i);
962 // We can write the last element directly without cloning needlessly
963 ptr::write(ptr, value);
964 self.set_len(len + n);
969 /// Clones and appends all elements in a slice to the `Vec`.
971 /// Iterates over the slice `other`, clones each element, and then appends
972 /// it to this `Vec`. The `other` vector is traversed in-order.
974 /// Note that this function is same as `extend` except that it is
975 /// specialized to work with slices instead. If and when Rust gets
976 /// specialization this function will likely be deprecated (but still
982 /// let mut vec = vec![1];
983 /// vec.extend_from_slice(&[2, 3, 4]);
984 /// assert_eq!(vec, [1, 2, 3, 4]);
986 #[stable(feature = "vec_extend_from_slice", since = "1.6.0")]
987 pub fn extend_from_slice(&mut self, other: &[T]) {
988 self.reserve(other.len());
990 for i in 0..other.len() {
991 let len = self.len();
993 // Unsafe code so this can be optimised to a memcpy (or something
994 // similarly fast) when T is Copy. LLVM is easily confused, so any
995 // extra operations during the loop can prevent this optimisation.
997 ptr::write(self.get_unchecked_mut(len), other.get_unchecked(i).clone());
998 self.set_len(len + 1);
1004 impl<T: PartialEq> Vec<T> {
1005 /// Removes consecutive repeated elements in the vector.
1007 /// If the vector is sorted, this removes all duplicates.
1012 /// let mut vec = vec![1, 2, 2, 3, 2];
1016 /// assert_eq!(vec, [1, 2, 3, 2]);
1018 #[stable(feature = "rust1", since = "1.0.0")]
1019 pub fn dedup(&mut self) {
1021 // Although we have a mutable reference to `self`, we cannot make
1022 // *arbitrary* changes. The `PartialEq` comparisons could panic, so we
1023 // must ensure that the vector is in a valid state at all time.
1025 // The way that we handle this is by using swaps; we iterate
1026 // over all the elements, swapping as we go so that at the end
1027 // the elements we wish to keep are in the front, and those we
1028 // wish to reject are at the back. We can then truncate the
1029 // vector. This operation is still O(n).
1031 // Example: We start in this state, where `r` represents "next
1032 // read" and `w` represents "next_write`.
1035 // +---+---+---+---+---+---+
1036 // | 0 | 1 | 1 | 2 | 3 | 3 |
1037 // +---+---+---+---+---+---+
1040 // Comparing self[r] against self[w-1], this is not a duplicate, so
1041 // we swap self[r] and self[w] (no effect as r==w) and then increment both
1042 // r and w, leaving us with:
1045 // +---+---+---+---+---+---+
1046 // | 0 | 1 | 1 | 2 | 3 | 3 |
1047 // +---+---+---+---+---+---+
1050 // Comparing self[r] against self[w-1], this value is a duplicate,
1051 // so we increment `r` but leave everything else unchanged:
1054 // +---+---+---+---+---+---+
1055 // | 0 | 1 | 1 | 2 | 3 | 3 |
1056 // +---+---+---+---+---+---+
1059 // Comparing self[r] against self[w-1], this is not a duplicate,
1060 // so swap self[r] and self[w] and advance r and w:
1063 // +---+---+---+---+---+---+
1064 // | 0 | 1 | 2 | 1 | 3 | 3 |
1065 // +---+---+---+---+---+---+
1068 // Not a duplicate, repeat:
1071 // +---+---+---+---+---+---+
1072 // | 0 | 1 | 2 | 3 | 1 | 3 |
1073 // +---+---+---+---+---+---+
1076 // Duplicate, advance r. End of vec. Truncate to w.
1078 let ln = self.len();
1083 // Avoid bounds checks by using raw pointers.
1084 let p = self.as_mut_ptr();
1085 let mut r: usize = 1;
1086 let mut w: usize = 1;
1089 let p_r = p.offset(r as isize);
1090 let p_wm1 = p.offset((w - 1) as isize);
1093 let p_w = p_wm1.offset(1);
1094 mem::swap(&mut *p_r, &mut *p_w);
1106 ////////////////////////////////////////////////////////////////////////////////
1107 // Internal methods and functions
1108 ////////////////////////////////////////////////////////////////////////////////
1111 #[stable(feature = "rust1", since = "1.0.0")]
1112 pub fn from_elem<T: Clone>(elem: T, n: usize) -> Vec<T> {
1113 let mut v = Vec::with_capacity(n);
1114 v.extend_with_element(n, elem);
1118 ////////////////////////////////////////////////////////////////////////////////
1119 // Common trait implementations for Vec
1120 ////////////////////////////////////////////////////////////////////////////////
1122 #[stable(feature = "rust1", since = "1.0.0")]
1123 impl<T: Clone> Clone for Vec<T> {
1125 fn clone(&self) -> Vec<T> {
1126 <[T]>::to_vec(&**self)
1129 // HACK(japaric): with cfg(test) the inherent `[T]::to_vec` method, which is
1130 // required for this method definition, is not available. Instead use the
1131 // `slice::to_vec` function which is only available with cfg(test)
1132 // NB see the slice::hack module in slice.rs for more information
1134 fn clone(&self) -> Vec<T> {
1135 ::slice::to_vec(&**self)
1138 fn clone_from(&mut self, other: &Vec<T>) {
1139 // drop anything in self that will not be overwritten
1140 self.truncate(other.len());
1141 let len = self.len();
1143 // reuse the contained values' allocations/resources.
1144 self.clone_from_slice(&other[..len]);
1146 // self.len <= other.len due to the truncate above, so the
1147 // slice here is always in-bounds.
1148 self.extend_from_slice(&other[len..]);
1152 #[stable(feature = "rust1", since = "1.0.0")]
1153 impl<T: Hash> Hash for Vec<T> {
1155 fn hash<H: hash::Hasher>(&self, state: &mut H) {
1156 Hash::hash(&**self, state)
1160 #[stable(feature = "rust1", since = "1.0.0")]
1161 impl<T> Index<usize> for Vec<T> {
1165 fn index(&self, index: usize) -> &T {
1166 // NB built-in indexing via `&[T]`
1171 #[stable(feature = "rust1", since = "1.0.0")]
1172 impl<T> IndexMut<usize> for Vec<T> {
1174 fn index_mut(&mut self, index: usize) -> &mut T {
1175 // NB built-in indexing via `&mut [T]`
1176 &mut (**self)[index]
1181 #[stable(feature = "rust1", since = "1.0.0")]
1182 impl<T> ops::Index<ops::Range<usize>> for Vec<T> {
1186 fn index(&self, index: ops::Range<usize>) -> &[T] {
1187 Index::index(&**self, index)
1190 #[stable(feature = "rust1", since = "1.0.0")]
1191 impl<T> ops::Index<ops::RangeTo<usize>> for Vec<T> {
1195 fn index(&self, index: ops::RangeTo<usize>) -> &[T] {
1196 Index::index(&**self, index)
1199 #[stable(feature = "rust1", since = "1.0.0")]
1200 impl<T> ops::Index<ops::RangeFrom<usize>> for Vec<T> {
1204 fn index(&self, index: ops::RangeFrom<usize>) -> &[T] {
1205 Index::index(&**self, index)
1208 #[stable(feature = "rust1", since = "1.0.0")]
1209 impl<T> ops::Index<ops::RangeFull> for Vec<T> {
1213 fn index(&self, _index: ops::RangeFull) -> &[T] {
1217 #[unstable(feature = "inclusive_range", reason = "recently added, follows RFC", issue = "28237")]
1218 impl<T> ops::Index<ops::RangeInclusive<usize>> for Vec<T> {
1222 fn index(&self, index: ops::RangeInclusive<usize>) -> &[T] {
1223 Index::index(&**self, index)
1226 #[unstable(feature = "inclusive_range", reason = "recently added, follows RFC", issue = "28237")]
1227 impl<T> ops::Index<ops::RangeToInclusive<usize>> for Vec<T> {
1231 fn index(&self, index: ops::RangeToInclusive<usize>) -> &[T] {
1232 Index::index(&**self, index)
1236 #[stable(feature = "rust1", since = "1.0.0")]
1237 impl<T> ops::IndexMut<ops::Range<usize>> for Vec<T> {
1239 fn index_mut(&mut self, index: ops::Range<usize>) -> &mut [T] {
1240 IndexMut::index_mut(&mut **self, index)
1243 #[stable(feature = "rust1", since = "1.0.0")]
1244 impl<T> ops::IndexMut<ops::RangeTo<usize>> for Vec<T> {
1246 fn index_mut(&mut self, index: ops::RangeTo<usize>) -> &mut [T] {
1247 IndexMut::index_mut(&mut **self, index)
1250 #[stable(feature = "rust1", since = "1.0.0")]
1251 impl<T> ops::IndexMut<ops::RangeFrom<usize>> for Vec<T> {
1253 fn index_mut(&mut self, index: ops::RangeFrom<usize>) -> &mut [T] {
1254 IndexMut::index_mut(&mut **self, index)
1257 #[stable(feature = "rust1", since = "1.0.0")]
1258 impl<T> ops::IndexMut<ops::RangeFull> for Vec<T> {
1260 fn index_mut(&mut self, _index: ops::RangeFull) -> &mut [T] {
1264 #[unstable(feature = "inclusive_range", reason = "recently added, follows RFC", issue = "28237")]
1265 impl<T> ops::IndexMut<ops::RangeInclusive<usize>> for Vec<T> {
1267 fn index_mut(&mut self, index: ops::RangeInclusive<usize>) -> &mut [T] {
1268 IndexMut::index_mut(&mut **self, index)
1271 #[unstable(feature = "inclusive_range", reason = "recently added, follows RFC", issue = "28237")]
1272 impl<T> ops::IndexMut<ops::RangeToInclusive<usize>> for Vec<T> {
1274 fn index_mut(&mut self, index: ops::RangeToInclusive<usize>) -> &mut [T] {
1275 IndexMut::index_mut(&mut **self, index)
1279 #[stable(feature = "rust1", since = "1.0.0")]
1280 impl<T> ops::Deref for Vec<T> {
1283 fn deref(&self) -> &[T] {
1285 let p = self.buf.ptr();
1286 assume(!p.is_null());
1287 slice::from_raw_parts(p, self.len)
1292 #[stable(feature = "rust1", since = "1.0.0")]
1293 impl<T> ops::DerefMut for Vec<T> {
1294 fn deref_mut(&mut self) -> &mut [T] {
1296 let ptr = self.buf.ptr();
1297 assume(!ptr.is_null());
1298 slice::from_raw_parts_mut(ptr, self.len)
1303 #[stable(feature = "rust1", since = "1.0.0")]
1304 impl<T> FromIterator<T> for Vec<T> {
1306 fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Vec<T> {
1307 // Unroll the first iteration, as the vector is going to be
1308 // expanded on this iteration in every case when the iterable is not
1309 // empty, but the loop in extend_desugared() is not going to see the
1310 // vector being full in the few subsequent loop iterations.
1311 // So we get better branch prediction.
1312 let mut iterator = iter.into_iter();
1313 let mut vector = match iterator.next() {
1314 None => return Vec::new(),
1316 let (lower, _) = iterator.size_hint();
1317 let mut vector = Vec::with_capacity(lower.saturating_add(1));
1319 ptr::write(vector.get_unchecked_mut(0), element);
1325 vector.extend_desugared(iterator);
1330 #[stable(feature = "rust1", since = "1.0.0")]
1331 impl<T> IntoIterator for Vec<T> {
1333 type IntoIter = IntoIter<T>;
1335 /// Creates a consuming iterator, that is, one that moves each value out of
1336 /// the vector (from start to end). The vector cannot be used after calling
1342 /// let v = vec!["a".to_string(), "b".to_string()];
1343 /// for s in v.into_iter() {
1344 /// // s has type String, not &String
1345 /// println!("{}", s);
1349 fn into_iter(mut self) -> IntoIter<T> {
1351 let ptr = self.as_mut_ptr();
1352 assume(!ptr.is_null());
1353 let begin = ptr as *const T;
1354 let end = if mem::size_of::<T>() == 0 {
1355 arith_offset(ptr as *const i8, self.len() as isize) as *const T
1357 ptr.offset(self.len() as isize) as *const T
1359 let buf = ptr::read(&self.buf);
1370 #[stable(feature = "rust1", since = "1.0.0")]
1371 impl<'a, T> IntoIterator for &'a Vec<T> {
1373 type IntoIter = slice::Iter<'a, T>;
1375 fn into_iter(self) -> slice::Iter<'a, T> {
1380 #[stable(feature = "rust1", since = "1.0.0")]
1381 impl<'a, T> IntoIterator for &'a mut Vec<T> {
1382 type Item = &'a mut T;
1383 type IntoIter = slice::IterMut<'a, T>;
1385 fn into_iter(mut self) -> slice::IterMut<'a, T> {
1390 #[stable(feature = "rust1", since = "1.0.0")]
1391 impl<T> Extend<T> for Vec<T> {
1393 fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
1394 <Self as SpecExtend<I>>::spec_extend(self, iter);
1398 impl<I: IntoIterator> SpecExtend<I> for Vec<I::Item> {
1399 default fn spec_extend(&mut self, iter: I) {
1400 self.extend_desugared(iter.into_iter())
1404 impl<T> SpecExtend<Vec<T>> for Vec<T> {
1405 fn spec_extend(&mut self, ref mut other: Vec<T>) {
1411 fn extend_desugared<I: Iterator<Item = T>>(&mut self, mut iterator: I) {
1412 // This function should be the moral equivalent of:
1414 // for item in iterator {
1417 while let Some(element) = iterator.next() {
1418 let len = self.len();
1419 if len == self.capacity() {
1420 let (lower, _) = iterator.size_hint();
1421 self.reserve(lower.saturating_add(1));
1424 ptr::write(self.get_unchecked_mut(len), element);
1425 // NB can't overflow since we would have had to alloc the address space
1426 self.set_len(len + 1);
1432 #[stable(feature = "extend_ref", since = "1.2.0")]
1433 impl<'a, T: 'a + Copy> Extend<&'a T> for Vec<T> {
1434 fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I) {
1435 self.extend(iter.into_iter().cloned());
1439 macro_rules! __impl_slice_eq1 {
1440 ($Lhs: ty, $Rhs: ty) => {
1441 __impl_slice_eq1! { $Lhs, $Rhs, Sized }
1443 ($Lhs: ty, $Rhs: ty, $Bound: ident) => {
1444 #[stable(feature = "rust1", since = "1.0.0")]
1445 impl<'a, 'b, A: $Bound, B> PartialEq<$Rhs> for $Lhs where A: PartialEq<B> {
1447 fn eq(&self, other: &$Rhs) -> bool { self[..] == other[..] }
1449 fn ne(&self, other: &$Rhs) -> bool { self[..] != other[..] }
1454 __impl_slice_eq1! { Vec<A>, Vec<B> }
1455 __impl_slice_eq1! { Vec<A>, &'b [B] }
1456 __impl_slice_eq1! { Vec<A>, &'b mut [B] }
1457 __impl_slice_eq1! { Cow<'a, [A]>, &'b [B], Clone }
1458 __impl_slice_eq1! { Cow<'a, [A]>, &'b mut [B], Clone }
1459 __impl_slice_eq1! { Cow<'a, [A]>, Vec<B>, Clone }
1461 macro_rules! array_impls {
1464 // NOTE: some less important impls are omitted to reduce code bloat
1465 __impl_slice_eq1! { Vec<A>, [B; $N] }
1466 __impl_slice_eq1! { Vec<A>, &'b [B; $N] }
1467 // __impl_slice_eq1! { Vec<A>, &'b mut [B; $N] }
1468 // __impl_slice_eq1! { Cow<'a, [A]>, [B; $N], Clone }
1469 // __impl_slice_eq1! { Cow<'a, [A]>, &'b [B; $N], Clone }
1470 // __impl_slice_eq1! { Cow<'a, [A]>, &'b mut [B; $N], Clone }
1477 10 11 12 13 14 15 16 17 18 19
1478 20 21 22 23 24 25 26 27 28 29
1482 #[stable(feature = "rust1", since = "1.0.0")]
1483 impl<T: PartialOrd> PartialOrd for Vec<T> {
1485 fn partial_cmp(&self, other: &Vec<T>) -> Option<Ordering> {
1486 PartialOrd::partial_cmp(&**self, &**other)
1490 #[stable(feature = "rust1", since = "1.0.0")]
1491 impl<T: Eq> Eq for Vec<T> {}
1493 #[stable(feature = "rust1", since = "1.0.0")]
1494 impl<T: Ord> Ord for Vec<T> {
1496 fn cmp(&self, other: &Vec<T>) -> Ordering {
1497 Ord::cmp(&**self, &**other)
1501 #[stable(feature = "rust1", since = "1.0.0")]
1502 impl<T> Drop for Vec<T> {
1503 #[unsafe_destructor_blind_to_params]
1504 fn drop(&mut self) {
1505 if self.buf.unsafe_no_drop_flag_needs_drop() {
1508 ptr::drop_in_place(&mut self[..]);
1511 // RawVec handles deallocation
1515 #[stable(feature = "rust1", since = "1.0.0")]
1516 impl<T> Default for Vec<T> {
1517 fn default() -> Vec<T> {
1522 #[stable(feature = "rust1", since = "1.0.0")]
1523 impl<T: fmt::Debug> fmt::Debug for Vec<T> {
1524 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1525 fmt::Debug::fmt(&**self, f)
1529 #[stable(feature = "rust1", since = "1.0.0")]
1530 impl<T> AsRef<Vec<T>> for Vec<T> {
1531 fn as_ref(&self) -> &Vec<T> {
1536 #[stable(feature = "vec_as_mut", since = "1.5.0")]
1537 impl<T> AsMut<Vec<T>> for Vec<T> {
1538 fn as_mut(&mut self) -> &mut Vec<T> {
1543 #[stable(feature = "rust1", since = "1.0.0")]
1544 impl<T> AsRef<[T]> for Vec<T> {
1545 fn as_ref(&self) -> &[T] {
1550 #[stable(feature = "vec_as_mut", since = "1.5.0")]
1551 impl<T> AsMut<[T]> for Vec<T> {
1552 fn as_mut(&mut self) -> &mut [T] {
1557 #[stable(feature = "rust1", since = "1.0.0")]
1558 impl<'a, T: Clone> From<&'a [T]> for Vec<T> {
1560 fn from(s: &'a [T]) -> Vec<T> {
1564 fn from(s: &'a [T]) -> Vec<T> {
1569 #[stable(feature = "rust1", since = "1.0.0")]
1570 impl<'a> From<&'a str> for Vec<u8> {
1571 fn from(s: &'a str) -> Vec<u8> {
1572 From::from(s.as_bytes())
1576 ////////////////////////////////////////////////////////////////////////////////
1578 ////////////////////////////////////////////////////////////////////////////////
1580 #[stable(feature = "cow_from_vec", since = "1.7.0")]
1581 impl<'a, T: Clone> From<&'a [T]> for Cow<'a, [T]> {
1582 fn from(s: &'a [T]) -> Cow<'a, [T]> {
1587 #[stable(feature = "cow_from_vec", since = "1.7.0")]
1588 impl<'a, T: Clone> From<Vec<T>> for Cow<'a, [T]> {
1589 fn from(v: Vec<T>) -> Cow<'a, [T]> {
1594 #[stable(feature = "rust1", since = "1.0.0")]
1595 impl<'a, T> FromIterator<T> for Cow<'a, [T]> where T: Clone {
1596 fn from_iter<I: IntoIterator<Item = T>>(it: I) -> Cow<'a, [T]> {
1597 Cow::Owned(FromIterator::from_iter(it))
1601 ////////////////////////////////////////////////////////////////////////////////
1603 ////////////////////////////////////////////////////////////////////////////////
1605 /// An iterator that moves out of a vector.
1606 #[stable(feature = "rust1", since = "1.0.0")]
1607 pub struct IntoIter<T> {
1613 #[stable(feature = "rust1", since = "1.0.0")]
1614 unsafe impl<T: Send> Send for IntoIter<T> {}
1615 #[stable(feature = "rust1", since = "1.0.0")]
1616 unsafe impl<T: Sync> Sync for IntoIter<T> {}
1618 #[stable(feature = "rust1", since = "1.0.0")]
1619 impl<T> Iterator for IntoIter<T> {
1623 fn next(&mut self) -> Option<T> {
1625 if self.ptr == self.end {
1628 if mem::size_of::<T>() == 0 {
1629 // purposefully don't use 'ptr.offset' because for
1630 // vectors with 0-size elements this would return the
1632 self.ptr = arith_offset(self.ptr as *const i8, 1) as *const T;
1634 // Use a non-null pointer value
1635 Some(ptr::read(EMPTY as *mut T))
1638 self.ptr = self.ptr.offset(1);
1640 Some(ptr::read(old))
1647 fn size_hint(&self) -> (usize, Option<usize>) {
1648 let diff = (self.end as usize) - (self.ptr as usize);
1649 let size = mem::size_of::<T>();
1656 (exact, Some(exact))
1660 fn count(self) -> usize {
1665 #[stable(feature = "rust1", since = "1.0.0")]
1666 impl<T> DoubleEndedIterator for IntoIter<T> {
1668 fn next_back(&mut self) -> Option<T> {
1670 if self.end == self.ptr {
1673 if mem::size_of::<T>() == 0 {
1674 // See above for why 'ptr.offset' isn't used
1675 self.end = arith_offset(self.end as *const i8, -1) as *const T;
1677 // Use a non-null pointer value
1678 Some(ptr::read(EMPTY as *mut T))
1680 self.end = self.end.offset(-1);
1682 Some(ptr::read(self.end))
1689 #[stable(feature = "rust1", since = "1.0.0")]
1690 impl<T> ExactSizeIterator for IntoIter<T> {}
1692 #[stable(feature = "vec_into_iter_clone", since = "1.8.0")]
1693 impl<T: Clone> Clone for IntoIter<T> {
1694 fn clone(&self) -> IntoIter<T> {
1696 slice::from_raw_parts(self.ptr, self.len()).to_owned().into_iter()
1701 #[stable(feature = "rust1", since = "1.0.0")]
1702 impl<T> Drop for IntoIter<T> {
1703 #[unsafe_destructor_blind_to_params]
1704 fn drop(&mut self) {
1705 // destroy the remaining elements
1708 // RawVec handles deallocation
1712 /// A draining iterator for `Vec<T>`.
1713 #[stable(feature = "drain", since = "1.6.0")]
1714 pub struct Drain<'a, T: 'a> {
1715 /// Index of tail to preserve
1719 /// Current remaining range to remove
1720 iter: slice::IterMut<'a, T>,
1724 #[stable(feature = "drain", since = "1.6.0")]
1725 unsafe impl<'a, T: Sync> Sync for Drain<'a, T> {}
1726 #[stable(feature = "drain", since = "1.6.0")]
1727 unsafe impl<'a, T: Send> Send for Drain<'a, T> {}
1729 #[stable(feature = "rust1", since = "1.0.0")]
1730 impl<'a, T> Iterator for Drain<'a, T> {
1734 fn next(&mut self) -> Option<T> {
1735 self.iter.next().map(|elt| unsafe { ptr::read(elt as *const _) })
1738 fn size_hint(&self) -> (usize, Option<usize>) {
1739 self.iter.size_hint()
1743 #[stable(feature = "rust1", since = "1.0.0")]
1744 impl<'a, T> DoubleEndedIterator for Drain<'a, T> {
1746 fn next_back(&mut self) -> Option<T> {
1747 self.iter.next_back().map(|elt| unsafe { ptr::read(elt as *const _) })
1751 #[stable(feature = "rust1", since = "1.0.0")]
1752 impl<'a, T> Drop for Drain<'a, T> {
1753 fn drop(&mut self) {
1754 // exhaust self first
1755 while let Some(_) = self.next() {}
1757 if self.tail_len > 0 {
1759 let source_vec = &mut *self.vec;
1760 // memmove back untouched tail, update to new length
1761 let start = source_vec.len();
1762 let tail = self.tail_start;
1763 let src = source_vec.as_ptr().offset(tail as isize);
1764 let dst = source_vec.as_mut_ptr().offset(start as isize);
1765 ptr::copy(src, dst, self.tail_len);
1766 source_vec.set_len(start + self.tail_len);
1773 #[stable(feature = "rust1", since = "1.0.0")]
1774 impl<'a, T> ExactSizeIterator for Drain<'a, T> {}