1 //! A contiguous growable array type with heap-allocated contents, written
4 //! Vectors have `O(1)` indexing, amortized `O(1)` push (to the end) and
5 //! `O(1)` pop (from the end).
7 //! Vectors ensure they never allocate more than `isize::MAX` bytes.
11 //! You can explicitly create a [`Vec<T>`] with [`new`]:
14 //! let v: Vec<i32> = Vec::new();
17 //! ...or by using the [`vec!`] macro:
20 //! let v: Vec<i32> = vec![];
22 //! let v = vec![1, 2, 3, 4, 5];
24 //! let v = vec![0; 10]; // ten zeroes
27 //! You can [`push`] values onto the end of a vector (which will grow the vector
31 //! let mut v = vec![1, 2];
36 //! Popping values works in much the same way:
39 //! let mut v = vec![1, 2];
41 //! let two = v.pop();
44 //! Vectors also support indexing (through the [`Index`] and [`IndexMut`] traits):
47 //! let mut v = vec![1, 2, 3];
52 //! [`Vec<T>`]: ../../std/vec/struct.Vec.html
53 //! [`new`]: ../../std/vec/struct.Vec.html#method.new
54 //! [`push`]: ../../std/vec/struct.Vec.html#method.push
55 //! [`Index`]: ../../std/ops/trait.Index.html
56 //! [`IndexMut`]: ../../std/ops/trait.IndexMut.html
57 //! [`vec!`]: ../../std/macro.vec.html
59 #![stable(feature = "rust1", since = "1.0.0")]
61 use core::array::LengthAtMost32;
62 use core::cmp::{self, Ordering};
64 use core::hash::{self, Hash};
65 use core::intrinsics::{arith_offset, assume};
66 use core::iter::{FromIterator, FusedIterator, TrustedLen};
67 use core::marker::PhantomData;
69 use core::ops::Bound::{Excluded, Included, Unbounded};
70 use core::ops::{self, Index, IndexMut, RangeBounds};
71 use core::ptr::{self, NonNull};
72 use core::slice::{self, SliceIndex};
74 use crate::borrow::{Cow, ToOwned};
75 use crate::boxed::Box;
76 use crate::collections::TryReserveError;
77 use crate::raw_vec::RawVec;
79 /// A contiguous growable array type, written `Vec<T>` but pronounced 'vector'.
84 /// let mut vec = Vec::new();
88 /// assert_eq!(vec.len(), 2);
89 /// assert_eq!(vec[0], 1);
91 /// assert_eq!(vec.pop(), Some(2));
92 /// assert_eq!(vec.len(), 1);
95 /// assert_eq!(vec[0], 7);
97 /// vec.extend([1, 2, 3].iter().copied());
100 /// println!("{}", x);
102 /// assert_eq!(vec, [7, 1, 2, 3]);
105 /// The [`vec!`] macro is provided to make initialization more convenient:
108 /// let mut vec = vec![1, 2, 3];
110 /// assert_eq!(vec, [1, 2, 3, 4]);
113 /// It can also initialize each element of a `Vec<T>` with a given value.
114 /// This may be more efficient than performing allocation and initialization
115 /// in separate steps, especially when initializing a vector of zeros:
118 /// let vec = vec![0; 5];
119 /// assert_eq!(vec, [0, 0, 0, 0, 0]);
121 /// // The following is equivalent, but potentially slower:
122 /// let mut vec1 = Vec::with_capacity(5);
123 /// vec1.resize(5, 0);
126 /// Use a `Vec<T>` as an efficient stack:
129 /// let mut stack = Vec::new();
135 /// while let Some(top) = stack.pop() {
136 /// // Prints 3, 2, 1
137 /// println!("{}", top);
143 /// The `Vec` type allows to access values by index, because it implements the
144 /// [`Index`] trait. An example will be more explicit:
147 /// let v = vec![0, 2, 4, 6];
148 /// println!("{}", v[1]); // it will display '2'
151 /// However be careful: if you try to access an index which isn't in the `Vec`,
152 /// your software will panic! You cannot do this:
155 /// let v = vec![0, 2, 4, 6];
156 /// println!("{}", v[6]); // it will panic!
159 /// Use [`get`] and [`get_mut`] if you want to check whether the index is in
164 /// A `Vec` can be mutable. Slices, on the other hand, are read-only objects.
165 /// To get a slice, use `&`. Example:
168 /// fn read_slice(slice: &[usize]) {
172 /// let v = vec![0, 1];
175 /// // ... and that's all!
176 /// // you can also do it like this:
177 /// let x : &[usize] = &v;
180 /// In Rust, it's more common to pass slices as arguments rather than vectors
181 /// when you just want to provide read access. The same goes for [`String`] and
184 /// # Capacity and reallocation
186 /// The capacity of a vector is the amount of space allocated for any future
187 /// elements that will be added onto the vector. This is not to be confused with
188 /// the *length* of a vector, which specifies the number of actual elements
189 /// within the vector. If a vector's length exceeds its capacity, its capacity
190 /// will automatically be increased, but its elements will have to be
193 /// For example, a vector with capacity 10 and length 0 would be an empty vector
194 /// with space for 10 more elements. Pushing 10 or fewer elements onto the
195 /// vector will not change its capacity or cause reallocation to occur. However,
196 /// if the vector's length is increased to 11, it will have to reallocate, which
197 /// can be slow. For this reason, it is recommended to use [`Vec::with_capacity`]
198 /// whenever possible to specify how big the vector is expected to get.
202 /// Due to its incredibly fundamental nature, `Vec` makes a lot of guarantees
203 /// about its design. This ensures that it's as low-overhead as possible in
204 /// the general case, and can be correctly manipulated in primitive ways
205 /// by unsafe code. Note that these guarantees refer to an unqualified `Vec<T>`.
206 /// If additional type parameters are added (e.g., to support custom allocators),
207 /// overriding their defaults may change the behavior.
209 /// Most fundamentally, `Vec` is and always will be a (pointer, capacity, length)
210 /// triplet. No more, no less. The order of these fields is completely
211 /// unspecified, and you should use the appropriate methods to modify these.
212 /// The pointer will never be null, so this type is null-pointer-optimized.
214 /// However, the pointer may not actually point to allocated memory. In particular,
215 /// if you construct a `Vec` with capacity 0 via [`Vec::new`], [`vec![]`][`vec!`],
216 /// [`Vec::with_capacity(0)`][`Vec::with_capacity`], or by calling [`shrink_to_fit`]
217 /// on an empty Vec, it will not allocate memory. Similarly, if you store zero-sized
218 /// types inside a `Vec`, it will not allocate space for them. *Note that in this case
219 /// the `Vec` may not report a [`capacity`] of 0*. `Vec` will allocate if and only
220 /// if [`mem::size_of::<T>`]`() * capacity() > 0`. In general, `Vec`'s allocation
221 /// details are very subtle — if you intend to allocate memory using a `Vec`
222 /// and use it for something else (either to pass to unsafe code, or to build your
223 /// own memory-backed collection), be sure to deallocate this memory by using
224 /// `from_raw_parts` to recover the `Vec` and then dropping it.
226 /// If a `Vec` *has* allocated memory, then the memory it points to is on the heap
227 /// (as defined by the allocator Rust is configured to use by default), and its
228 /// pointer points to [`len`] initialized, contiguous elements in order (what
229 /// you would see if you coerced it to a slice), followed by [`capacity`]` -
230 /// `[`len`] logically uninitialized, contiguous elements.
232 /// `Vec` will never perform a "small optimization" where elements are actually
233 /// stored on the stack for two reasons:
235 /// * It would make it more difficult for unsafe code to correctly manipulate
236 /// a `Vec`. The contents of a `Vec` wouldn't have a stable address if it were
237 /// only moved, and it would be more difficult to determine if a `Vec` had
238 /// actually allocated memory.
240 /// * It would penalize the general case, incurring an additional branch
243 /// `Vec` will never automatically shrink itself, even if completely empty. This
244 /// ensures no unnecessary allocations or deallocations occur. Emptying a `Vec`
245 /// and then filling it back up to the same [`len`] should incur no calls to
246 /// the allocator. If you wish to free up unused memory, use
247 /// [`shrink_to_fit`].
249 /// [`push`] and [`insert`] will never (re)allocate if the reported capacity is
250 /// sufficient. [`push`] and [`insert`] *will* (re)allocate if
251 /// [`len`]` == `[`capacity`]. That is, the reported capacity is completely
252 /// accurate, and can be relied on. It can even be used to manually free the memory
253 /// allocated by a `Vec` if desired. Bulk insertion methods *may* reallocate, even
254 /// when not necessary.
256 /// `Vec` does not guarantee any particular growth strategy when reallocating
257 /// when full, nor when [`reserve`] is called. The current strategy is basic
258 /// and it may prove desirable to use a non-constant growth factor. Whatever
259 /// strategy is used will of course guarantee `O(1)` amortized [`push`].
261 /// `vec![x; n]`, `vec![a, b, c, d]`, and
262 /// [`Vec::with_capacity(n)`][`Vec::with_capacity`], will all produce a `Vec`
263 /// with exactly the requested capacity. If [`len`]` == `[`capacity`],
264 /// (as is the case for the [`vec!`] macro), then a `Vec<T>` can be converted to
265 /// and from a [`Box<[T]>`][owned slice] without reallocating or moving the elements.
267 /// `Vec` will not specifically overwrite any data that is removed from it,
268 /// but also won't specifically preserve it. Its uninitialized memory is
269 /// scratch space that it may use however it wants. It will generally just do
270 /// whatever is most efficient or otherwise easy to implement. Do not rely on
271 /// removed data to be erased for security purposes. Even if you drop a `Vec`, its
272 /// buffer may simply be reused by another `Vec`. Even if you zero a `Vec`'s memory
273 /// first, that may not actually happen because the optimizer does not consider
274 /// this a side-effect that must be preserved. There is one case which we will
275 /// not break, however: using `unsafe` code to write to the excess capacity,
276 /// and then increasing the length to match, is always valid.
278 /// `Vec` does not currently guarantee the order in which elements are dropped.
279 /// The order has changed in the past and may change again.
281 /// [`vec!`]: ../../std/macro.vec.html
282 /// [`get`]: ../../std/vec/struct.Vec.html#method.get
283 /// [`get_mut`]: ../../std/vec/struct.Vec.html#method.get_mut
284 /// [`Index`]: ../../std/ops/trait.Index.html
285 /// [`String`]: ../../std/string/struct.String.html
286 /// [`&str`]: ../../std/primitive.str.html
287 /// [`Vec::with_capacity`]: ../../std/vec/struct.Vec.html#method.with_capacity
288 /// [`Vec::new`]: ../../std/vec/struct.Vec.html#method.new
289 /// [`shrink_to_fit`]: ../../std/vec/struct.Vec.html#method.shrink_to_fit
290 /// [`capacity`]: ../../std/vec/struct.Vec.html#method.capacity
291 /// [`mem::size_of::<T>`]: ../../std/mem/fn.size_of.html
292 /// [`len`]: ../../std/vec/struct.Vec.html#method.len
293 /// [`push`]: ../../std/vec/struct.Vec.html#method.push
294 /// [`insert`]: ../../std/vec/struct.Vec.html#method.insert
295 /// [`reserve`]: ../../std/vec/struct.Vec.html#method.reserve
296 /// [owned slice]: ../../std/boxed/struct.Box.html
297 #[stable(feature = "rust1", since = "1.0.0")]
298 #[cfg_attr(not(test), rustc_diagnostic_item = "vec_type")]
304 ////////////////////////////////////////////////////////////////////////////////
306 ////////////////////////////////////////////////////////////////////////////////
309 /// Constructs a new, empty `Vec<T>`.
311 /// The vector will not allocate until elements are pushed onto it.
316 /// # #![allow(unused_mut)]
317 /// let mut vec: Vec<i32> = Vec::new();
320 #[rustc_const_stable(feature = "const_vec_new", since = "1.39.0")]
321 #[stable(feature = "rust1", since = "1.0.0")]
322 pub const fn new() -> Vec<T> {
323 Vec { buf: RawVec::NEW, len: 0 }
326 /// Constructs a new, empty `Vec<T>` with the specified capacity.
328 /// The vector will be able to hold exactly `capacity` elements without
329 /// reallocating. If `capacity` is 0, the vector will not allocate.
331 /// It is important to note that although the returned vector has the
332 /// *capacity* specified, the vector will have a zero *length*. For an
333 /// explanation of the difference between length and capacity, see
334 /// *[Capacity and reallocation]*.
336 /// [Capacity and reallocation]: #capacity-and-reallocation
341 /// let mut vec = Vec::with_capacity(10);
343 /// // The vector contains no items, even though it has capacity for more
344 /// assert_eq!(vec.len(), 0);
346 /// // These are all done without reallocating...
351 /// // ...but this may make the vector reallocate
355 #[stable(feature = "rust1", since = "1.0.0")]
356 pub fn with_capacity(capacity: usize) -> Vec<T> {
357 Vec { buf: RawVec::with_capacity(capacity), len: 0 }
360 /// Decomposes a `Vec<T>` into its raw components.
362 /// Returns the raw pointer to the underlying data, the length of
363 /// the vector (in elements), and the allocated capacity of the
364 /// data (in elements). These are the same arguments in the same
365 /// order as the arguments to [`from_raw_parts`].
367 /// After calling this function, the caller is responsible for the
368 /// memory previously managed by the `Vec`. The only way to do
369 /// this is to convert the raw pointer, length, and capacity back
370 /// into a `Vec` with the [`from_raw_parts`] function, allowing
371 /// the destructor to perform the cleanup.
373 /// [`from_raw_parts`]: #method.from_raw_parts
378 /// #![feature(vec_into_raw_parts)]
379 /// let v: Vec<i32> = vec![-1, 0, 1];
381 /// let (ptr, len, cap) = v.into_raw_parts();
383 /// let rebuilt = unsafe {
384 /// // We can now make changes to the components, such as
385 /// // transmuting the raw pointer to a compatible type.
386 /// let ptr = ptr as *mut u32;
388 /// Vec::from_raw_parts(ptr, len, cap)
390 /// assert_eq!(rebuilt, [4294967295, 0, 1]);
392 #[unstable(feature = "vec_into_raw_parts", reason = "new API", issue = "65816")]
393 pub fn into_raw_parts(self) -> (*mut T, usize, usize) {
394 let mut me = mem::ManuallyDrop::new(self);
395 (me.as_mut_ptr(), me.len(), me.capacity())
398 /// Creates a `Vec<T>` directly from the raw components of another vector.
402 /// This is highly unsafe, due to the number of invariants that aren't
405 /// * `ptr` needs to have been previously allocated via [`String`]/`Vec<T>`
406 /// (at least, it's highly likely to be incorrect if it wasn't).
407 /// * `T` needs to have the same size and alignment as what `ptr` was allocated with.
408 /// (`T` having a less strict alignment is not sufficient, the alignment really
409 /// needs to be equal to satsify the [`dealloc`] requirement that memory must be
410 /// allocated and deallocated with the same layout.)
411 /// * `length` needs to be less than or equal to `capacity`.
412 /// * `capacity` needs to be the capacity that the pointer was allocated with.
414 /// Violating these may cause problems like corrupting the allocator's
415 /// internal data structures. For example it is **not** safe
416 /// to build a `Vec<u8>` from a pointer to a C `char` array with length `size_t`.
417 /// It's also not safe to build one from a `Vec<u16>` and its length, because
418 /// the allocator cares about the alignment, and these two types have different
419 /// alignments. The buffer was allocated with alignment 2 (for `u16`), but after
420 /// turning it into a `Vec<u8>` it'll be deallocated with alignment 1.
422 /// The ownership of `ptr` is effectively transferred to the
423 /// `Vec<T>` which may then deallocate, reallocate or change the
424 /// contents of memory pointed to by the pointer at will. Ensure
425 /// that nothing else uses the pointer after calling this
428 /// [`String`]: ../../std/string/struct.String.html
429 /// [`dealloc`]: ../../alloc/alloc/trait.GlobalAlloc.html#tymethod.dealloc
437 /// let v = vec![1, 2, 3];
439 // FIXME Update this when vec_into_raw_parts is stabilized
440 /// // Prevent running `v`'s destructor so we are in complete control
441 /// // of the allocation.
442 /// let mut v = mem::ManuallyDrop::new(v);
444 /// // Pull out the various important pieces of information about `v`
445 /// let p = v.as_mut_ptr();
446 /// let len = v.len();
447 /// let cap = v.capacity();
450 /// // Overwrite memory with 4, 5, 6
451 /// for i in 0..len as isize {
452 /// ptr::write(p.offset(i), 4 + i);
455 /// // Put everything back together into a Vec
456 /// let rebuilt = Vec::from_raw_parts(p, len, cap);
457 /// assert_eq!(rebuilt, [4, 5, 6]);
460 #[stable(feature = "rust1", since = "1.0.0")]
461 pub unsafe fn from_raw_parts(ptr: *mut T, length: usize, capacity: usize) -> Vec<T> {
462 Vec { buf: RawVec::from_raw_parts(ptr, capacity), len: length }
465 /// Returns the number of elements the vector can hold without
471 /// let vec: Vec<i32> = Vec::with_capacity(10);
472 /// assert_eq!(vec.capacity(), 10);
475 #[stable(feature = "rust1", since = "1.0.0")]
476 pub fn capacity(&self) -> usize {
480 /// Reserves capacity for at least `additional` more elements to be inserted
481 /// in the given `Vec<T>`. The collection may reserve more space to avoid
482 /// frequent reallocations. After calling `reserve`, capacity will be
483 /// greater than or equal to `self.len() + additional`. Does nothing if
484 /// capacity is already sufficient.
488 /// Panics if the new capacity overflows `usize`.
493 /// let mut vec = vec![1];
495 /// assert!(vec.capacity() >= 11);
497 #[stable(feature = "rust1", since = "1.0.0")]
498 pub fn reserve(&mut self, additional: usize) {
499 self.buf.reserve(self.len, additional);
502 /// Reserves the minimum capacity for exactly `additional` more elements to
503 /// be inserted in the given `Vec<T>`. After calling `reserve_exact`,
504 /// capacity will be greater than or equal to `self.len() + additional`.
505 /// Does nothing if the capacity is already sufficient.
507 /// Note that the allocator may give the collection more space than it
508 /// requests. Therefore, capacity can not be relied upon to be precisely
509 /// minimal. Prefer `reserve` if future insertions are expected.
513 /// Panics if the new capacity overflows `usize`.
518 /// let mut vec = vec![1];
519 /// vec.reserve_exact(10);
520 /// assert!(vec.capacity() >= 11);
522 #[stable(feature = "rust1", since = "1.0.0")]
523 pub fn reserve_exact(&mut self, additional: usize) {
524 self.buf.reserve_exact(self.len, additional);
527 /// Tries to reserve capacity for at least `additional` more elements to be inserted
528 /// in the given `Vec<T>`. The collection may reserve more space to avoid
529 /// frequent reallocations. After calling `reserve`, capacity will be
530 /// greater than or equal to `self.len() + additional`. Does nothing if
531 /// capacity is already sufficient.
535 /// If the capacity overflows, or the allocator reports a failure, then an error
541 /// #![feature(try_reserve)]
542 /// use std::collections::TryReserveError;
544 /// fn process_data(data: &[u32]) -> Result<Vec<u32>, TryReserveError> {
545 /// let mut output = Vec::new();
547 /// // Pre-reserve the memory, exiting if we can't
548 /// output.try_reserve(data.len())?;
550 /// // Now we know this can't OOM in the middle of our complex work
551 /// output.extend(data.iter().map(|&val| {
552 /// val * 2 + 5 // very complicated
557 /// # process_data(&[1, 2, 3]).expect("why is the test harness OOMing on 12 bytes?");
559 #[unstable(feature = "try_reserve", reason = "new API", issue = "48043")]
560 pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError> {
561 self.buf.try_reserve(self.len, additional)
564 /// Tries to reserves the minimum capacity for exactly `additional` more elements to
565 /// be inserted in the given `Vec<T>`. After calling `reserve_exact`,
566 /// capacity will be greater than or equal to `self.len() + additional`.
567 /// Does nothing if the capacity is already sufficient.
569 /// Note that the allocator may give the collection more space than it
570 /// requests. Therefore, capacity can not be relied upon to be precisely
571 /// minimal. Prefer `reserve` if future insertions are expected.
575 /// If the capacity overflows, or the allocator reports a failure, then an error
581 /// #![feature(try_reserve)]
582 /// use std::collections::TryReserveError;
584 /// fn process_data(data: &[u32]) -> Result<Vec<u32>, TryReserveError> {
585 /// let mut output = Vec::new();
587 /// // Pre-reserve the memory, exiting if we can't
588 /// output.try_reserve(data.len())?;
590 /// // Now we know this can't OOM in the middle of our complex work
591 /// output.extend(data.iter().map(|&val| {
592 /// val * 2 + 5 // very complicated
597 /// # process_data(&[1, 2, 3]).expect("why is the test harness OOMing on 12 bytes?");
599 #[unstable(feature = "try_reserve", reason = "new API", issue = "48043")]
600 pub fn try_reserve_exact(&mut self, additional: usize) -> Result<(), TryReserveError> {
601 self.buf.try_reserve_exact(self.len, additional)
604 /// Shrinks the capacity of the vector as much as possible.
606 /// It will drop down as close as possible to the length but the allocator
607 /// may still inform the vector that there is space for a few more elements.
612 /// let mut vec = Vec::with_capacity(10);
613 /// vec.extend([1, 2, 3].iter().cloned());
614 /// assert_eq!(vec.capacity(), 10);
615 /// vec.shrink_to_fit();
616 /// assert!(vec.capacity() >= 3);
618 #[stable(feature = "rust1", since = "1.0.0")]
619 pub fn shrink_to_fit(&mut self) {
620 if self.capacity() != self.len {
621 self.buf.shrink_to_fit(self.len);
625 /// Shrinks the capacity of the vector with a lower bound.
627 /// The capacity will remain at least as large as both the length
628 /// and the supplied value.
632 /// Panics if the current capacity is smaller than the supplied
633 /// minimum capacity.
638 /// #![feature(shrink_to)]
639 /// let mut vec = Vec::with_capacity(10);
640 /// vec.extend([1, 2, 3].iter().cloned());
641 /// assert_eq!(vec.capacity(), 10);
642 /// vec.shrink_to(4);
643 /// assert!(vec.capacity() >= 4);
644 /// vec.shrink_to(0);
645 /// assert!(vec.capacity() >= 3);
647 #[unstable(feature = "shrink_to", reason = "new API", issue = "56431")]
648 pub fn shrink_to(&mut self, min_capacity: usize) {
649 self.buf.shrink_to_fit(cmp::max(self.len, min_capacity));
652 /// Converts the vector into [`Box<[T]>`][owned slice].
654 /// Note that this will drop any excess capacity.
656 /// [owned slice]: ../../std/boxed/struct.Box.html
661 /// let v = vec![1, 2, 3];
663 /// let slice = v.into_boxed_slice();
666 /// Any excess capacity is removed:
669 /// let mut vec = Vec::with_capacity(10);
670 /// vec.extend([1, 2, 3].iter().cloned());
672 /// assert_eq!(vec.capacity(), 10);
673 /// let slice = vec.into_boxed_slice();
674 /// assert_eq!(slice.into_vec().capacity(), 3);
676 #[stable(feature = "rust1", since = "1.0.0")]
677 pub fn into_boxed_slice(mut self) -> Box<[T]> {
679 self.shrink_to_fit();
680 let buf = ptr::read(&self.buf);
686 /// Shortens the vector, keeping the first `len` elements and dropping
689 /// If `len` is greater than the vector's current length, this has no
692 /// The [`drain`] method can emulate `truncate`, but causes the excess
693 /// elements to be returned instead of dropped.
695 /// Note that this method has no effect on the allocated capacity
700 /// Truncating a five element vector to two elements:
703 /// let mut vec = vec![1, 2, 3, 4, 5];
705 /// assert_eq!(vec, [1, 2]);
708 /// No truncation occurs when `len` is greater than the vector's current
712 /// let mut vec = vec![1, 2, 3];
714 /// assert_eq!(vec, [1, 2, 3]);
717 /// Truncating when `len == 0` is equivalent to calling the [`clear`]
721 /// let mut vec = vec![1, 2, 3];
723 /// assert_eq!(vec, []);
726 /// [`clear`]: #method.clear
727 /// [`drain`]: #method.drain
728 #[stable(feature = "rust1", since = "1.0.0")]
729 pub fn truncate(&mut self, len: usize) {
730 // This is safe because:
732 // * the slice passed to `drop_in_place` is valid; the `len > self.len`
733 // case avoids creating an invalid slice, and
734 // * the `len` of the vector is shrunk before calling `drop_in_place`,
735 // such that no value will be dropped twice in case `drop_in_place`
736 // were to panic once (if it panics twice, the program aborts).
741 let s = self.get_unchecked_mut(len..) as *mut _;
743 ptr::drop_in_place(s);
747 /// Extracts a slice containing the entire vector.
749 /// Equivalent to `&s[..]`.
754 /// use std::io::{self, Write};
755 /// let buffer = vec![1, 2, 3, 5, 8];
756 /// io::sink().write(buffer.as_slice()).unwrap();
759 #[stable(feature = "vec_as_slice", since = "1.7.0")]
760 pub fn as_slice(&self) -> &[T] {
764 /// Extracts a mutable slice of the entire vector.
766 /// Equivalent to `&mut s[..]`.
771 /// use std::io::{self, Read};
772 /// let mut buffer = vec![0; 3];
773 /// io::repeat(0b101).read_exact(buffer.as_mut_slice()).unwrap();
776 #[stable(feature = "vec_as_slice", since = "1.7.0")]
777 pub fn as_mut_slice(&mut self) -> &mut [T] {
781 /// Returns a raw pointer to the vector's buffer.
783 /// The caller must ensure that the vector outlives the pointer this
784 /// function returns, or else it will end up pointing to garbage.
785 /// Modifying the vector may cause its buffer to be reallocated,
786 /// which would also make any pointers to it invalid.
788 /// The caller must also ensure that the memory the pointer (non-transitively) points to
789 /// is never written to (except inside an `UnsafeCell`) using this pointer or any pointer
790 /// derived from it. If you need to mutate the contents of the slice, use [`as_mut_ptr`].
795 /// let x = vec![1, 2, 4];
796 /// let x_ptr = x.as_ptr();
799 /// for i in 0..x.len() {
800 /// assert_eq!(*x_ptr.add(i), 1 << i);
805 /// [`as_mut_ptr`]: #method.as_mut_ptr
806 #[stable(feature = "vec_as_ptr", since = "1.37.0")]
808 pub fn as_ptr(&self) -> *const T {
809 // We shadow the slice method of the same name to avoid going through
810 // `deref`, which creates an intermediate reference.
811 let ptr = self.buf.ptr();
813 assume(!ptr.is_null());
818 /// Returns an unsafe mutable pointer to the vector's buffer.
820 /// The caller must ensure that the vector outlives the pointer this
821 /// function returns, or else it will end up pointing to garbage.
822 /// Modifying the vector may cause its buffer to be reallocated,
823 /// which would also make any pointers to it invalid.
828 /// // Allocate vector big enough for 4 elements.
830 /// let mut x: Vec<i32> = Vec::with_capacity(size);
831 /// let x_ptr = x.as_mut_ptr();
833 /// // Initialize elements via raw pointer writes, then set length.
835 /// for i in 0..size {
836 /// *x_ptr.add(i) = i as i32;
840 /// assert_eq!(&*x, &[0,1,2,3]);
842 #[stable(feature = "vec_as_ptr", since = "1.37.0")]
844 pub fn as_mut_ptr(&mut self) -> *mut T {
845 // We shadow the slice method of the same name to avoid going through
846 // `deref_mut`, which creates an intermediate reference.
847 let ptr = self.buf.ptr();
849 assume(!ptr.is_null());
854 /// Forces the length of the vector to `new_len`.
856 /// This is a low-level operation that maintains none of the normal
857 /// invariants of the type. Normally changing the length of a vector
858 /// is done using one of the safe operations instead, such as
859 /// [`truncate`], [`resize`], [`extend`], or [`clear`].
861 /// [`truncate`]: #method.truncate
862 /// [`resize`]: #method.resize
863 /// [`extend`]: ../../std/iter/trait.Extend.html#tymethod.extend
864 /// [`clear`]: #method.clear
868 /// - `new_len` must be less than or equal to [`capacity()`].
869 /// - The elements at `old_len..new_len` must be initialized.
871 /// [`capacity()`]: #method.capacity
875 /// This method can be useful for situations in which the vector
876 /// is serving as a buffer for other code, particularly over FFI:
879 /// # #![allow(dead_code)]
880 /// # // This is just a minimal skeleton for the doc example;
881 /// # // don't use this as a starting point for a real library.
882 /// # pub struct StreamWrapper { strm: *mut std::ffi::c_void }
883 /// # const Z_OK: i32 = 0;
885 /// # fn deflateGetDictionary(
886 /// # strm: *mut std::ffi::c_void,
887 /// # dictionary: *mut u8,
888 /// # dictLength: *mut usize,
891 /// # impl StreamWrapper {
892 /// pub fn get_dictionary(&self) -> Option<Vec<u8>> {
893 /// // Per the FFI method's docs, "32768 bytes is always enough".
894 /// let mut dict = Vec::with_capacity(32_768);
895 /// let mut dict_length = 0;
896 /// // SAFETY: When `deflateGetDictionary` returns `Z_OK`, it holds that:
897 /// // 1. `dict_length` elements were initialized.
898 /// // 2. `dict_length` <= the capacity (32_768)
899 /// // which makes `set_len` safe to call.
901 /// // Make the FFI call...
902 /// let r = deflateGetDictionary(self.strm, dict.as_mut_ptr(), &mut dict_length);
904 /// // ...and update the length to what was initialized.
905 /// dict.set_len(dict_length);
915 /// While the following example is sound, there is a memory leak since
916 /// the inner vectors were not freed prior to the `set_len` call:
919 /// let mut vec = vec![vec![1, 0, 0],
923 /// // 1. `old_len..0` is empty so no elements need to be initialized.
924 /// // 2. `0 <= capacity` always holds whatever `capacity` is.
930 /// Normally, here, one would use [`clear`] instead to correctly drop
931 /// the contents and thus not leak memory.
933 #[stable(feature = "rust1", since = "1.0.0")]
934 pub unsafe fn set_len(&mut self, new_len: usize) {
935 debug_assert!(new_len <= self.capacity());
940 /// Removes an element from the vector and returns it.
942 /// The removed element is replaced by the last element of the vector.
944 /// This does not preserve ordering, but is O(1).
948 /// Panics if `index` is out of bounds.
953 /// let mut v = vec!["foo", "bar", "baz", "qux"];
955 /// assert_eq!(v.swap_remove(1), "bar");
956 /// assert_eq!(v, ["foo", "qux", "baz"]);
958 /// assert_eq!(v.swap_remove(0), "foo");
959 /// assert_eq!(v, ["baz", "qux"]);
962 #[stable(feature = "rust1", since = "1.0.0")]
963 pub fn swap_remove(&mut self, index: usize) -> T {
965 // We replace self[index] with the last element. Note that if the
966 // bounds check on hole succeeds there must be a last element (which
967 // can be self[index] itself).
968 let hole: *mut T = &mut self[index];
969 let last = ptr::read(self.get_unchecked(self.len - 1));
971 ptr::replace(hole, last)
975 /// Inserts an element at position `index` within the vector, shifting all
976 /// elements after it to the right.
980 /// Panics if `index > len`.
985 /// let mut vec = vec![1, 2, 3];
986 /// vec.insert(1, 4);
987 /// assert_eq!(vec, [1, 4, 2, 3]);
988 /// vec.insert(4, 5);
989 /// assert_eq!(vec, [1, 4, 2, 3, 5]);
991 #[stable(feature = "rust1", since = "1.0.0")]
992 pub fn insert(&mut self, index: usize, element: T) {
993 let len = self.len();
994 assert!(index <= len);
996 // space for the new element
997 if len == self.buf.capacity() {
1003 // The spot to put the new value
1005 let p = self.as_mut_ptr().add(index);
1006 // Shift everything over to make space. (Duplicating the
1007 // `index`th element into two consecutive places.)
1008 ptr::copy(p, p.offset(1), len - index);
1009 // Write it in, overwriting the first copy of the `index`th
1011 ptr::write(p, element);
1013 self.set_len(len + 1);
1017 /// Removes and returns the element at position `index` within the vector,
1018 /// shifting all elements after it to the left.
1022 /// Panics if `index` is out of bounds.
1027 /// let mut v = vec![1, 2, 3];
1028 /// assert_eq!(v.remove(1), 2);
1029 /// assert_eq!(v, [1, 3]);
1031 #[stable(feature = "rust1", since = "1.0.0")]
1032 pub fn remove(&mut self, index: usize) -> T {
1033 let len = self.len();
1034 assert!(index < len);
1039 // the place we are taking from.
1040 let ptr = self.as_mut_ptr().add(index);
1041 // copy it out, unsafely having a copy of the value on
1042 // the stack and in the vector at the same time.
1043 ret = ptr::read(ptr);
1045 // Shift everything down to fill in that spot.
1046 ptr::copy(ptr.offset(1), ptr, len - index - 1);
1048 self.set_len(len - 1);
1053 /// Retains only the elements specified by the predicate.
1055 /// In other words, remove all elements `e` such that `f(&e)` returns `false`.
1056 /// This method operates in place, visiting each element exactly once in the
1057 /// original order, and preserves the order of the retained elements.
1062 /// let mut vec = vec![1, 2, 3, 4];
1063 /// vec.retain(|&x| x % 2 == 0);
1064 /// assert_eq!(vec, [2, 4]);
1067 /// The exact order may be useful for tracking external state, like an index.
1070 /// let mut vec = vec![1, 2, 3, 4, 5];
1071 /// let keep = [false, true, true, false, true];
1073 /// vec.retain(|_| (keep[i], i += 1).0);
1074 /// assert_eq!(vec, [2, 3, 5]);
1076 #[stable(feature = "rust1", since = "1.0.0")]
1077 pub fn retain<F>(&mut self, mut f: F)
1079 F: FnMut(&T) -> bool,
1081 let len = self.len();
1084 let v = &mut **self;
1095 self.truncate(len - del);
1099 /// Removes all but the first of consecutive elements in the vector that resolve to the same
1102 /// If the vector is sorted, this removes all duplicates.
1107 /// let mut vec = vec![10, 20, 21, 30, 20];
1109 /// vec.dedup_by_key(|i| *i / 10);
1111 /// assert_eq!(vec, [10, 20, 30, 20]);
1113 #[stable(feature = "dedup_by", since = "1.16.0")]
1115 pub fn dedup_by_key<F, K>(&mut self, mut key: F)
1117 F: FnMut(&mut T) -> K,
1120 self.dedup_by(|a, b| key(a) == key(b))
1123 /// Removes all but the first of consecutive elements in the vector satisfying a given equality
1126 /// The `same_bucket` function is passed references to two elements from the vector and
1127 /// must determine if the elements compare equal. The elements are passed in opposite order
1128 /// from their order in the slice, so if `same_bucket(a, b)` returns `true`, `a` is removed.
1130 /// If the vector is sorted, this removes all duplicates.
1135 /// let mut vec = vec!["foo", "bar", "Bar", "baz", "bar"];
1137 /// vec.dedup_by(|a, b| a.eq_ignore_ascii_case(b));
1139 /// assert_eq!(vec, ["foo", "bar", "baz", "bar"]);
1141 #[stable(feature = "dedup_by", since = "1.16.0")]
1142 pub fn dedup_by<F>(&mut self, same_bucket: F)
1144 F: FnMut(&mut T, &mut T) -> bool,
1147 let (dedup, _) = self.as_mut_slice().partition_dedup_by(same_bucket);
1153 /// Appends an element to the back of a collection.
1157 /// Panics if the number of elements in the vector overflows a `usize`.
1162 /// let mut vec = vec![1, 2];
1164 /// assert_eq!(vec, [1, 2, 3]);
1167 #[stable(feature = "rust1", since = "1.0.0")]
1168 pub fn push(&mut self, value: T) {
1169 // This will panic or abort if we would allocate > isize::MAX bytes
1170 // or if the length increment would overflow for zero-sized types.
1171 if self.len == self.buf.capacity() {
1175 let end = self.as_mut_ptr().add(self.len);
1176 ptr::write(end, value);
1181 /// Removes the last element from a vector and returns it, or [`None`] if it
1184 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1189 /// let mut vec = vec![1, 2, 3];
1190 /// assert_eq!(vec.pop(), Some(3));
1191 /// assert_eq!(vec, [1, 2]);
1194 #[stable(feature = "rust1", since = "1.0.0")]
1195 pub fn pop(&mut self) -> Option<T> {
1201 Some(ptr::read(self.get_unchecked(self.len())))
1206 /// Moves all the elements of `other` into `Self`, leaving `other` empty.
1210 /// Panics if the number of elements in the vector overflows a `usize`.
1215 /// let mut vec = vec![1, 2, 3];
1216 /// let mut vec2 = vec![4, 5, 6];
1217 /// vec.append(&mut vec2);
1218 /// assert_eq!(vec, [1, 2, 3, 4, 5, 6]);
1219 /// assert_eq!(vec2, []);
1222 #[stable(feature = "append", since = "1.4.0")]
1223 pub fn append(&mut self, other: &mut Self) {
1225 self.append_elements(other.as_slice() as _);
1230 /// Appends elements to `Self` from other buffer.
1232 unsafe fn append_elements(&mut self, other: *const [T]) {
1233 let count = (*other).len();
1234 self.reserve(count);
1235 let len = self.len();
1236 ptr::copy_nonoverlapping(other as *const T, self.as_mut_ptr().add(len), count);
1240 /// Creates a draining iterator that removes the specified range in the vector
1241 /// and yields the removed items.
1243 /// Note 1: The element range is removed even if the iterator is only
1244 /// partially consumed or not consumed at all.
1246 /// Note 2: It is unspecified how many elements are removed from the vector
1247 /// if the `Drain` value is leaked.
1251 /// Panics if the starting point is greater than the end point or if
1252 /// the end point is greater than the length of the vector.
1257 /// let mut v = vec![1, 2, 3];
1258 /// let u: Vec<_> = v.drain(1..).collect();
1259 /// assert_eq!(v, &[1]);
1260 /// assert_eq!(u, &[2, 3]);
1262 /// // A full range clears the vector
1264 /// assert_eq!(v, &[]);
1266 #[stable(feature = "drain", since = "1.6.0")]
1267 pub fn drain<R>(&mut self, range: R) -> Drain<'_, T>
1269 R: RangeBounds<usize>,
1273 // When the Drain is first created, it shortens the length of
1274 // the source vector to make sure no uninitialized or moved-from elements
1275 // are accessible at all if the Drain's destructor never gets to run.
1277 // Drain will ptr::read out the values to remove.
1278 // When finished, remaining tail of the vec is copied back to cover
1279 // the hole, and the vector length is restored to the new length.
1281 let len = self.len();
1282 let start = match range.start_bound() {
1284 Excluded(&n) => n + 1,
1287 let end = match range.end_bound() {
1288 Included(&n) => n + 1,
1292 assert!(start <= end);
1293 assert!(end <= len);
1296 // set self.vec length's to start, to be safe in case Drain is leaked
1297 self.set_len(start);
1298 // Use the borrow in the IterMut to indicate borrowing behavior of the
1299 // whole Drain iterator (like &mut T).
1300 let range_slice = slice::from_raw_parts_mut(self.as_mut_ptr().add(start), end - start);
1303 tail_len: len - end,
1304 iter: range_slice.iter(),
1305 vec: NonNull::from(self),
1310 /// Clears the vector, removing all values.
1312 /// Note that this method has no effect on the allocated capacity
1318 /// let mut v = vec![1, 2, 3];
1322 /// assert!(v.is_empty());
1325 #[stable(feature = "rust1", since = "1.0.0")]
1326 pub fn clear(&mut self) {
1330 /// Returns the number of elements in the vector, also referred to
1331 /// as its 'length'.
1336 /// let a = vec![1, 2, 3];
1337 /// assert_eq!(a.len(), 3);
1340 #[stable(feature = "rust1", since = "1.0.0")]
1341 pub fn len(&self) -> usize {
1345 /// Returns `true` if the vector contains no elements.
1350 /// let mut v = Vec::new();
1351 /// assert!(v.is_empty());
1354 /// assert!(!v.is_empty());
1356 #[stable(feature = "rust1", since = "1.0.0")]
1357 pub fn is_empty(&self) -> bool {
1361 /// Splits the collection into two at the given index.
1363 /// Returns a newly allocated vector containing the elements in the range
1364 /// `[at, len)`. After the call, the original vector will be left containing
1365 /// the elements `[0, at)` with its previous capacity unchanged.
1369 /// Panics if `at > len`.
1374 /// let mut vec = vec![1,2,3];
1375 /// let vec2 = vec.split_off(1);
1376 /// assert_eq!(vec, [1]);
1377 /// assert_eq!(vec2, [2, 3]);
1380 #[stable(feature = "split_off", since = "1.4.0")]
1381 pub fn split_off(&mut self, at: usize) -> Self {
1382 assert!(at <= self.len(), "`at` out of bounds");
1384 let other_len = self.len - at;
1385 let mut other = Vec::with_capacity(other_len);
1387 // Unsafely `set_len` and copy items to `other`.
1390 other.set_len(other_len);
1392 ptr::copy_nonoverlapping(self.as_ptr().add(at), other.as_mut_ptr(), other.len());
1397 /// Resizes the `Vec` in-place so that `len` is equal to `new_len`.
1399 /// If `new_len` is greater than `len`, the `Vec` is extended by the
1400 /// difference, with each additional slot filled with the result of
1401 /// calling the closure `f`. The return values from `f` will end up
1402 /// in the `Vec` in the order they have been generated.
1404 /// If `new_len` is less than `len`, the `Vec` is simply truncated.
1406 /// This method uses a closure to create new values on every push. If
1407 /// you'd rather [`Clone`] a given value, use [`resize`]. If you want
1408 /// to use the [`Default`] trait to generate values, you can pass
1409 /// [`Default::default()`] as the second argument.
1414 /// let mut vec = vec![1, 2, 3];
1415 /// vec.resize_with(5, Default::default);
1416 /// assert_eq!(vec, [1, 2, 3, 0, 0]);
1418 /// let mut vec = vec![];
1420 /// vec.resize_with(4, || { p *= 2; p });
1421 /// assert_eq!(vec, [2, 4, 8, 16]);
1424 /// [`resize`]: #method.resize
1425 /// [`Clone`]: ../../std/clone/trait.Clone.html
1426 #[stable(feature = "vec_resize_with", since = "1.33.0")]
1427 pub fn resize_with<F>(&mut self, new_len: usize, f: F)
1431 let len = self.len();
1433 self.extend_with(new_len - len, ExtendFunc(f));
1435 self.truncate(new_len);
1439 /// Consumes and leaks the `Vec`, returning a mutable reference to the contents,
1440 /// `&'a mut [T]`. Note that the type `T` must outlive the chosen lifetime
1441 /// `'a`. If the type has only static references, or none at all, then this
1442 /// may be chosen to be `'static`.
1444 /// This function is similar to the `leak` function on `Box`.
1446 /// This function is mainly useful for data that lives for the remainder of
1447 /// the program's life. Dropping the returned reference will cause a memory
1455 /// #![feature(vec_leak)]
1457 /// let x = vec![1, 2, 3];
1458 /// let static_ref: &'static mut [usize] = Vec::leak(x);
1459 /// static_ref[0] += 1;
1460 /// assert_eq!(static_ref, &[2, 2, 3]);
1462 #[unstable(feature = "vec_leak", issue = "62195")]
1464 pub fn leak<'a>(vec: Vec<T>) -> &'a mut [T]
1466 T: 'a, // Technically not needed, but kept to be explicit.
1468 Box::leak(vec.into_boxed_slice())
1472 impl<T: Clone> Vec<T> {
1473 /// Resizes the `Vec` in-place so that `len` is equal to `new_len`.
1475 /// If `new_len` is greater than `len`, the `Vec` is extended by the
1476 /// difference, with each additional slot filled with `value`.
1477 /// If `new_len` is less than `len`, the `Vec` is simply truncated.
1479 /// This method requires `T` to implement [`Clone`],
1480 /// in order to be able to clone the passed value.
1481 /// If you need more flexibility (or want to rely on [`Default`] instead of
1482 /// [`Clone`]), use [`resize_with`].
1487 /// let mut vec = vec!["hello"];
1488 /// vec.resize(3, "world");
1489 /// assert_eq!(vec, ["hello", "world", "world"]);
1491 /// let mut vec = vec![1, 2, 3, 4];
1492 /// vec.resize(2, 0);
1493 /// assert_eq!(vec, [1, 2]);
1496 /// [`Clone`]: ../../std/clone/trait.Clone.html
1497 /// [`Default`]: ../../std/default/trait.Default.html
1498 /// [`resize_with`]: #method.resize_with
1499 #[stable(feature = "vec_resize", since = "1.5.0")]
1500 pub fn resize(&mut self, new_len: usize, value: T) {
1501 let len = self.len();
1504 self.extend_with(new_len - len, ExtendElement(value))
1506 self.truncate(new_len);
1510 /// Clones and appends all elements in a slice to the `Vec`.
1512 /// Iterates over the slice `other`, clones each element, and then appends
1513 /// it to this `Vec`. The `other` vector is traversed in-order.
1515 /// Note that this function is same as [`extend`] except that it is
1516 /// specialized to work with slices instead. If and when Rust gets
1517 /// specialization this function will likely be deprecated (but still
1523 /// let mut vec = vec![1];
1524 /// vec.extend_from_slice(&[2, 3, 4]);
1525 /// assert_eq!(vec, [1, 2, 3, 4]);
1528 /// [`extend`]: #method.extend
1529 #[stable(feature = "vec_extend_from_slice", since = "1.6.0")]
1530 pub fn extend_from_slice(&mut self, other: &[T]) {
1531 self.spec_extend(other.iter())
1535 impl<T: Default> Vec<T> {
1536 /// Resizes the `Vec` in-place so that `len` is equal to `new_len`.
1538 /// If `new_len` is greater than `len`, the `Vec` is extended by the
1539 /// difference, with each additional slot filled with [`Default::default()`].
1540 /// If `new_len` is less than `len`, the `Vec` is simply truncated.
1542 /// This method uses [`Default`] to create new values on every push. If
1543 /// you'd rather [`Clone`] a given value, use [`resize`].
1548 /// # #![allow(deprecated)]
1549 /// #![feature(vec_resize_default)]
1551 /// let mut vec = vec![1, 2, 3];
1552 /// vec.resize_default(5);
1553 /// assert_eq!(vec, [1, 2, 3, 0, 0]);
1555 /// let mut vec = vec![1, 2, 3, 4];
1556 /// vec.resize_default(2);
1557 /// assert_eq!(vec, [1, 2]);
1560 /// [`resize`]: #method.resize
1561 /// [`Default::default()`]: ../../std/default/trait.Default.html#tymethod.default
1562 /// [`Default`]: ../../std/default/trait.Default.html
1563 /// [`Clone`]: ../../std/clone/trait.Clone.html
1564 #[unstable(feature = "vec_resize_default", issue = "41758")]
1566 reason = "This is moving towards being removed in favor \
1567 of `.resize_with(Default::default)`. If you disagree, please comment \
1568 in the tracking issue.",
1571 pub fn resize_default(&mut self, new_len: usize) {
1572 let len = self.len();
1575 self.extend_with(new_len - len, ExtendDefault);
1577 self.truncate(new_len);
1582 // This code generalises `extend_with_{element,default}`.
1583 trait ExtendWith<T> {
1584 fn next(&mut self) -> T;
1588 struct ExtendElement<T>(T);
1589 impl<T: Clone> ExtendWith<T> for ExtendElement<T> {
1590 fn next(&mut self) -> T {
1593 fn last(self) -> T {
1598 struct ExtendDefault;
1599 impl<T: Default> ExtendWith<T> for ExtendDefault {
1600 fn next(&mut self) -> T {
1603 fn last(self) -> T {
1608 struct ExtendFunc<F>(F);
1609 impl<T, F: FnMut() -> T> ExtendWith<T> for ExtendFunc<F> {
1610 fn next(&mut self) -> T {
1613 fn last(mut self) -> T {
1619 /// Extend the vector by `n` values, using the given generator.
1620 fn extend_with<E: ExtendWith<T>>(&mut self, n: usize, mut value: E) {
1624 let mut ptr = self.as_mut_ptr().add(self.len());
1625 // Use SetLenOnDrop to work around bug where compiler
1626 // may not realize the store through `ptr` through self.set_len()
1628 let mut local_len = SetLenOnDrop::new(&mut self.len);
1630 // Write all elements except the last one
1632 ptr::write(ptr, value.next());
1633 ptr = ptr.offset(1);
1634 // Increment the length in every step in case next() panics
1635 local_len.increment_len(1);
1639 // We can write the last element directly without cloning needlessly
1640 ptr::write(ptr, value.last());
1641 local_len.increment_len(1);
1644 // len set by scope guard
1649 // Set the length of the vec when the `SetLenOnDrop` value goes out of scope.
1651 // The idea is: The length field in SetLenOnDrop is a local variable
1652 // that the optimizer will see does not alias with any stores through the Vec's data
1653 // pointer. This is a workaround for alias analysis issue #32155
1654 struct SetLenOnDrop<'a> {
1659 impl<'a> SetLenOnDrop<'a> {
1661 fn new(len: &'a mut usize) -> Self {
1662 SetLenOnDrop { local_len: *len, len }
1666 fn increment_len(&mut self, increment: usize) {
1667 self.local_len += increment;
1671 impl Drop for SetLenOnDrop<'_> {
1673 fn drop(&mut self) {
1674 *self.len = self.local_len;
1678 impl<T: PartialEq> Vec<T> {
1679 /// Removes consecutive repeated elements in the vector according to the
1680 /// [`PartialEq`] trait implementation.
1682 /// If the vector is sorted, this removes all duplicates.
1687 /// let mut vec = vec![1, 2, 2, 3, 2];
1691 /// assert_eq!(vec, [1, 2, 3, 2]);
1693 #[stable(feature = "rust1", since = "1.0.0")]
1695 pub fn dedup(&mut self) {
1696 self.dedup_by(|a, b| a == b)
1701 /// Removes the first instance of `item` from the vector if the item exists.
1706 /// # #![feature(vec_remove_item)]
1707 /// let mut vec = vec![1, 2, 3, 1];
1709 /// vec.remove_item(&1);
1711 /// assert_eq!(vec, vec![2, 3, 1]);
1713 #[unstable(feature = "vec_remove_item", reason = "recently added", issue = "40062")]
1714 pub fn remove_item<V>(&mut self, item: &V) -> Option<T>
1718 let pos = self.iter().position(|x| *x == *item)?;
1719 Some(self.remove(pos))
1723 ////////////////////////////////////////////////////////////////////////////////
1724 // Internal methods and functions
1725 ////////////////////////////////////////////////////////////////////////////////
1728 #[stable(feature = "rust1", since = "1.0.0")]
1729 pub fn from_elem<T: Clone>(elem: T, n: usize) -> Vec<T> {
1730 <T as SpecFromElem>::from_elem(elem, n)
1733 // Specialization trait used for Vec::from_elem
1734 trait SpecFromElem: Sized {
1735 fn from_elem(elem: Self, n: usize) -> Vec<Self>;
1738 impl<T: Clone> SpecFromElem for T {
1739 default fn from_elem(elem: Self, n: usize) -> Vec<Self> {
1740 let mut v = Vec::with_capacity(n);
1741 v.extend_with(n, ExtendElement(elem));
1746 impl SpecFromElem for u8 {
1748 fn from_elem(elem: u8, n: usize) -> Vec<u8> {
1750 return Vec { buf: RawVec::with_capacity_zeroed(n), len: n };
1753 let mut v = Vec::with_capacity(n);
1754 ptr::write_bytes(v.as_mut_ptr(), elem, n);
1761 impl<T: Clone + IsZero> SpecFromElem for T {
1763 fn from_elem(elem: T, n: usize) -> Vec<T> {
1765 return Vec { buf: RawVec::with_capacity_zeroed(n), len: n };
1767 let mut v = Vec::with_capacity(n);
1768 v.extend_with(n, ExtendElement(elem));
1773 unsafe trait IsZero {
1774 /// Whether this value is zero
1775 fn is_zero(&self) -> bool;
1778 macro_rules! impl_is_zero {
1779 ($t: ty, $is_zero: expr) => {
1780 unsafe impl IsZero for $t {
1782 fn is_zero(&self) -> bool {
1789 impl_is_zero!(i8, |x| x == 0);
1790 impl_is_zero!(i16, |x| x == 0);
1791 impl_is_zero!(i32, |x| x == 0);
1792 impl_is_zero!(i64, |x| x == 0);
1793 impl_is_zero!(i128, |x| x == 0);
1794 impl_is_zero!(isize, |x| x == 0);
1796 impl_is_zero!(u16, |x| x == 0);
1797 impl_is_zero!(u32, |x| x == 0);
1798 impl_is_zero!(u64, |x| x == 0);
1799 impl_is_zero!(u128, |x| x == 0);
1800 impl_is_zero!(usize, |x| x == 0);
1802 impl_is_zero!(bool, |x| x == false);
1803 impl_is_zero!(char, |x| x == '\0');
1805 impl_is_zero!(f32, |x: f32| x.to_bits() == 0);
1806 impl_is_zero!(f64, |x: f64| x.to_bits() == 0);
1808 unsafe impl<T> IsZero for *const T {
1810 fn is_zero(&self) -> bool {
1815 unsafe impl<T> IsZero for *mut T {
1817 fn is_zero(&self) -> bool {
1822 // `Option<&T>`, `Option<&mut T>` and `Option<Box<T>>` are guaranteed to represent `None` as null.
1823 // For fat pointers, the bytes that would be the pointer metadata in the `Some` variant
1824 // are padding in the `None` variant, so ignoring them and zero-initializing instead is ok.
1826 unsafe impl<T: ?Sized> IsZero for Option<&T> {
1828 fn is_zero(&self) -> bool {
1833 unsafe impl<T: ?Sized> IsZero for Option<&mut T> {
1835 fn is_zero(&self) -> bool {
1840 unsafe impl<T: ?Sized> IsZero for Option<Box<T>> {
1842 fn is_zero(&self) -> bool {
1847 ////////////////////////////////////////////////////////////////////////////////
1848 // Common trait implementations for Vec
1849 ////////////////////////////////////////////////////////////////////////////////
1851 #[stable(feature = "rust1", since = "1.0.0")]
1852 impl<T: Clone> Clone for Vec<T> {
1854 fn clone(&self) -> Vec<T> {
1855 <[T]>::to_vec(&**self)
1858 // HACK(japaric): with cfg(test) the inherent `[T]::to_vec` method, which is
1859 // required for this method definition, is not available. Instead use the
1860 // `slice::to_vec` function which is only available with cfg(test)
1861 // NB see the slice::hack module in slice.rs for more information
1863 fn clone(&self) -> Vec<T> {
1864 crate::slice::to_vec(&**self)
1867 fn clone_from(&mut self, other: &Vec<T>) {
1868 other.as_slice().clone_into(self);
1872 #[stable(feature = "rust1", since = "1.0.0")]
1873 impl<T: Hash> Hash for Vec<T> {
1875 fn hash<H: hash::Hasher>(&self, state: &mut H) {
1876 Hash::hash(&**self, state)
1880 #[stable(feature = "rust1", since = "1.0.0")]
1881 #[rustc_on_unimplemented(
1882 message = "vector indices are of type `usize` or ranges of `usize`",
1883 label = "vector indices are of type `usize` or ranges of `usize`"
1885 impl<T, I: SliceIndex<[T]>> Index<I> for Vec<T> {
1886 type Output = I::Output;
1889 fn index(&self, index: I) -> &Self::Output {
1890 Index::index(&**self, index)
1894 #[stable(feature = "rust1", since = "1.0.0")]
1895 #[rustc_on_unimplemented(
1896 message = "vector indices are of type `usize` or ranges of `usize`",
1897 label = "vector indices are of type `usize` or ranges of `usize`"
1899 impl<T, I: SliceIndex<[T]>> IndexMut<I> for Vec<T> {
1901 fn index_mut(&mut self, index: I) -> &mut Self::Output {
1902 IndexMut::index_mut(&mut **self, index)
1906 #[stable(feature = "rust1", since = "1.0.0")]
1907 impl<T> ops::Deref for Vec<T> {
1910 fn deref(&self) -> &[T] {
1911 unsafe { slice::from_raw_parts(self.as_ptr(), self.len) }
1915 #[stable(feature = "rust1", since = "1.0.0")]
1916 impl<T> ops::DerefMut for Vec<T> {
1917 fn deref_mut(&mut self) -> &mut [T] {
1918 unsafe { slice::from_raw_parts_mut(self.as_mut_ptr(), self.len) }
1922 #[stable(feature = "rust1", since = "1.0.0")]
1923 impl<T> FromIterator<T> for Vec<T> {
1925 fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Vec<T> {
1926 <Self as SpecExtend<T, I::IntoIter>>::from_iter(iter.into_iter())
1930 #[stable(feature = "rust1", since = "1.0.0")]
1931 impl<T> IntoIterator for Vec<T> {
1933 type IntoIter = IntoIter<T>;
1935 /// Creates a consuming iterator, that is, one that moves each value out of
1936 /// the vector (from start to end). The vector cannot be used after calling
1942 /// let v = vec!["a".to_string(), "b".to_string()];
1943 /// for s in v.into_iter() {
1944 /// // s has type String, not &String
1945 /// println!("{}", s);
1949 fn into_iter(mut self) -> IntoIter<T> {
1951 let begin = self.as_mut_ptr();
1952 let end = if mem::size_of::<T>() == 0 {
1953 arith_offset(begin as *const i8, self.len() as isize) as *const T
1955 begin.add(self.len()) as *const T
1957 let cap = self.buf.capacity();
1960 buf: NonNull::new_unchecked(begin),
1961 phantom: PhantomData,
1970 #[stable(feature = "rust1", since = "1.0.0")]
1971 impl<'a, T> IntoIterator for &'a Vec<T> {
1973 type IntoIter = slice::Iter<'a, T>;
1975 fn into_iter(self) -> slice::Iter<'a, T> {
1980 #[stable(feature = "rust1", since = "1.0.0")]
1981 impl<'a, T> IntoIterator for &'a mut Vec<T> {
1982 type Item = &'a mut T;
1983 type IntoIter = slice::IterMut<'a, T>;
1985 fn into_iter(self) -> slice::IterMut<'a, T> {
1990 #[stable(feature = "rust1", since = "1.0.0")]
1991 impl<T> Extend<T> for Vec<T> {
1993 fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
1994 <Self as SpecExtend<T, I::IntoIter>>::spec_extend(self, iter.into_iter())
1998 // Specialization trait used for Vec::from_iter and Vec::extend
1999 trait SpecExtend<T, I> {
2000 fn from_iter(iter: I) -> Self;
2001 fn spec_extend(&mut self, iter: I);
2004 impl<T, I> SpecExtend<T, I> for Vec<T>
2006 I: Iterator<Item = T>,
2008 default fn from_iter(mut iterator: I) -> Self {
2009 // Unroll the first iteration, as the vector is going to be
2010 // expanded on this iteration in every case when the iterable is not
2011 // empty, but the loop in extend_desugared() is not going to see the
2012 // vector being full in the few subsequent loop iterations.
2013 // So we get better branch prediction.
2014 let mut vector = match iterator.next() {
2015 None => return Vec::new(),
2017 let (lower, _) = iterator.size_hint();
2018 let mut vector = Vec::with_capacity(lower.saturating_add(1));
2020 ptr::write(vector.get_unchecked_mut(0), element);
2026 <Vec<T> as SpecExtend<T, I>>::spec_extend(&mut vector, iterator);
2030 default fn spec_extend(&mut self, iter: I) {
2031 self.extend_desugared(iter)
2035 impl<T, I> SpecExtend<T, I> for Vec<T>
2037 I: TrustedLen<Item = T>,
2039 default fn from_iter(iterator: I) -> Self {
2040 let mut vector = Vec::new();
2041 vector.spec_extend(iterator);
2045 default fn spec_extend(&mut self, iterator: I) {
2046 // This is the case for a TrustedLen iterator.
2047 let (low, high) = iterator.size_hint();
2048 if let Some(high_value) = high {
2052 "TrustedLen iterator's size hint is not exact: {:?}",
2056 if let Some(additional) = high {
2057 self.reserve(additional);
2059 let mut ptr = self.as_mut_ptr().add(self.len());
2060 let mut local_len = SetLenOnDrop::new(&mut self.len);
2061 iterator.for_each(move |element| {
2062 ptr::write(ptr, element);
2063 ptr = ptr.offset(1);
2064 // NB can't overflow since we would have had to alloc the address space
2065 local_len.increment_len(1);
2069 self.extend_desugared(iterator)
2074 impl<T> SpecExtend<T, IntoIter<T>> for Vec<T> {
2075 fn from_iter(iterator: IntoIter<T>) -> Self {
2076 // A common case is passing a vector into a function which immediately
2077 // re-collects into a vector. We can short circuit this if the IntoIter
2078 // has not been advanced at all.
2079 if iterator.buf.as_ptr() as *const _ == iterator.ptr {
2081 let vec = Vec::from_raw_parts(iterator.buf.as_ptr(), iterator.len(), iterator.cap);
2082 mem::forget(iterator);
2086 let mut vector = Vec::new();
2087 vector.spec_extend(iterator);
2092 fn spec_extend(&mut self, mut iterator: IntoIter<T>) {
2094 self.append_elements(iterator.as_slice() as _);
2096 iterator.ptr = iterator.end;
2100 impl<'a, T: 'a, I> SpecExtend<&'a T, I> for Vec<T>
2102 I: Iterator<Item = &'a T>,
2105 default fn from_iter(iterator: I) -> Self {
2106 SpecExtend::from_iter(iterator.cloned())
2109 default fn spec_extend(&mut self, iterator: I) {
2110 self.spec_extend(iterator.cloned())
2114 impl<'a, T: 'a> SpecExtend<&'a T, slice::Iter<'a, T>> for Vec<T>
2118 fn spec_extend(&mut self, iterator: slice::Iter<'a, T>) {
2119 let slice = iterator.as_slice();
2120 self.reserve(slice.len());
2122 let len = self.len();
2123 self.set_len(len + slice.len());
2124 self.get_unchecked_mut(len..).copy_from_slice(slice);
2130 fn extend_desugared<I: Iterator<Item = T>>(&mut self, mut iterator: I) {
2131 // This is the case for a general iterator.
2133 // This function should be the moral equivalent of:
2135 // for item in iterator {
2138 while let Some(element) = iterator.next() {
2139 let len = self.len();
2140 if len == self.capacity() {
2141 let (lower, _) = iterator.size_hint();
2142 self.reserve(lower.saturating_add(1));
2145 ptr::write(self.get_unchecked_mut(len), element);
2146 // NB can't overflow since we would have had to alloc the address space
2147 self.set_len(len + 1);
2152 /// Creates a splicing iterator that replaces the specified range in the vector
2153 /// with the given `replace_with` iterator and yields the removed items.
2154 /// `replace_with` does not need to be the same length as `range`.
2156 /// The element range is removed even if the iterator is not consumed until the end.
2158 /// It is unspecified how many elements are removed from the vector
2159 /// if the `Splice` value is leaked.
2161 /// The input iterator `replace_with` is only consumed when the `Splice` value is dropped.
2163 /// This is optimal if:
2165 /// * The tail (elements in the vector after `range`) is empty,
2166 /// * or `replace_with` yields fewer elements than `range`’s length
2167 /// * or the lower bound of its `size_hint()` is exact.
2169 /// Otherwise, a temporary vector is allocated and the tail is moved twice.
2173 /// Panics if the starting point is greater than the end point or if
2174 /// the end point is greater than the length of the vector.
2179 /// let mut v = vec![1, 2, 3];
2180 /// let new = [7, 8];
2181 /// let u: Vec<_> = v.splice(..2, new.iter().cloned()).collect();
2182 /// assert_eq!(v, &[7, 8, 3]);
2183 /// assert_eq!(u, &[1, 2]);
2186 #[stable(feature = "vec_splice", since = "1.21.0")]
2187 pub fn splice<R, I>(&mut self, range: R, replace_with: I) -> Splice<'_, I::IntoIter>
2189 R: RangeBounds<usize>,
2190 I: IntoIterator<Item = T>,
2192 Splice { drain: self.drain(range), replace_with: replace_with.into_iter() }
2195 /// Creates an iterator which uses a closure to determine if an element should be removed.
2197 /// If the closure returns true, then the element is removed and yielded.
2198 /// If the closure returns false, the element will remain in the vector and will not be yielded
2199 /// by the iterator.
2201 /// Using this method is equivalent to the following code:
2204 /// # let some_predicate = |x: &mut i32| { *x == 2 || *x == 3 || *x == 6 };
2205 /// # let mut vec = vec![1, 2, 3, 4, 5, 6];
2207 /// while i != vec.len() {
2208 /// if some_predicate(&mut vec[i]) {
2209 /// let val = vec.remove(i);
2210 /// // your code here
2216 /// # assert_eq!(vec, vec![1, 4, 5]);
2219 /// But `drain_filter` is easier to use. `drain_filter` is also more efficient,
2220 /// because it can backshift the elements of the array in bulk.
2222 /// Note that `drain_filter` also lets you mutate every element in the filter closure,
2223 /// regardless of whether you choose to keep or remove it.
2228 /// Splitting an array into evens and odds, reusing the original allocation:
2231 /// #![feature(drain_filter)]
2232 /// let mut numbers = vec![1, 2, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15];
2234 /// let evens = numbers.drain_filter(|x| *x % 2 == 0).collect::<Vec<_>>();
2235 /// let odds = numbers;
2237 /// assert_eq!(evens, vec![2, 4, 6, 8, 14]);
2238 /// assert_eq!(odds, vec![1, 3, 5, 9, 11, 13, 15]);
2240 #[unstable(feature = "drain_filter", reason = "recently added", issue = "43244")]
2241 pub fn drain_filter<F>(&mut self, filter: F) -> DrainFilter<'_, T, F>
2243 F: FnMut(&mut T) -> bool,
2245 let old_len = self.len();
2247 // Guard against us getting leaked (leak amplification)
2252 DrainFilter { vec: self, idx: 0, del: 0, old_len, pred: filter, panic_flag: false }
2256 /// Extend implementation that copies elements out of references before pushing them onto the Vec.
2258 /// This implementation is specialized for slice iterators, where it uses [`copy_from_slice`] to
2259 /// append the entire slice at once.
2261 /// [`copy_from_slice`]: ../../std/primitive.slice.html#method.copy_from_slice
2262 #[stable(feature = "extend_ref", since = "1.2.0")]
2263 impl<'a, T: 'a + Copy> Extend<&'a T> for Vec<T> {
2264 fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I) {
2265 self.spec_extend(iter.into_iter())
2269 macro_rules! __impl_slice_eq1 {
2270 ([$($vars:tt)*] $lhs:ty, $rhs:ty, $($constraints:tt)*) => {
2271 #[stable(feature = "rust1", since = "1.0.0")]
2272 impl<A, B, $($vars)*> PartialEq<$rhs> for $lhs
2278 fn eq(&self, other: &$rhs) -> bool { self[..] == other[..] }
2280 fn ne(&self, other: &$rhs) -> bool { self[..] != other[..] }
2285 __impl_slice_eq1! { [] Vec<A>, Vec<B>, }
2286 __impl_slice_eq1! { [] Vec<A>, &[B], }
2287 __impl_slice_eq1! { [] Vec<A>, &mut [B], }
2288 __impl_slice_eq1! { [] Cow<'_, [A]>, &[B], A: Clone }
2289 __impl_slice_eq1! { [] Cow<'_, [A]>, &mut [B], A: Clone }
2290 __impl_slice_eq1! { [] Cow<'_, [A]>, Vec<B>, A: Clone }
2291 __impl_slice_eq1! { [const N: usize] Vec<A>, [B; N], [B; N]: LengthAtMost32 }
2292 __impl_slice_eq1! { [const N: usize] Vec<A>, &[B; N], [B; N]: LengthAtMost32 }
2294 // NOTE: some less important impls are omitted to reduce code bloat
2295 // FIXME(Centril): Reconsider this?
2296 //__impl_slice_eq1! { [const N: usize] Vec<A>, &mut [B; N], [B; N]: LengthAtMost32 }
2297 //__impl_slice_eq1! { [const N: usize] Cow<'a, [A]>, [B; N], [B; N]: LengthAtMost32 }
2298 //__impl_slice_eq1! { [const N: usize] Cow<'a, [A]>, &[B; N], [B; N]: LengthAtMost32 }
2299 //__impl_slice_eq1! { [const N: usize] Cow<'a, [A]>, &mut [B; N], [B; N]: LengthAtMost32 }
2301 /// Implements comparison of vectors, lexicographically.
2302 #[stable(feature = "rust1", since = "1.0.0")]
2303 impl<T: PartialOrd> PartialOrd for Vec<T> {
2305 fn partial_cmp(&self, other: &Vec<T>) -> Option<Ordering> {
2306 PartialOrd::partial_cmp(&**self, &**other)
2310 #[stable(feature = "rust1", since = "1.0.0")]
2311 impl<T: Eq> Eq for Vec<T> {}
2313 /// Implements ordering of vectors, lexicographically.
2314 #[stable(feature = "rust1", since = "1.0.0")]
2315 impl<T: Ord> Ord for Vec<T> {
2317 fn cmp(&self, other: &Vec<T>) -> Ordering {
2318 Ord::cmp(&**self, &**other)
2322 #[stable(feature = "rust1", since = "1.0.0")]
2323 unsafe impl<#[may_dangle] T> Drop for Vec<T> {
2324 fn drop(&mut self) {
2327 ptr::drop_in_place(&mut self[..]);
2329 // RawVec handles deallocation
2333 #[stable(feature = "rust1", since = "1.0.0")]
2334 impl<T> Default for Vec<T> {
2335 /// Creates an empty `Vec<T>`.
2336 fn default() -> Vec<T> {
2341 #[stable(feature = "rust1", since = "1.0.0")]
2342 impl<T: fmt::Debug> fmt::Debug for Vec<T> {
2343 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2344 fmt::Debug::fmt(&**self, f)
2348 #[stable(feature = "rust1", since = "1.0.0")]
2349 impl<T> AsRef<Vec<T>> for Vec<T> {
2350 fn as_ref(&self) -> &Vec<T> {
2355 #[stable(feature = "vec_as_mut", since = "1.5.0")]
2356 impl<T> AsMut<Vec<T>> for Vec<T> {
2357 fn as_mut(&mut self) -> &mut Vec<T> {
2362 #[stable(feature = "rust1", since = "1.0.0")]
2363 impl<T> AsRef<[T]> for Vec<T> {
2364 fn as_ref(&self) -> &[T] {
2369 #[stable(feature = "vec_as_mut", since = "1.5.0")]
2370 impl<T> AsMut<[T]> for Vec<T> {
2371 fn as_mut(&mut self) -> &mut [T] {
2376 #[stable(feature = "rust1", since = "1.0.0")]
2377 impl<T: Clone> From<&[T]> for Vec<T> {
2379 fn from(s: &[T]) -> Vec<T> {
2383 fn from(s: &[T]) -> Vec<T> {
2384 crate::slice::to_vec(s)
2388 #[stable(feature = "vec_from_mut", since = "1.19.0")]
2389 impl<T: Clone> From<&mut [T]> for Vec<T> {
2391 fn from(s: &mut [T]) -> Vec<T> {
2395 fn from(s: &mut [T]) -> Vec<T> {
2396 crate::slice::to_vec(s)
2400 #[stable(feature = "vec_from_cow_slice", since = "1.14.0")]
2401 impl<'a, T> From<Cow<'a, [T]>> for Vec<T>
2403 [T]: ToOwned<Owned = Vec<T>>,
2405 fn from(s: Cow<'a, [T]>) -> Vec<T> {
2410 // note: test pulls in libstd, which causes errors here
2412 #[stable(feature = "vec_from_box", since = "1.18.0")]
2413 impl<T> From<Box<[T]>> for Vec<T> {
2414 fn from(s: Box<[T]>) -> Vec<T> {
2419 // note: test pulls in libstd, which causes errors here
2421 #[stable(feature = "box_from_vec", since = "1.20.0")]
2422 impl<T> From<Vec<T>> for Box<[T]> {
2423 fn from(v: Vec<T>) -> Box<[T]> {
2424 v.into_boxed_slice()
2428 #[stable(feature = "rust1", since = "1.0.0")]
2429 impl From<&str> for Vec<u8> {
2430 fn from(s: &str) -> Vec<u8> {
2431 From::from(s.as_bytes())
2435 ////////////////////////////////////////////////////////////////////////////////
2437 ////////////////////////////////////////////////////////////////////////////////
2439 #[stable(feature = "cow_from_vec", since = "1.8.0")]
2440 impl<'a, T: Clone> From<&'a [T]> for Cow<'a, [T]> {
2441 fn from(s: &'a [T]) -> Cow<'a, [T]> {
2446 #[stable(feature = "cow_from_vec", since = "1.8.0")]
2447 impl<'a, T: Clone> From<Vec<T>> for Cow<'a, [T]> {
2448 fn from(v: Vec<T>) -> Cow<'a, [T]> {
2453 #[stable(feature = "cow_from_vec_ref", since = "1.28.0")]
2454 impl<'a, T: Clone> From<&'a Vec<T>> for Cow<'a, [T]> {
2455 fn from(v: &'a Vec<T>) -> Cow<'a, [T]> {
2456 Cow::Borrowed(v.as_slice())
2460 #[stable(feature = "rust1", since = "1.0.0")]
2461 impl<'a, T> FromIterator<T> for Cow<'a, [T]>
2465 fn from_iter<I: IntoIterator<Item = T>>(it: I) -> Cow<'a, [T]> {
2466 Cow::Owned(FromIterator::from_iter(it))
2470 ////////////////////////////////////////////////////////////////////////////////
2472 ////////////////////////////////////////////////////////////////////////////////
2474 /// An iterator that moves out of a vector.
2476 /// This `struct` is created by the `into_iter` method on [`Vec`] (provided
2477 /// by the [`IntoIterator`] trait).
2479 /// [`Vec`]: struct.Vec.html
2480 /// [`IntoIterator`]: ../../std/iter/trait.IntoIterator.html
2481 #[stable(feature = "rust1", since = "1.0.0")]
2482 pub struct IntoIter<T> {
2484 phantom: PhantomData<T>,
2490 #[stable(feature = "vec_intoiter_debug", since = "1.13.0")]
2491 impl<T: fmt::Debug> fmt::Debug for IntoIter<T> {
2492 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2493 f.debug_tuple("IntoIter").field(&self.as_slice()).finish()
2497 impl<T> IntoIter<T> {
2498 /// Returns the remaining items of this iterator as a slice.
2503 /// let vec = vec!['a', 'b', 'c'];
2504 /// let mut into_iter = vec.into_iter();
2505 /// assert_eq!(into_iter.as_slice(), &['a', 'b', 'c']);
2506 /// let _ = into_iter.next().unwrap();
2507 /// assert_eq!(into_iter.as_slice(), &['b', 'c']);
2509 #[stable(feature = "vec_into_iter_as_slice", since = "1.15.0")]
2510 pub fn as_slice(&self) -> &[T] {
2511 unsafe { slice::from_raw_parts(self.ptr, self.len()) }
2514 /// Returns the remaining items of this iterator as a mutable slice.
2519 /// let vec = vec!['a', 'b', 'c'];
2520 /// let mut into_iter = vec.into_iter();
2521 /// assert_eq!(into_iter.as_slice(), &['a', 'b', 'c']);
2522 /// into_iter.as_mut_slice()[2] = 'z';
2523 /// assert_eq!(into_iter.next().unwrap(), 'a');
2524 /// assert_eq!(into_iter.next().unwrap(), 'b');
2525 /// assert_eq!(into_iter.next().unwrap(), 'z');
2527 #[stable(feature = "vec_into_iter_as_slice", since = "1.15.0")]
2528 pub fn as_mut_slice(&mut self) -> &mut [T] {
2529 unsafe { slice::from_raw_parts_mut(self.ptr as *mut T, self.len()) }
2533 #[stable(feature = "rust1", since = "1.0.0")]
2534 unsafe impl<T: Send> Send for IntoIter<T> {}
2535 #[stable(feature = "rust1", since = "1.0.0")]
2536 unsafe impl<T: Sync> Sync for IntoIter<T> {}
2538 #[stable(feature = "rust1", since = "1.0.0")]
2539 impl<T> Iterator for IntoIter<T> {
2543 fn next(&mut self) -> Option<T> {
2545 if self.ptr as *const _ == self.end {
2548 if mem::size_of::<T>() == 0 {
2549 // purposefully don't use 'ptr.offset' because for
2550 // vectors with 0-size elements this would return the
2552 self.ptr = arith_offset(self.ptr as *const i8, 1) as *mut T;
2554 // Make up a value of this ZST.
2558 self.ptr = self.ptr.offset(1);
2560 Some(ptr::read(old))
2567 fn size_hint(&self) -> (usize, Option<usize>) {
2568 let exact = if mem::size_of::<T>() == 0 {
2569 (self.end as usize).wrapping_sub(self.ptr as usize)
2571 unsafe { self.end.offset_from(self.ptr) as usize }
2573 (exact, Some(exact))
2577 fn count(self) -> usize {
2582 #[stable(feature = "rust1", since = "1.0.0")]
2583 impl<T> DoubleEndedIterator for IntoIter<T> {
2585 fn next_back(&mut self) -> Option<T> {
2587 if self.end == self.ptr {
2590 if mem::size_of::<T>() == 0 {
2591 // See above for why 'ptr.offset' isn't used
2592 self.end = arith_offset(self.end as *const i8, -1) as *mut T;
2594 // Make up a value of this ZST.
2597 self.end = self.end.offset(-1);
2599 Some(ptr::read(self.end))
2606 #[stable(feature = "rust1", since = "1.0.0")]
2607 impl<T> ExactSizeIterator for IntoIter<T> {
2608 fn is_empty(&self) -> bool {
2609 self.ptr == self.end
2613 #[stable(feature = "fused", since = "1.26.0")]
2614 impl<T> FusedIterator for IntoIter<T> {}
2616 #[unstable(feature = "trusted_len", issue = "37572")]
2617 unsafe impl<T> TrustedLen for IntoIter<T> {}
2619 #[stable(feature = "vec_into_iter_clone", since = "1.8.0")]
2620 impl<T: Clone> Clone for IntoIter<T> {
2621 fn clone(&self) -> IntoIter<T> {
2622 self.as_slice().to_owned().into_iter()
2626 #[stable(feature = "rust1", since = "1.0.0")]
2627 unsafe impl<#[may_dangle] T> Drop for IntoIter<T> {
2628 fn drop(&mut self) {
2629 struct DropGuard<'a, T>(&'a mut IntoIter<T>);
2631 impl<T> Drop for DropGuard<'_, T> {
2632 fn drop(&mut self) {
2633 // RawVec handles deallocation
2634 let _ = unsafe { RawVec::from_raw_parts(self.0.buf.as_ptr(), self.0.cap) };
2638 let guard = DropGuard(self);
2639 // destroy the remaining elements
2641 ptr::drop_in_place(guard.0.as_mut_slice());
2643 // now `guard` will be dropped and do the rest
2647 /// A draining iterator for `Vec<T>`.
2649 /// This `struct` is created by the [`drain`] method on [`Vec`].
2651 /// [`drain`]: struct.Vec.html#method.drain
2652 /// [`Vec`]: struct.Vec.html
2653 #[stable(feature = "drain", since = "1.6.0")]
2654 pub struct Drain<'a, T: 'a> {
2655 /// Index of tail to preserve
2659 /// Current remaining range to remove
2660 iter: slice::Iter<'a, T>,
2661 vec: NonNull<Vec<T>>,
2664 #[stable(feature = "collection_debug", since = "1.17.0")]
2665 impl<T: fmt::Debug> fmt::Debug for Drain<'_, T> {
2666 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2667 f.debug_tuple("Drain").field(&self.iter.as_slice()).finish()
2671 impl<'a, T> Drain<'a, T> {
2672 /// Returns the remaining items of this iterator as a slice.
2677 /// # #![feature(vec_drain_as_slice)]
2678 /// let mut vec = vec!['a', 'b', 'c'];
2679 /// let mut drain = vec.drain(..);
2680 /// assert_eq!(drain.as_slice(), &['a', 'b', 'c']);
2681 /// let _ = drain.next().unwrap();
2682 /// assert_eq!(drain.as_slice(), &['b', 'c']);
2684 #[unstable(feature = "vec_drain_as_slice", reason = "recently added", issue = "58957")]
2685 pub fn as_slice(&self) -> &[T] {
2686 self.iter.as_slice()
2690 #[stable(feature = "drain", since = "1.6.0")]
2691 unsafe impl<T: Sync> Sync for Drain<'_, T> {}
2692 #[stable(feature = "drain", since = "1.6.0")]
2693 unsafe impl<T: Send> Send for Drain<'_, T> {}
2695 #[stable(feature = "drain", since = "1.6.0")]
2696 impl<T> Iterator for Drain<'_, T> {
2700 fn next(&mut self) -> Option<T> {
2701 self.iter.next().map(|elt| unsafe { ptr::read(elt as *const _) })
2704 fn size_hint(&self) -> (usize, Option<usize>) {
2705 self.iter.size_hint()
2709 #[stable(feature = "drain", since = "1.6.0")]
2710 impl<T> DoubleEndedIterator for Drain<'_, T> {
2712 fn next_back(&mut self) -> Option<T> {
2713 self.iter.next_back().map(|elt| unsafe { ptr::read(elt as *const _) })
2717 #[stable(feature = "drain", since = "1.6.0")]
2718 impl<T> Drop for Drain<'_, T> {
2719 fn drop(&mut self) {
2720 /// Continues dropping the remaining elements in the `Drain`, then moves back the
2721 /// un-`Drain`ed elements to restore the original `Vec`.
2722 struct DropGuard<'r, 'a, T>(&'r mut Drain<'a, T>);
2724 impl<'r, 'a, T> Drop for DropGuard<'r, 'a, T> {
2725 fn drop(&mut self) {
2726 // Continue the same loop we have below. If the loop already finished, this does
2728 self.0.for_each(drop);
2730 if self.0.tail_len > 0 {
2732 let source_vec = self.0.vec.as_mut();
2733 // memmove back untouched tail, update to new length
2734 let start = source_vec.len();
2735 let tail = self.0.tail_start;
2737 let src = source_vec.as_ptr().add(tail);
2738 let dst = source_vec.as_mut_ptr().add(start);
2739 ptr::copy(src, dst, self.0.tail_len);
2741 source_vec.set_len(start + self.0.tail_len);
2747 // exhaust self first
2748 while let Some(item) = self.next() {
2749 let guard = DropGuard(self);
2754 // Drop a `DropGuard` to move back the non-drained tail of `self`.
2759 #[stable(feature = "drain", since = "1.6.0")]
2760 impl<T> ExactSizeIterator for Drain<'_, T> {
2761 fn is_empty(&self) -> bool {
2762 self.iter.is_empty()
2766 #[unstable(feature = "trusted_len", issue = "37572")]
2767 unsafe impl<T> TrustedLen for Drain<'_, T> {}
2769 #[stable(feature = "fused", since = "1.26.0")]
2770 impl<T> FusedIterator for Drain<'_, T> {}
2772 /// A splicing iterator for `Vec`.
2774 /// This struct is created by the [`splice()`] method on [`Vec`]. See its
2775 /// documentation for more.
2777 /// [`splice()`]: struct.Vec.html#method.splice
2778 /// [`Vec`]: struct.Vec.html
2780 #[stable(feature = "vec_splice", since = "1.21.0")]
2781 pub struct Splice<'a, I: Iterator + 'a> {
2782 drain: Drain<'a, I::Item>,
2786 #[stable(feature = "vec_splice", since = "1.21.0")]
2787 impl<I: Iterator> Iterator for Splice<'_, I> {
2788 type Item = I::Item;
2790 fn next(&mut self) -> Option<Self::Item> {
2794 fn size_hint(&self) -> (usize, Option<usize>) {
2795 self.drain.size_hint()
2799 #[stable(feature = "vec_splice", since = "1.21.0")]
2800 impl<I: Iterator> DoubleEndedIterator for Splice<'_, I> {
2801 fn next_back(&mut self) -> Option<Self::Item> {
2802 self.drain.next_back()
2806 #[stable(feature = "vec_splice", since = "1.21.0")]
2807 impl<I: Iterator> ExactSizeIterator for Splice<'_, I> {}
2809 #[stable(feature = "vec_splice", since = "1.21.0")]
2810 impl<I: Iterator> Drop for Splice<'_, I> {
2811 fn drop(&mut self) {
2812 self.drain.by_ref().for_each(drop);
2815 if self.drain.tail_len == 0 {
2816 self.drain.vec.as_mut().extend(self.replace_with.by_ref());
2820 // First fill the range left by drain().
2821 if !self.drain.fill(&mut self.replace_with) {
2825 // There may be more elements. Use the lower bound as an estimate.
2826 // FIXME: Is the upper bound a better guess? Or something else?
2827 let (lower_bound, _upper_bound) = self.replace_with.size_hint();
2828 if lower_bound > 0 {
2829 self.drain.move_tail(lower_bound);
2830 if !self.drain.fill(&mut self.replace_with) {
2835 // Collect any remaining elements.
2836 // This is a zero-length vector which does not allocate if `lower_bound` was exact.
2837 let mut collected = self.replace_with.by_ref().collect::<Vec<I::Item>>().into_iter();
2838 // Now we have an exact count.
2839 if collected.len() > 0 {
2840 self.drain.move_tail(collected.len());
2841 let filled = self.drain.fill(&mut collected);
2842 debug_assert!(filled);
2843 debug_assert_eq!(collected.len(), 0);
2846 // Let `Drain::drop` move the tail back if necessary and restore `vec.len`.
2850 /// Private helper methods for `Splice::drop`
2851 impl<T> Drain<'_, T> {
2852 /// The range from `self.vec.len` to `self.tail_start` contains elements
2853 /// that have been moved out.
2854 /// Fill that range as much as possible with new elements from the `replace_with` iterator.
2855 /// Returns `true` if we filled the entire range. (`replace_with.next()` didn’t return `None`.)
2856 unsafe fn fill<I: Iterator<Item = T>>(&mut self, replace_with: &mut I) -> bool {
2857 let vec = self.vec.as_mut();
2858 let range_start = vec.len;
2859 let range_end = self.tail_start;
2861 slice::from_raw_parts_mut(vec.as_mut_ptr().add(range_start), range_end - range_start);
2863 for place in range_slice {
2864 if let Some(new_item) = replace_with.next() {
2865 ptr::write(place, new_item);
2874 /// Makes room for inserting more elements before the tail.
2875 unsafe fn move_tail(&mut self, extra_capacity: usize) {
2876 let vec = self.vec.as_mut();
2877 let used_capacity = self.tail_start + self.tail_len;
2878 vec.buf.reserve(used_capacity, extra_capacity);
2880 let new_tail_start = self.tail_start + extra_capacity;
2881 let src = vec.as_ptr().add(self.tail_start);
2882 let dst = vec.as_mut_ptr().add(new_tail_start);
2883 ptr::copy(src, dst, self.tail_len);
2884 self.tail_start = new_tail_start;
2888 /// An iterator produced by calling `drain_filter` on Vec.
2889 #[unstable(feature = "drain_filter", reason = "recently added", issue = "43244")]
2891 pub struct DrainFilter<'a, T, F>
2893 F: FnMut(&mut T) -> bool,
2895 vec: &'a mut Vec<T>,
2896 /// The index of the item that will be inspected by the next call to `next`.
2898 /// The number of items that have been drained (removed) thus far.
2900 /// The original length of `vec` prior to draining.
2902 /// The filter test predicate.
2904 /// A flag that indicates a panic has occurred in the filter test prodicate.
2905 /// This is used as a hint in the drop implementation to prevent consumption
2906 /// of the remainder of the `DrainFilter`. Any unprocessed items will be
2907 /// backshifted in the `vec`, but no further items will be dropped or
2908 /// tested by the filter predicate.
2912 #[unstable(feature = "drain_filter", reason = "recently added", issue = "43244")]
2913 impl<T, F> Iterator for DrainFilter<'_, T, F>
2915 F: FnMut(&mut T) -> bool,
2919 fn next(&mut self) -> Option<T> {
2921 while self.idx < self.old_len {
2923 let v = slice::from_raw_parts_mut(self.vec.as_mut_ptr(), self.old_len);
2924 self.panic_flag = true;
2925 let drained = (self.pred)(&mut v[i]);
2926 self.panic_flag = false;
2927 // Update the index *after* the predicate is called. If the index
2928 // is updated prior and the predicate panics, the element at this
2929 // index would be leaked.
2933 return Some(ptr::read(&v[i]));
2934 } else if self.del > 0 {
2936 let src: *const T = &v[i];
2937 let dst: *mut T = &mut v[i - del];
2938 ptr::copy_nonoverlapping(src, dst, 1);
2945 fn size_hint(&self) -> (usize, Option<usize>) {
2946 (0, Some(self.old_len - self.idx))
2950 #[unstable(feature = "drain_filter", reason = "recently added", issue = "43244")]
2951 impl<T, F> Drop for DrainFilter<'_, T, F>
2953 F: FnMut(&mut T) -> bool,
2955 fn drop(&mut self) {
2956 struct BackshiftOnDrop<'a, 'b, T, F>
2958 F: FnMut(&mut T) -> bool,
2960 drain: &'b mut DrainFilter<'a, T, F>,
2963 impl<'a, 'b, T, F> Drop for BackshiftOnDrop<'a, 'b, T, F>
2965 F: FnMut(&mut T) -> bool,
2967 fn drop(&mut self) {
2969 if self.drain.idx < self.drain.old_len && self.drain.del > 0 {
2970 // This is a pretty messed up state, and there isn't really an
2971 // obviously right thing to do. We don't want to keep trying
2972 // to execute `pred`, so we just backshift all the unprocessed
2973 // elements and tell the vec that they still exist. The backshift
2974 // is required to prevent a double-drop of the last successfully
2975 // drained item prior to a panic in the predicate.
2976 let ptr = self.drain.vec.as_mut_ptr();
2977 let src = ptr.add(self.drain.idx);
2978 let dst = src.sub(self.drain.del);
2979 let tail_len = self.drain.old_len - self.drain.idx;
2980 src.copy_to(dst, tail_len);
2982 self.drain.vec.set_len(self.drain.old_len - self.drain.del);
2987 let backshift = BackshiftOnDrop { drain: self };
2989 // Attempt to consume any remaining elements if the filter predicate
2990 // has not yet panicked. We'll backshift any remaining elements
2991 // whether we've already panicked or if the consumption here panics.
2992 if !backshift.drain.panic_flag {
2993 backshift.drain.for_each(drop);