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;
66 use core::cmp::Ordering;
68 use core::hash::{self, Hash};
69 use core::intrinsics::{arith_offset, assume};
70 use core::iter::FromIterator;
72 use core::ops::{Index, IndexMut};
78 use borrow::{Cow, IntoCow};
80 use super::range::RangeArgument;
82 /// A contiguous growable array type, written `Vec<T>` but pronounced 'vector.'
87 /// let mut vec = Vec::new();
91 /// assert_eq!(vec.len(), 2);
92 /// assert_eq!(vec[0], 1);
94 /// assert_eq!(vec.pop(), Some(2));
95 /// assert_eq!(vec.len(), 1);
98 /// assert_eq!(vec[0], 7);
100 /// vec.extend([1, 2, 3].iter().cloned());
103 /// println!("{}", x);
105 /// assert_eq!(vec, [7, 1, 2, 3]);
108 /// The `vec!` macro is provided to make initialization more convenient:
111 /// let mut vec = vec![1, 2, 3];
113 /// assert_eq!(vec, [1, 2, 3, 4]);
116 /// It can also initialize each element of a `Vec<T>` with a given value:
119 /// let vec = vec![0; 5];
120 /// assert_eq!(vec, [0, 0, 0, 0, 0]);
123 /// Use a `Vec<T>` as an efficient stack:
126 /// let mut stack = Vec::new();
132 /// while let Some(top) = stack.pop() {
133 /// // Prints 3, 2, 1
134 /// println!("{}", top);
140 /// The Vec type allows to access values by index, because it implements the
141 /// `Index` trait. An example will be more explicit:
144 /// let v = vec!(0, 2, 4, 6);
145 /// println!("{}", v[1]); // it will display '2'
148 /// However be careful: if you try to access an index which isn't in the Vec,
149 /// your software will panic! You cannot do this:
152 /// let v = vec!(0, 2, 4, 6);
153 /// println!("{}", v[6]); // it will panic!
156 /// In conclusion: always check if the index you want to get really exists
161 /// A Vec can be mutable. Slices, on the other hand, are read-only objects.
162 /// To get a slice, use "&". Example:
165 /// fn read_slice(slice: &[usize]) {
169 /// let v = vec!(0, 1);
172 /// // ... and that's all!
173 /// // you can also do it like this:
174 /// let x : &[usize] = &v;
177 /// In Rust, it's more common to pass slices as arguments rather than vectors
178 /// when you just want to provide a read access. The same goes for String and
181 /// # Capacity and reallocation
183 /// The capacity of a vector is the amount of space allocated for any future
184 /// elements that will be added onto the vector. This is not to be confused with
185 /// the *length* of a vector, which specifies the number of actual elements
186 /// within the vector. If a vector's length exceeds its capacity, its capacity
187 /// will automatically be increased, but its elements will have to be
190 /// For example, a vector with capacity 10 and length 0 would be an empty vector
191 /// with space for 10 more elements. Pushing 10 or fewer elements onto the
192 /// vector will not change its capacity or cause reallocation to occur. However,
193 /// if the vector's length is increased to 11, it will have to reallocate, which
194 /// can be slow. For this reason, it is recommended to use `Vec::with_capacity`
195 /// whenever possible to specify how big the vector is expected to get.
199 /// Due to its incredibly fundamental nature, Vec makes a lot of guarantees
200 /// about its design. This ensures that it's as low-overhead as possible in
201 /// the general case, and can be correctly manipulated in primitive ways
202 /// by unsafe code. Note that these guarantees refer to an unqualified `Vec<T>`.
203 /// If additional type parameters are added (e.g. to support custom allocators),
204 /// overriding their defaults may change the behavior.
206 /// Most fundamentally, Vec is and always will be a (pointer, capacity, length)
207 /// triplet. No more, no less. The order of these fields is completely
208 /// unspecified, and you should use the appropriate methods to modify these.
209 /// The pointer will never be null, so this type is null-pointer-optimized.
211 /// However, the pointer may not actually point to allocated memory. In particular,
212 /// if you construct a Vec with capacity 0 via `Vec::new()`, `vec![]`,
213 /// `Vec::with_capacity(0)`, or by calling `shrink_to_fit()` on an empty Vec, it
214 /// will not allocate memory. Similarly, if you store zero-sized types inside
215 /// a Vec, it will not allocate space for them. *Note that in this case the
216 /// Vec may not report a `capacity()` of 0*. Vec will allocate if and only
217 /// if `mem::size_of::<T>() * capacity() > 0`. In general, Vec's allocation
218 /// details are subtle enough that it is strongly recommended that you only
219 /// free memory allocated by a Vec by creating a new Vec and dropping it.
221 /// If a Vec *has* allocated memory, then the memory it points to is on the heap
222 /// (as defined by the allocator Rust is configured to use by default), and its
223 /// pointer points to `len()` initialized elements in order (what you would see
224 /// if you coerced it to a slice), followed by `capacity() - len()` logically
225 /// uninitialized elements.
227 /// Vec will never perform a "small optimization" where elements are actually
228 /// stored on the stack for two reasons:
230 /// * It would make it more difficult for unsafe code to correctly manipulate
231 /// a Vec. The contents of a Vec wouldn't have a stable address if it were
232 /// only moved, and it would be more difficult to determine if a Vec had
233 /// actually allocated memory.
235 /// * It would penalize the general case, incurring an additional branch
238 /// Vec will never automatically shrink itself, even if completely empty. This
239 /// ensures no unnecessary allocations or deallocations occur. Emptying a Vec
240 /// and then filling it back up to the same `len()` should incur no calls to
241 /// the allocator. If you wish to free up unused memory, use `shrink_to_fit`.
243 /// `push` and `insert` will never (re)allocate if the reported capacity is
244 /// sufficient. `push` and `insert` *will* (re)allocate if `len() == capacity()`.
245 /// That is, the reported capacity is completely accurate, and can be relied on.
246 /// It can even be used to manually free the memory allocated by a Vec if
247 /// desired. Bulk insertion methods *may* reallocate, even when not necessary.
249 /// Vec does not guarantee any particular growth strategy when reallocating
250 /// when full, nor when `reserve` is called. The current strategy is basic
251 /// and it may prove desirable to use a non-constant growth factor. Whatever
252 /// strategy is used will of course guarantee `O(1)` amortized `push`.
254 /// `vec![x; n]`, `vec![a, b, c, d]`, and `Vec::with_capacity(n)`, will all
255 /// produce a Vec with exactly the requested capacity. If `len() == capacity()`,
256 /// (as is the case for the `vec!` macro), then a `Vec<T>` can be converted
257 /// to and from a `Box<[T]>` without reallocating or moving the elements.
259 /// Vec will not specifically overwrite any data that is removed from it,
260 /// but also won't specifically preserve it. Its uninitialized memory is
261 /// scratch space that it may use however it wants. It will generally just do
262 /// whatever is most efficient or otherwise easy to implement. Do not rely on
263 /// removed data to be erased for security purposes. Even if you drop a Vec, its
264 /// buffer may simply be reused by another Vec. Even if you zero a Vec's memory
265 /// first, that may not actually happen because the optimizer does not consider
266 /// this a side-effect that must be preserved.
268 /// Vec does not currently guarantee the order in which elements are dropped
269 /// (the order has changed in the past, and may change again).
271 #[unsafe_no_drop_flag]
272 #[stable(feature = "rust1", since = "1.0.0")]
278 ////////////////////////////////////////////////////////////////////////////////
280 ////////////////////////////////////////////////////////////////////////////////
283 /// Constructs a new, empty `Vec<T>`.
285 /// The vector will not allocate until elements are pushed onto it.
290 /// # #![allow(unused_mut)]
291 /// let mut vec: Vec<i32> = Vec::new();
294 #[stable(feature = "rust1", since = "1.0.0")]
295 pub fn new() -> Vec<T> {
302 /// Constructs a new, empty `Vec<T>` with the specified capacity.
304 /// The vector will be able to hold exactly `capacity` elements without
305 /// reallocating. If `capacity` is 0, the vector will not allocate.
307 /// It is important to note that this function does not specify the *length*
308 /// of the returned vector, but only the *capacity*. (For an explanation of
309 /// the difference between length and capacity, see the main `Vec<T>` docs
310 /// above, 'Capacity and reallocation'.)
315 /// let mut vec = Vec::with_capacity(10);
317 /// // The vector contains no items, even though it has capacity for more
318 /// assert_eq!(vec.len(), 0);
320 /// // These are all done without reallocating...
325 /// // ...but this may make the vector reallocate
329 #[stable(feature = "rust1", since = "1.0.0")]
330 pub fn with_capacity(capacity: usize) -> Vec<T> {
332 buf: RawVec::with_capacity(capacity),
337 /// Creates a `Vec<T>` directly from the raw components of another vector.
341 /// This is highly unsafe, due to the number of invariants that aren't
344 /// * `ptr` needs to have been previously allocated via `String`/`Vec<T>`
345 /// (at least, it's highly likely to be incorrect if it wasn't).
346 /// * `length` needs to be the length that less than or equal to `capacity`.
347 /// * `capacity` needs to be the capacity that the pointer was allocated with.
349 /// Violating these may cause problems like corrupting the allocator's
350 /// internal datastructures.
359 /// let mut v = vec![1, 2, 3];
361 /// // Pull out the various important pieces of information about `v`
362 /// let p = v.as_mut_ptr();
363 /// let len = v.len();
364 /// let cap = v.capacity();
367 /// // Cast `v` into the void: no destructor run, so we are in
368 /// // complete control of the allocation to which `p` points.
371 /// // Overwrite memory with 4, 5, 6
372 /// for i in 0..len as isize {
373 /// ptr::write(p.offset(i), 4 + i);
376 /// // Put everything back together into a Vec
377 /// let rebuilt = Vec::from_raw_parts(p, len, cap);
378 /// assert_eq!(rebuilt, [4, 5, 6]);
382 #[stable(feature = "rust1", since = "1.0.0")]
383 pub unsafe fn from_raw_parts(ptr: *mut T, length: usize, capacity: usize) -> Vec<T> {
385 buf: RawVec::from_raw_parts(ptr, capacity),
390 /// Returns the number of elements the vector can hold without
396 /// let vec: Vec<i32> = Vec::with_capacity(10);
397 /// assert_eq!(vec.capacity(), 10);
400 #[stable(feature = "rust1", since = "1.0.0")]
401 pub fn capacity(&self) -> usize {
405 /// Reserves capacity for at least `additional` more elements to be inserted
406 /// in the given `Vec<T>`. The collection may reserve more space to avoid
407 /// frequent reallocations.
411 /// Panics if the new capacity overflows `usize`.
416 /// let mut vec = vec![1];
418 /// assert!(vec.capacity() >= 11);
420 #[stable(feature = "rust1", since = "1.0.0")]
421 pub fn reserve(&mut self, additional: usize) {
422 self.buf.reserve(self.len, additional);
425 /// Reserves the minimum capacity for exactly `additional` more elements to
426 /// be inserted in the given `Vec<T>`. Does nothing if the capacity is already
429 /// Note that the allocator may give the collection more space than it
430 /// requests. Therefore capacity can not be relied upon to be precisely
431 /// minimal. Prefer `reserve` if future insertions are expected.
435 /// Panics if the new capacity overflows `usize`.
440 /// let mut vec = vec![1];
441 /// vec.reserve_exact(10);
442 /// assert!(vec.capacity() >= 11);
444 #[stable(feature = "rust1", since = "1.0.0")]
445 pub fn reserve_exact(&mut self, additional: usize) {
446 self.buf.reserve_exact(self.len, additional);
449 /// Shrinks the capacity of the vector as much as possible.
451 /// It will drop down as close as possible to the length but the allocator
452 /// may still inform the vector that there is space for a few more elements.
457 /// let mut vec = Vec::with_capacity(10);
458 /// vec.extend([1, 2, 3].iter().cloned());
459 /// assert_eq!(vec.capacity(), 10);
460 /// vec.shrink_to_fit();
461 /// assert!(vec.capacity() >= 3);
463 #[stable(feature = "rust1", since = "1.0.0")]
464 pub fn shrink_to_fit(&mut self) {
465 self.buf.shrink_to_fit(self.len);
468 /// Converts the vector into Box<[T]>.
470 /// Note that this will drop any excess capacity. Calling this and
471 /// converting back to a vector with `into_vec()` is equivalent to calling
472 /// `shrink_to_fit()`.
473 #[stable(feature = "rust1", since = "1.0.0")]
474 pub fn into_boxed_slice(mut self) -> Box<[T]> {
476 self.shrink_to_fit();
477 let buf = ptr::read(&self.buf);
483 /// Shorten a vector to be `len` elements long, dropping excess elements.
485 /// If `len` is greater than the vector's current length, this has no
491 /// let mut vec = vec![1, 2, 3, 4, 5];
493 /// assert_eq!(vec, [1, 2]);
495 #[stable(feature = "rust1", since = "1.0.0")]
496 pub fn truncate(&mut self, len: usize) {
498 // drop any extra elements
499 while len < self.len {
500 // decrement len before the drop_in_place(), so a panic on Drop
501 // doesn't re-drop the just-failed value.
504 ptr::drop_in_place(self.get_unchecked_mut(len));
509 /// Extracts a slice containing the entire vector.
511 /// Equivalent to `&s[..]`.
513 #[stable(feature = "vec_as_slice", since = "1.7.0")]
514 pub fn as_slice(&self) -> &[T] {
518 /// Extracts a mutable slice of the entire vector.
520 /// Equivalent to `&mut s[..]`.
522 #[stable(feature = "vec_as_slice", since = "1.7.0")]
523 pub fn as_mut_slice(&mut self) -> &mut [T] {
527 /// Sets the length of a vector.
529 /// This will explicitly set the size of the vector, without actually
530 /// modifying its buffers, so it is up to the caller to ensure that the
531 /// vector is actually the specified size.
536 /// let mut v = vec![1, 2, 3, 4];
542 #[stable(feature = "rust1", since = "1.0.0")]
543 pub unsafe fn set_len(&mut self, len: usize) {
547 /// Removes an element from anywhere in the vector and return it, replacing
548 /// it with the last element.
550 /// This does not preserve ordering, but is O(1).
554 /// Panics if `index` is out of bounds.
559 /// let mut v = vec!["foo", "bar", "baz", "qux"];
561 /// assert_eq!(v.swap_remove(1), "bar");
562 /// assert_eq!(v, ["foo", "qux", "baz"]);
564 /// assert_eq!(v.swap_remove(0), "foo");
565 /// assert_eq!(v, ["baz", "qux"]);
568 #[stable(feature = "rust1", since = "1.0.0")]
569 pub fn swap_remove(&mut self, index: usize) -> T {
570 let length = self.len();
571 self.swap(index, length - 1);
575 /// Inserts an element at position `index` within the vector, shifting all
576 /// elements after it to the right.
580 /// Panics if `index` is greater than the vector's length.
585 /// let mut vec = vec![1, 2, 3];
586 /// vec.insert(1, 4);
587 /// assert_eq!(vec, [1, 4, 2, 3]);
588 /// vec.insert(4, 5);
589 /// assert_eq!(vec, [1, 4, 2, 3, 5]);
591 #[stable(feature = "rust1", since = "1.0.0")]
592 pub fn insert(&mut self, index: usize, element: T) {
593 let len = self.len();
594 assert!(index <= len);
596 // space for the new element
597 if len == self.buf.cap() {
603 // The spot to put the new value
605 let p = self.as_mut_ptr().offset(index as isize);
606 // Shift everything over to make space. (Duplicating the
607 // `index`th element into two consecutive places.)
608 ptr::copy(p, p.offset(1), len - index);
609 // Write it in, overwriting the first copy of the `index`th
611 ptr::write(p, element);
613 self.set_len(len + 1);
617 /// Removes and returns the element at position `index` within the vector,
618 /// shifting all elements after it to the left.
622 /// Panics if `index` is out of bounds.
627 /// let mut v = vec![1, 2, 3];
628 /// assert_eq!(v.remove(1), 2);
629 /// assert_eq!(v, [1, 3]);
631 #[stable(feature = "rust1", since = "1.0.0")]
632 pub fn remove(&mut self, index: usize) -> T {
633 let len = self.len();
634 assert!(index < len);
639 // the place we are taking from.
640 let ptr = self.as_mut_ptr().offset(index as isize);
641 // copy it out, unsafely having a copy of the value on
642 // the stack and in the vector at the same time.
643 ret = ptr::read(ptr);
645 // Shift everything down to fill in that spot.
646 ptr::copy(ptr.offset(1), ptr, len - index - 1);
648 self.set_len(len - 1);
653 /// Retains only the elements specified by the predicate.
655 /// In other words, remove all elements `e` such that `f(&e)` returns false.
656 /// This method operates in place and preserves the order of the retained
662 /// let mut vec = vec![1, 2, 3, 4];
663 /// vec.retain(|&x| x%2 == 0);
664 /// assert_eq!(vec, [2, 4]);
666 #[stable(feature = "rust1", since = "1.0.0")]
667 pub fn retain<F>(&mut self, mut f: F)
668 where F: FnMut(&T) -> bool
670 let len = self.len();
684 self.truncate(len - del);
688 /// Appends an element to the back of a collection.
692 /// Panics if the number of elements in the vector overflows a `usize`.
697 /// let mut vec = vec![1, 2];
699 /// assert_eq!(vec, [1, 2, 3]);
702 #[stable(feature = "rust1", since = "1.0.0")]
703 pub fn push(&mut self, value: T) {
704 // This will panic or abort if we would allocate > isize::MAX bytes
705 // or if the length increment would overflow for zero-sized types.
706 if self.len == self.buf.cap() {
710 let end = self.as_mut_ptr().offset(self.len as isize);
711 ptr::write(end, value);
716 /// Removes the last element from a vector and returns it, or `None` if it
722 /// let mut vec = vec![1, 2, 3];
723 /// assert_eq!(vec.pop(), Some(3));
724 /// assert_eq!(vec, [1, 2]);
727 #[stable(feature = "rust1", since = "1.0.0")]
728 pub fn pop(&mut self) -> Option<T> {
734 Some(ptr::read(self.get_unchecked(self.len())))
739 /// Moves all the elements of `other` into `Self`, leaving `other` empty.
743 /// Panics if the number of elements in the vector overflows a `usize`.
748 /// let mut vec = vec![1, 2, 3];
749 /// let mut vec2 = vec![4, 5, 6];
750 /// vec.append(&mut vec2);
751 /// assert_eq!(vec, [1, 2, 3, 4, 5, 6]);
752 /// assert_eq!(vec2, []);
755 #[stable(feature = "append", since = "1.4.0")]
756 pub fn append(&mut self, other: &mut Self) {
757 self.reserve(other.len());
758 let len = self.len();
760 ptr::copy_nonoverlapping(other.as_ptr(), self.get_unchecked_mut(len), other.len());
763 self.len += other.len();
769 /// Create a draining iterator that removes the specified range in the vector
770 /// and yields the removed items.
772 /// Note 1: The element range is removed even if the iterator is not
773 /// consumed until the end.
775 /// Note 2: It is unspecified how many elements are removed from the vector,
776 /// if the `Drain` value is leaked.
780 /// Panics if the starting point is greater than the end point or if
781 /// the end point is greater than the length of the vector.
786 /// let mut v = vec![1, 2, 3];
787 /// let u: Vec<_> = v.drain(1..).collect();
788 /// assert_eq!(v, &[1]);
789 /// assert_eq!(u, &[2, 3]);
791 /// // A full range clears the vector
793 /// assert_eq!(v, &[]);
795 #[stable(feature = "drain", since = "1.6.0")]
796 pub fn drain<R>(&mut self, range: R) -> Drain<T>
797 where R: RangeArgument<usize>
801 // When the Drain is first created, it shortens the length of
802 // the source vector to make sure no uninitalized or moved-from elements
803 // are accessible at all if the Drain's destructor never gets to run.
805 // Drain will ptr::read out the values to remove.
806 // When finished, remaining tail of the vec is copied back to cover
807 // the hole, and the vector length is restored to the new length.
809 let len = self.len();
810 let start = *range.start().unwrap_or(&0);
811 let end = *range.end().unwrap_or(&len);
812 assert!(start <= end);
816 // set self.vec length's to start, to be safe in case Drain is leaked
818 // Use the borrow in the IterMut to indicate borrowing behavior of the
819 // whole Drain iterator (like &mut T).
820 let range_slice = slice::from_raw_parts_mut(self.as_mut_ptr().offset(start as isize),
825 iter: range_slice.iter_mut(),
831 /// Clears the vector, removing all values.
836 /// let mut v = vec![1, 2, 3];
840 /// assert!(v.is_empty());
843 #[stable(feature = "rust1", since = "1.0.0")]
844 pub fn clear(&mut self) {
848 /// Returns the number of elements in the vector.
853 /// let a = vec![1, 2, 3];
854 /// assert_eq!(a.len(), 3);
857 #[stable(feature = "rust1", since = "1.0.0")]
858 pub fn len(&self) -> usize {
862 /// Returns `true` if the vector contains no elements.
867 /// let mut v = Vec::new();
868 /// assert!(v.is_empty());
871 /// assert!(!v.is_empty());
873 #[stable(feature = "rust1", since = "1.0.0")]
874 pub fn is_empty(&self) -> bool {
878 /// Splits the collection into two at the given index.
880 /// Returns a newly allocated `Self`. `self` contains elements `[0, at)`,
881 /// and the returned `Self` contains elements `[at, len)`.
883 /// Note that the capacity of `self` does not change.
887 /// Panics if `at > len`.
892 /// let mut vec = vec![1,2,3];
893 /// let vec2 = vec.split_off(1);
894 /// assert_eq!(vec, [1]);
895 /// assert_eq!(vec2, [2, 3]);
898 #[stable(feature = "split_off", since = "1.4.0")]
899 pub fn split_off(&mut self, at: usize) -> Self {
900 assert!(at <= self.len(), "`at` out of bounds");
902 let other_len = self.len - at;
903 let mut other = Vec::with_capacity(other_len);
905 // Unsafely `set_len` and copy items to `other`.
908 other.set_len(other_len);
910 ptr::copy_nonoverlapping(self.as_ptr().offset(at as isize),
918 impl<T: Clone> Vec<T> {
919 /// Resizes the `Vec` in-place so that `len()` is equal to `new_len`.
921 /// If `new_len` is greater than `len()`, the `Vec` is extended by the
922 /// difference, with each additional slot filled with `value`.
923 /// If `new_len` is less than `len()`, the `Vec` is simply truncated.
928 /// let mut vec = vec!["hello"];
929 /// vec.resize(3, "world");
930 /// assert_eq!(vec, ["hello", "world", "world"]);
932 /// let mut vec = vec![1, 2, 3, 4];
933 /// vec.resize(2, 0);
934 /// assert_eq!(vec, [1, 2]);
936 #[stable(feature = "vec_resize", since = "1.5.0")]
937 pub fn resize(&mut self, new_len: usize, value: T) {
938 let len = self.len();
941 self.extend_with_element(new_len - len, value);
943 self.truncate(new_len);
947 /// Extend the vector by `n` additional clones of `value`.
948 fn extend_with_element(&mut self, n: usize, value: T) {
952 let len = self.len();
953 let mut ptr = self.as_mut_ptr().offset(len as isize);
954 // Write all elements except the last one
956 ptr::write(ptr, value.clone());
958 // Increment the length in every step in case clone() panics
959 self.set_len(len + i);
963 // We can write the last element directly without cloning needlessly
964 ptr::write(ptr, value);
965 self.set_len(len + n);
970 #[allow(missing_docs)]
972 #[unstable(feature = "vec_push_all",
973 reason = "likely to be replaced by a more optimized extend",
975 #[rustc_deprecated(reason = "renamed to extend_from_slice",
977 pub fn push_all(&mut self, other: &[T]) {
978 self.extend_from_slice(other)
981 /// Appends all elements in a slice to the `Vec`.
983 /// Iterates over the slice `other`, clones each element, and then appends
984 /// it to this `Vec`. The `other` vector is traversed in-order.
986 /// Note that this function is same as `extend` except that it is
987 /// specialized to work with slices instead. If and when Rust gets
988 /// specialization this function will likely be deprecated (but still
994 /// let mut vec = vec![1];
995 /// vec.extend_from_slice(&[2, 3, 4]);
996 /// assert_eq!(vec, [1, 2, 3, 4]);
998 #[stable(feature = "vec_extend_from_slice", since = "1.6.0")]
999 pub fn extend_from_slice(&mut self, other: &[T]) {
1000 self.reserve(other.len());
1002 for i in 0..other.len() {
1003 let len = self.len();
1005 // Unsafe code so this can be optimised to a memcpy (or something
1006 // similarly fast) when T is Copy. LLVM is easily confused, so any
1007 // extra operations during the loop can prevent this optimisation.
1009 ptr::write(self.get_unchecked_mut(len), other.get_unchecked(i).clone());
1010 self.set_len(len + 1);
1016 impl<T: PartialEq> Vec<T> {
1017 /// Removes consecutive repeated elements in the vector.
1019 /// If the vector is sorted, this removes all duplicates.
1024 /// let mut vec = vec![1, 2, 2, 3, 2];
1028 /// assert_eq!(vec, [1, 2, 3, 2]);
1030 #[stable(feature = "rust1", since = "1.0.0")]
1031 pub fn dedup(&mut self) {
1033 // Although we have a mutable reference to `self`, we cannot make
1034 // *arbitrary* changes. The `PartialEq` comparisons could panic, so we
1035 // must ensure that the vector is in a valid state at all time.
1037 // The way that we handle this is by using swaps; we iterate
1038 // over all the elements, swapping as we go so that at the end
1039 // the elements we wish to keep are in the front, and those we
1040 // wish to reject are at the back. We can then truncate the
1041 // vector. This operation is still O(n).
1043 // Example: We start in this state, where `r` represents "next
1044 // read" and `w` represents "next_write`.
1047 // +---+---+---+---+---+---+
1048 // | 0 | 1 | 1 | 2 | 3 | 3 |
1049 // +---+---+---+---+---+---+
1052 // Comparing self[r] against self[w-1], this is not a duplicate, so
1053 // we swap self[r] and self[w] (no effect as r==w) and then increment both
1054 // r and w, leaving us with:
1057 // +---+---+---+---+---+---+
1058 // | 0 | 1 | 1 | 2 | 3 | 3 |
1059 // +---+---+---+---+---+---+
1062 // Comparing self[r] against self[w-1], this value is a duplicate,
1063 // so we increment `r` but leave everything else unchanged:
1066 // +---+---+---+---+---+---+
1067 // | 0 | 1 | 1 | 2 | 3 | 3 |
1068 // +---+---+---+---+---+---+
1071 // Comparing self[r] against self[w-1], this is not a duplicate,
1072 // so swap self[r] and self[w] and advance r and w:
1075 // +---+---+---+---+---+---+
1076 // | 0 | 1 | 2 | 1 | 3 | 3 |
1077 // +---+---+---+---+---+---+
1080 // Not a duplicate, repeat:
1083 // +---+---+---+---+---+---+
1084 // | 0 | 1 | 2 | 3 | 1 | 3 |
1085 // +---+---+---+---+---+---+
1088 // Duplicate, advance r. End of vec. Truncate to w.
1090 let ln = self.len();
1095 // Avoid bounds checks by using raw pointers.
1096 let p = self.as_mut_ptr();
1097 let mut r: usize = 1;
1098 let mut w: usize = 1;
1101 let p_r = p.offset(r as isize);
1102 let p_wm1 = p.offset((w - 1) as isize);
1105 let p_w = p_wm1.offset(1);
1106 mem::swap(&mut *p_r, &mut *p_w);
1118 ////////////////////////////////////////////////////////////////////////////////
1119 // Internal methods and functions
1120 ////////////////////////////////////////////////////////////////////////////////
1123 #[stable(feature = "rust1", since = "1.0.0")]
1124 pub fn from_elem<T: Clone>(elem: T, n: usize) -> Vec<T> {
1125 let mut v = Vec::with_capacity(n);
1126 v.extend_with_element(n, elem);
1130 ////////////////////////////////////////////////////////////////////////////////
1131 // Common trait implementations for Vec
1132 ////////////////////////////////////////////////////////////////////////////////
1134 #[stable(feature = "rust1", since = "1.0.0")]
1135 impl<T: Clone> Clone for Vec<T> {
1137 fn clone(&self) -> Vec<T> {
1138 <[T]>::to_vec(&**self)
1141 // HACK(japaric): with cfg(test) the inherent `[T]::to_vec` method, which is
1142 // required for this method definition, is not available. Instead use the
1143 // `slice::to_vec` function which is only available with cfg(test)
1144 // NB see the slice::hack module in slice.rs for more information
1146 fn clone(&self) -> Vec<T> {
1147 ::slice::to_vec(&**self)
1150 fn clone_from(&mut self, other: &Vec<T>) {
1151 // drop anything in self that will not be overwritten
1152 self.truncate(other.len());
1153 let len = self.len();
1155 // reuse the contained values' allocations/resources.
1156 self.clone_from_slice(&other[..len]);
1158 // self.len <= other.len due to the truncate above, so the
1159 // slice here is always in-bounds.
1160 self.extend_from_slice(&other[len..]);
1164 #[stable(feature = "rust1", since = "1.0.0")]
1165 impl<T: Hash> Hash for Vec<T> {
1167 fn hash<H: hash::Hasher>(&self, state: &mut H) {
1168 Hash::hash(&**self, state)
1172 #[stable(feature = "rust1", since = "1.0.0")]
1173 impl<T> Index<usize> for Vec<T> {
1177 fn index(&self, index: usize) -> &T {
1178 // NB built-in indexing via `&[T]`
1183 #[stable(feature = "rust1", since = "1.0.0")]
1184 impl<T> IndexMut<usize> for Vec<T> {
1186 fn index_mut(&mut self, index: usize) -> &mut T {
1187 // NB built-in indexing via `&mut [T]`
1188 &mut (**self)[index]
1193 #[stable(feature = "rust1", since = "1.0.0")]
1194 impl<T> ops::Index<ops::Range<usize>> for Vec<T> {
1198 fn index(&self, index: ops::Range<usize>) -> &[T] {
1199 Index::index(&**self, index)
1202 #[stable(feature = "rust1", since = "1.0.0")]
1203 impl<T> ops::Index<ops::RangeTo<usize>> for Vec<T> {
1207 fn index(&self, index: ops::RangeTo<usize>) -> &[T] {
1208 Index::index(&**self, index)
1211 #[stable(feature = "rust1", since = "1.0.0")]
1212 impl<T> ops::Index<ops::RangeFrom<usize>> for Vec<T> {
1216 fn index(&self, index: ops::RangeFrom<usize>) -> &[T] {
1217 Index::index(&**self, index)
1220 #[stable(feature = "rust1", since = "1.0.0")]
1221 impl<T> ops::Index<ops::RangeFull> for Vec<T> {
1225 fn index(&self, _index: ops::RangeFull) -> &[T] {
1230 #[stable(feature = "rust1", since = "1.0.0")]
1231 impl<T> ops::IndexMut<ops::Range<usize>> for Vec<T> {
1233 fn index_mut(&mut self, index: ops::Range<usize>) -> &mut [T] {
1234 IndexMut::index_mut(&mut **self, index)
1237 #[stable(feature = "rust1", since = "1.0.0")]
1238 impl<T> ops::IndexMut<ops::RangeTo<usize>> for Vec<T> {
1240 fn index_mut(&mut self, index: ops::RangeTo<usize>) -> &mut [T] {
1241 IndexMut::index_mut(&mut **self, index)
1244 #[stable(feature = "rust1", since = "1.0.0")]
1245 impl<T> ops::IndexMut<ops::RangeFrom<usize>> for Vec<T> {
1247 fn index_mut(&mut self, index: ops::RangeFrom<usize>) -> &mut [T] {
1248 IndexMut::index_mut(&mut **self, index)
1251 #[stable(feature = "rust1", since = "1.0.0")]
1252 impl<T> ops::IndexMut<ops::RangeFull> for Vec<T> {
1254 fn index_mut(&mut self, _index: ops::RangeFull) -> &mut [T] {
1259 #[stable(feature = "rust1", since = "1.0.0")]
1260 impl<T> ops::Deref for Vec<T> {
1263 fn deref(&self) -> &[T] {
1265 let p = self.buf.ptr();
1266 assume(!p.is_null());
1267 slice::from_raw_parts(p, self.len)
1272 #[stable(feature = "rust1", since = "1.0.0")]
1273 impl<T> ops::DerefMut for Vec<T> {
1274 fn deref_mut(&mut self) -> &mut [T] {
1276 let ptr = self.buf.ptr();
1277 assume(!ptr.is_null());
1278 slice::from_raw_parts_mut(ptr, self.len)
1283 #[stable(feature = "rust1", since = "1.0.0")]
1284 impl<T> FromIterator<T> for Vec<T> {
1286 fn from_iter<I: IntoIterator<Item = T>>(iterable: I) -> Vec<T> {
1287 // Unroll the first iteration, as the vector is going to be
1288 // expanded on this iteration in every case when the iterable is not
1289 // empty, but the loop in extend_desugared() is not going to see the
1290 // vector being full in the few subsequent loop iterations.
1291 // So we get better branch prediction.
1292 let mut iterator = iterable.into_iter();
1293 let mut vector = match iterator.next() {
1294 None => return Vec::new(),
1296 let (lower, _) = iterator.size_hint();
1297 let mut vector = Vec::with_capacity(lower.saturating_add(1));
1299 ptr::write(vector.get_unchecked_mut(0), element);
1305 vector.extend_desugared(iterator);
1310 #[stable(feature = "rust1", since = "1.0.0")]
1311 impl<T> IntoIterator for Vec<T> {
1313 type IntoIter = IntoIter<T>;
1315 /// Creates a consuming iterator, that is, one that moves each value out of
1316 /// the vector (from start to end). The vector cannot be used after calling
1322 /// let v = vec!["a".to_string(), "b".to_string()];
1323 /// for s in v.into_iter() {
1324 /// // s has type String, not &String
1325 /// println!("{}", s);
1329 fn into_iter(mut self) -> IntoIter<T> {
1331 let ptr = self.as_mut_ptr();
1332 assume(!ptr.is_null());
1333 let begin = ptr as *const T;
1334 let end = if mem::size_of::<T>() == 0 {
1335 arith_offset(ptr as *const i8, self.len() as isize) as *const T
1337 ptr.offset(self.len() as isize) as *const T
1339 let buf = ptr::read(&self.buf);
1350 #[stable(feature = "rust1", since = "1.0.0")]
1351 impl<'a, T> IntoIterator for &'a Vec<T> {
1353 type IntoIter = slice::Iter<'a, T>;
1355 fn into_iter(self) -> slice::Iter<'a, T> {
1360 #[stable(feature = "rust1", since = "1.0.0")]
1361 impl<'a, T> IntoIterator for &'a mut Vec<T> {
1362 type Item = &'a mut T;
1363 type IntoIter = slice::IterMut<'a, T>;
1365 fn into_iter(mut self) -> slice::IterMut<'a, T> {
1370 #[stable(feature = "rust1", since = "1.0.0")]
1371 impl<T> Extend<T> for Vec<T> {
1373 fn extend<I: IntoIterator<Item = T>>(&mut self, iterable: I) {
1374 self.extend_desugared(iterable.into_iter())
1379 fn extend_desugared<I: Iterator<Item = T>>(&mut self, mut iterator: I) {
1380 // This function should be the moral equivalent of:
1382 // for item in iterator {
1385 while let Some(element) = iterator.next() {
1386 let len = self.len();
1387 if len == self.capacity() {
1388 let (lower, _) = iterator.size_hint();
1389 self.reserve(lower.saturating_add(1));
1392 ptr::write(self.get_unchecked_mut(len), element);
1393 // NB can't overflow since we would have had to alloc the address space
1394 self.set_len(len + 1);
1400 #[stable(feature = "extend_ref", since = "1.2.0")]
1401 impl<'a, T: 'a + Copy> Extend<&'a T> for Vec<T> {
1402 fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I) {
1403 self.extend(iter.into_iter().cloned());
1407 macro_rules! __impl_slice_eq1 {
1408 ($Lhs: ty, $Rhs: ty) => {
1409 __impl_slice_eq1! { $Lhs, $Rhs, Sized }
1411 ($Lhs: ty, $Rhs: ty, $Bound: ident) => {
1412 #[stable(feature = "rust1", since = "1.0.0")]
1413 impl<'a, 'b, A: $Bound, B> PartialEq<$Rhs> for $Lhs where A: PartialEq<B> {
1415 fn eq(&self, other: &$Rhs) -> bool { self[..] == other[..] }
1417 fn ne(&self, other: &$Rhs) -> bool { self[..] != other[..] }
1422 __impl_slice_eq1! { Vec<A>, Vec<B> }
1423 __impl_slice_eq1! { Vec<A>, &'b [B] }
1424 __impl_slice_eq1! { Vec<A>, &'b mut [B] }
1425 __impl_slice_eq1! { Cow<'a, [A]>, &'b [B], Clone }
1426 __impl_slice_eq1! { Cow<'a, [A]>, &'b mut [B], Clone }
1427 __impl_slice_eq1! { Cow<'a, [A]>, Vec<B>, Clone }
1429 macro_rules! array_impls {
1432 // NOTE: some less important impls are omitted to reduce code bloat
1433 __impl_slice_eq1! { Vec<A>, [B; $N] }
1434 __impl_slice_eq1! { Vec<A>, &'b [B; $N] }
1435 // __impl_slice_eq1! { Vec<A>, &'b mut [B; $N] }
1436 // __impl_slice_eq1! { Cow<'a, [A]>, [B; $N], Clone }
1437 // __impl_slice_eq1! { Cow<'a, [A]>, &'b [B; $N], Clone }
1438 // __impl_slice_eq1! { Cow<'a, [A]>, &'b mut [B; $N], Clone }
1445 10 11 12 13 14 15 16 17 18 19
1446 20 21 22 23 24 25 26 27 28 29
1450 #[stable(feature = "rust1", since = "1.0.0")]
1451 impl<T: PartialOrd> PartialOrd for Vec<T> {
1453 fn partial_cmp(&self, other: &Vec<T>) -> Option<Ordering> {
1454 PartialOrd::partial_cmp(&**self, &**other)
1458 #[stable(feature = "rust1", since = "1.0.0")]
1459 impl<T: Eq> Eq for Vec<T> {}
1461 #[stable(feature = "rust1", since = "1.0.0")]
1462 impl<T: Ord> Ord for Vec<T> {
1464 fn cmp(&self, other: &Vec<T>) -> Ordering {
1465 Ord::cmp(&**self, &**other)
1469 #[stable(feature = "rust1", since = "1.0.0")]
1470 impl<T> Drop for Vec<T> {
1471 #[unsafe_destructor_blind_to_params]
1472 fn drop(&mut self) {
1473 if self.buf.unsafe_no_drop_flag_needs_drop() {
1476 ptr::drop_in_place(&mut self[..]);
1479 // RawVec handles deallocation
1483 #[stable(feature = "rust1", since = "1.0.0")]
1484 impl<T> Default for Vec<T> {
1485 fn default() -> Vec<T> {
1490 #[stable(feature = "rust1", since = "1.0.0")]
1491 impl<T: fmt::Debug> fmt::Debug for Vec<T> {
1492 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1493 fmt::Debug::fmt(&**self, f)
1497 #[stable(feature = "rust1", since = "1.0.0")]
1498 impl<T> AsRef<Vec<T>> for Vec<T> {
1499 fn as_ref(&self) -> &Vec<T> {
1504 #[stable(feature = "vec_as_mut", since = "1.5.0")]
1505 impl<T> AsMut<Vec<T>> for Vec<T> {
1506 fn as_mut(&mut self) -> &mut Vec<T> {
1511 #[stable(feature = "rust1", since = "1.0.0")]
1512 impl<T> AsRef<[T]> for Vec<T> {
1513 fn as_ref(&self) -> &[T] {
1518 #[stable(feature = "vec_as_mut", since = "1.5.0")]
1519 impl<T> AsMut<[T]> for Vec<T> {
1520 fn as_mut(&mut self) -> &mut [T] {
1525 #[stable(feature = "rust1", since = "1.0.0")]
1526 impl<'a, T: Clone> From<&'a [T]> for Vec<T> {
1528 fn from(s: &'a [T]) -> Vec<T> {
1532 fn from(s: &'a [T]) -> Vec<T> {
1537 #[stable(feature = "rust1", since = "1.0.0")]
1538 impl<'a> From<&'a str> for Vec<u8> {
1539 fn from(s: &'a str) -> Vec<u8> {
1540 From::from(s.as_bytes())
1544 ////////////////////////////////////////////////////////////////////////////////
1546 ////////////////////////////////////////////////////////////////////////////////
1548 #[stable(feature = "cow_from_vec", since = "1.7.0")]
1549 impl<'a, T: Clone> From<&'a [T]> for Cow<'a, [T]> {
1550 fn from(s: &'a [T]) -> Cow<'a, [T]> {
1555 #[stable(feature = "cow_from_vec", since = "1.7.0")]
1556 impl<'a, T: Clone> From<Vec<T>> for Cow<'a, [T]> {
1557 fn from(v: Vec<T>) -> Cow<'a, [T]> {
1562 #[stable(feature = "rust1", since = "1.0.0")]
1563 impl<'a, T> FromIterator<T> for Cow<'a, [T]> where T: Clone {
1564 fn from_iter<I: IntoIterator<Item = T>>(it: I) -> Cow<'a, [T]> {
1565 Cow::Owned(FromIterator::from_iter(it))
1569 #[stable(feature = "rust1", since = "1.0.0")]
1570 #[allow(deprecated)]
1571 impl<'a, T: 'a> IntoCow<'a, [T]> for Vec<T> where T: Clone {
1572 fn into_cow(self) -> Cow<'a, [T]> {
1577 #[stable(feature = "rust1", since = "1.0.0")]
1578 #[allow(deprecated)]
1579 impl<'a, T> IntoCow<'a, [T]> for &'a [T] where T: Clone {
1580 fn into_cow(self) -> Cow<'a, [T]> {
1585 ////////////////////////////////////////////////////////////////////////////////
1587 ////////////////////////////////////////////////////////////////////////////////
1589 /// An iterator that moves out of a vector.
1590 #[stable(feature = "rust1", since = "1.0.0")]
1591 pub struct IntoIter<T> {
1597 #[stable(feature = "rust1", since = "1.0.0")]
1598 unsafe impl<T: Send> Send for IntoIter<T> {}
1599 #[stable(feature = "rust1", since = "1.0.0")]
1600 unsafe impl<T: Sync> Sync for IntoIter<T> {}
1602 #[stable(feature = "rust1", since = "1.0.0")]
1603 impl<T> Iterator for IntoIter<T> {
1607 fn next(&mut self) -> Option<T> {
1609 if self.ptr == self.end {
1612 if mem::size_of::<T>() == 0 {
1613 // purposefully don't use 'ptr.offset' because for
1614 // vectors with 0-size elements this would return the
1616 self.ptr = arith_offset(self.ptr as *const i8, 1) as *const T;
1618 // Use a non-null pointer value
1619 Some(ptr::read(EMPTY as *mut T))
1622 self.ptr = self.ptr.offset(1);
1624 Some(ptr::read(old))
1631 fn size_hint(&self) -> (usize, Option<usize>) {
1632 let diff = (self.end as usize) - (self.ptr as usize);
1633 let size = mem::size_of::<T>();
1640 (exact, Some(exact))
1644 fn count(self) -> usize {
1649 #[stable(feature = "rust1", since = "1.0.0")]
1650 impl<T> DoubleEndedIterator for IntoIter<T> {
1652 fn next_back(&mut self) -> Option<T> {
1654 if self.end == self.ptr {
1657 if mem::size_of::<T>() == 0 {
1658 // See above for why 'ptr.offset' isn't used
1659 self.end = arith_offset(self.end as *const i8, -1) as *const T;
1661 // Use a non-null pointer value
1662 Some(ptr::read(EMPTY as *mut T))
1664 self.end = self.end.offset(-1);
1666 Some(ptr::read(self.end))
1673 #[stable(feature = "rust1", since = "1.0.0")]
1674 impl<T> ExactSizeIterator for IntoIter<T> {}
1676 #[stable(feature = "vec_into_iter_clone", since = "1.8.0")]
1677 impl<T: Clone> Clone for IntoIter<T> {
1678 fn clone(&self) -> IntoIter<T> {
1680 slice::from_raw_parts(self.ptr, self.len()).to_owned().into_iter()
1685 #[stable(feature = "rust1", since = "1.0.0")]
1686 impl<T> Drop for IntoIter<T> {
1687 #[unsafe_destructor_blind_to_params]
1688 fn drop(&mut self) {
1689 // destroy the remaining elements
1692 // RawVec handles deallocation
1696 /// A draining iterator for `Vec<T>`.
1697 #[stable(feature = "drain", since = "1.6.0")]
1698 pub struct Drain<'a, T: 'a> {
1699 /// Index of tail to preserve
1703 /// Current remaining range to remove
1704 iter: slice::IterMut<'a, T>,
1708 #[stable(feature = "drain", since = "1.6.0")]
1709 unsafe impl<'a, T: Sync> Sync for Drain<'a, T> {}
1710 #[stable(feature = "drain", since = "1.6.0")]
1711 unsafe impl<'a, T: Send> Send for Drain<'a, T> {}
1713 #[stable(feature = "rust1", since = "1.0.0")]
1714 impl<'a, T> Iterator for Drain<'a, T> {
1718 fn next(&mut self) -> Option<T> {
1719 self.iter.next().map(|elt| unsafe { ptr::read(elt as *const _) })
1722 fn size_hint(&self) -> (usize, Option<usize>) {
1723 self.iter.size_hint()
1727 #[stable(feature = "rust1", since = "1.0.0")]
1728 impl<'a, T> DoubleEndedIterator for Drain<'a, T> {
1730 fn next_back(&mut self) -> Option<T> {
1731 self.iter.next_back().map(|elt| unsafe { ptr::read(elt as *const _) })
1735 #[stable(feature = "rust1", since = "1.0.0")]
1736 impl<'a, T> Drop for Drain<'a, T> {
1737 fn drop(&mut self) {
1738 // exhaust self first
1739 while let Some(_) = self.next() {}
1741 if self.tail_len > 0 {
1743 let source_vec = &mut *self.vec;
1744 // memmove back untouched tail, update to new length
1745 let start = source_vec.len();
1746 let tail = self.tail_start;
1747 let src = source_vec.as_ptr().offset(tail as isize);
1748 let dst = source_vec.as_mut_ptr().offset(start as isize);
1749 ptr::copy(src, dst, self.tail_len);
1750 source_vec.set_len(start + self.tail_len);
1757 #[stable(feature = "rust1", since = "1.0.0")]
1758 impl<'a, T> ExactSizeIterator for Drain<'a, T> {}