1 // Copyright 2012-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 //! VecDeque is a double-ended queue, which is implemented with the help of a
12 //! growing ring buffer.
14 //! This queue has `O(1)` amortized inserts and removals from both ends of the
15 //! container. It also has `O(1)` indexing like a vector. The contained elements
16 //! are not required to be copyable, and the queue will be sendable if the
17 //! contained type is sendable.
19 #![stable(feature = "rust1", since = "1.0.0")]
21 use core::cmp::Ordering;
23 use core::iter::{repeat, FromIterator, FusedIterator};
25 use core::ops::{Index, IndexMut};
27 use core::ptr::Shared;
30 use core::hash::{Hash, Hasher};
33 use alloc::raw_vec::RawVec;
35 use super::range::RangeArgument;
38 const INITIAL_CAPACITY: usize = 7; // 2^3 - 1
39 const MINIMUM_CAPACITY: usize = 1; // 2 - 1
40 #[cfg(target_pointer_width = "32")]
41 const MAXIMUM_ZST_CAPACITY: usize = 1 << (32 - 1); // Largest possible power of two
42 #[cfg(target_pointer_width = "64")]
43 const MAXIMUM_ZST_CAPACITY: usize = 1 << (64 - 1); // Largest possible power of two
45 /// `VecDeque` is a growable ring buffer, which can be used as a double-ended
46 /// queue efficiently.
48 /// The "default" usage of this type as a queue is to use `push_back` to add to
49 /// the queue, and `pop_front` to remove from the queue. `extend` and `append`
50 /// push onto the back in this manner, and iterating over `VecDeque` goes front
52 #[stable(feature = "rust1", since = "1.0.0")]
53 pub struct VecDeque<T> {
54 // tail and head are pointers into the buffer. Tail always points
55 // to the first element that could be read, Head always points
56 // to where data should be written.
57 // If tail == head the buffer is empty. The length of the ringbuffer
58 // is defined as the distance between the two.
64 #[stable(feature = "rust1", since = "1.0.0")]
65 impl<T: Clone> Clone for VecDeque<T> {
66 fn clone(&self) -> VecDeque<T> {
67 self.iter().cloned().collect()
71 #[stable(feature = "rust1", since = "1.0.0")]
72 impl<T> Drop for VecDeque<T> {
73 #[unsafe_destructor_blind_to_params]
75 let (front, back) = self.as_mut_slices();
78 ptr::drop_in_place(front);
79 ptr::drop_in_place(back);
81 // RawVec handles deallocation
85 #[stable(feature = "rust1", since = "1.0.0")]
86 impl<T> Default for VecDeque<T> {
87 /// Creates an empty `VecDeque<T>`.
89 fn default() -> VecDeque<T> {
95 /// Marginally more convenient
97 fn ptr(&self) -> *mut T {
101 /// Marginally more convenient
103 fn cap(&self) -> usize {
104 if mem::size_of::<T>() == 0 {
105 // For zero sized types, we are always at maximum capacity
112 /// Turn ptr into a slice
114 unsafe fn buffer_as_slice(&self) -> &[T] {
115 slice::from_raw_parts(self.ptr(), self.cap())
118 /// Turn ptr into a mut slice
120 unsafe fn buffer_as_mut_slice(&mut self) -> &mut [T] {
121 slice::from_raw_parts_mut(self.ptr(), self.cap())
124 /// Moves an element out of the buffer
126 unsafe fn buffer_read(&mut self, off: usize) -> T {
127 ptr::read(self.ptr().offset(off as isize))
130 /// Writes an element into the buffer, moving it.
132 unsafe fn buffer_write(&mut self, off: usize, value: T) {
133 ptr::write(self.ptr().offset(off as isize), value);
136 /// Returns true if and only if the buffer is at capacity
138 fn is_full(&self) -> bool {
139 self.cap() - self.len() == 1
142 /// Returns the index in the underlying buffer for a given logical element
145 fn wrap_index(&self, idx: usize) -> usize {
146 wrap_index(idx, self.cap())
149 /// Returns the index in the underlying buffer for a given logical element
152 fn wrap_add(&self, idx: usize, addend: usize) -> usize {
153 wrap_index(idx.wrapping_add(addend), self.cap())
156 /// Returns the index in the underlying buffer for a given logical element
157 /// index - subtrahend.
159 fn wrap_sub(&self, idx: usize, subtrahend: usize) -> usize {
160 wrap_index(idx.wrapping_sub(subtrahend), self.cap())
163 /// Copies a contiguous block of memory len long from src to dst
165 unsafe fn copy(&self, dst: usize, src: usize, len: usize) {
166 debug_assert!(dst + len <= self.cap(),
167 "cpy dst={} src={} len={} cap={}",
172 debug_assert!(src + len <= self.cap(),
173 "cpy dst={} src={} len={} cap={}",
178 ptr::copy(self.ptr().offset(src as isize),
179 self.ptr().offset(dst as isize),
183 /// Copies a contiguous block of memory len long from src to dst
185 unsafe fn copy_nonoverlapping(&self, dst: usize, src: usize, len: usize) {
186 debug_assert!(dst + len <= self.cap(),
187 "cno dst={} src={} len={} cap={}",
192 debug_assert!(src + len <= self.cap(),
193 "cno dst={} src={} len={} cap={}",
198 ptr::copy_nonoverlapping(self.ptr().offset(src as isize),
199 self.ptr().offset(dst as isize),
203 /// Copies a potentially wrapping block of memory len long from src to dest.
204 /// (abs(dst - src) + len) must be no larger than cap() (There must be at
205 /// most one continuous overlapping region between src and dest).
206 unsafe fn wrap_copy(&self, dst: usize, src: usize, len: usize) {
208 fn diff(a: usize, b: usize) -> usize {
209 if a <= b { b - a } else { a - b }
211 debug_assert!(cmp::min(diff(dst, src), self.cap() - diff(dst, src)) + len <= self.cap(),
212 "wrc dst={} src={} len={} cap={}",
218 if src == dst || len == 0 {
222 let dst_after_src = self.wrap_sub(dst, src) < len;
224 let src_pre_wrap_len = self.cap() - src;
225 let dst_pre_wrap_len = self.cap() - dst;
226 let src_wraps = src_pre_wrap_len < len;
227 let dst_wraps = dst_pre_wrap_len < len;
229 match (dst_after_src, src_wraps, dst_wraps) {
230 (_, false, false) => {
231 // src doesn't wrap, dst doesn't wrap
234 // 1 [_ _ A A B B C C _]
235 // 2 [_ _ A A A A B B _]
238 self.copy(dst, src, len);
240 (false, false, true) => {
241 // dst before src, src doesn't wrap, dst wraps
244 // 1 [A A B B _ _ _ C C]
245 // 2 [A A B B _ _ _ A A]
246 // 3 [B B B B _ _ _ A A]
249 self.copy(dst, src, dst_pre_wrap_len);
250 self.copy(0, src + dst_pre_wrap_len, len - dst_pre_wrap_len);
252 (true, false, true) => {
253 // src before dst, src doesn't wrap, dst wraps
256 // 1 [C C _ _ _ A A B B]
257 // 2 [B B _ _ _ A A B B]
258 // 3 [B B _ _ _ A A A A]
261 self.copy(0, src + dst_pre_wrap_len, len - dst_pre_wrap_len);
262 self.copy(dst, src, dst_pre_wrap_len);
264 (false, true, false) => {
265 // dst before src, src wraps, dst doesn't wrap
268 // 1 [C C _ _ _ A A B B]
269 // 2 [C C _ _ _ B B B B]
270 // 3 [C C _ _ _ B B C C]
273 self.copy(dst, src, src_pre_wrap_len);
274 self.copy(dst + src_pre_wrap_len, 0, len - src_pre_wrap_len);
276 (true, true, false) => {
277 // src before dst, src wraps, dst doesn't wrap
280 // 1 [A A B B _ _ _ C C]
281 // 2 [A A A A _ _ _ C C]
282 // 3 [C C A A _ _ _ C C]
285 self.copy(dst + src_pre_wrap_len, 0, len - src_pre_wrap_len);
286 self.copy(dst, src, src_pre_wrap_len);
288 (false, true, true) => {
289 // dst before src, src wraps, dst wraps
292 // 1 [A B C D _ E F G H]
293 // 2 [A B C D _ E G H H]
294 // 3 [A B C D _ E G H A]
295 // 4 [B C C D _ E G H A]
298 debug_assert!(dst_pre_wrap_len > src_pre_wrap_len);
299 let delta = dst_pre_wrap_len - src_pre_wrap_len;
300 self.copy(dst, src, src_pre_wrap_len);
301 self.copy(dst + src_pre_wrap_len, 0, delta);
302 self.copy(0, delta, len - dst_pre_wrap_len);
304 (true, true, true) => {
305 // src before dst, src wraps, dst wraps
308 // 1 [A B C D _ E F G H]
309 // 2 [A A B D _ E F G H]
310 // 3 [H A B D _ E F G H]
311 // 4 [H A B D _ E F F G]
314 debug_assert!(src_pre_wrap_len > dst_pre_wrap_len);
315 let delta = src_pre_wrap_len - dst_pre_wrap_len;
316 self.copy(delta, 0, len - src_pre_wrap_len);
317 self.copy(0, self.cap() - delta, delta);
318 self.copy(dst, src, dst_pre_wrap_len);
323 /// Frobs the head and tail sections around to handle the fact that we
324 /// just reallocated. Unsafe because it trusts old_cap.
326 unsafe fn handle_cap_increase(&mut self, old_cap: usize) {
327 let new_cap = self.cap();
329 // Move the shortest contiguous section of the ring buffer
331 // [o o o o o o o . ]
333 // A [o o o o o o o . . . . . . . . . ]
335 // [o o . o o o o o ]
337 // B [. . . o o o o o o o . . . . . . ]
339 // [o o o o o . o o ]
341 // C [o o o o o . . . . . . . . . o o ]
343 if self.tail <= self.head {
346 } else if self.head < old_cap - self.tail {
348 self.copy_nonoverlapping(old_cap, 0, self.head);
349 self.head += old_cap;
350 debug_assert!(self.head > self.tail);
353 let new_tail = new_cap - (old_cap - self.tail);
354 self.copy_nonoverlapping(new_tail, self.tail, old_cap - self.tail);
355 self.tail = new_tail;
356 debug_assert!(self.head < self.tail);
358 debug_assert!(self.head < self.cap());
359 debug_assert!(self.tail < self.cap());
360 debug_assert!(self.cap().count_ones() == 1);
364 impl<T> VecDeque<T> {
365 /// Creates an empty `VecDeque`.
370 /// use std::collections::VecDeque;
372 /// let vector: VecDeque<u32> = VecDeque::new();
374 #[stable(feature = "rust1", since = "1.0.0")]
375 pub fn new() -> VecDeque<T> {
376 VecDeque::with_capacity(INITIAL_CAPACITY)
379 /// Creates an empty `VecDeque` with space for at least `n` elements.
384 /// use std::collections::VecDeque;
386 /// let vector: VecDeque<u32> = VecDeque::with_capacity(10);
388 #[stable(feature = "rust1", since = "1.0.0")]
389 pub fn with_capacity(n: usize) -> VecDeque<T> {
390 // +1 since the ringbuffer always leaves one space empty
391 let cap = cmp::max(n + 1, MINIMUM_CAPACITY + 1).next_power_of_two();
392 assert!(cap > n, "capacity overflow");
397 buf: RawVec::with_capacity(cap),
401 /// Retrieves an element in the `VecDeque` by index.
403 /// Element at index 0 is the front of the queue.
408 /// use std::collections::VecDeque;
410 /// let mut buf = VecDeque::new();
411 /// buf.push_back(3);
412 /// buf.push_back(4);
413 /// buf.push_back(5);
414 /// assert_eq!(buf.get(1), Some(&4));
416 #[stable(feature = "rust1", since = "1.0.0")]
417 pub fn get(&self, index: usize) -> Option<&T> {
418 if index < self.len() {
419 let idx = self.wrap_add(self.tail, index);
420 unsafe { Some(&*self.ptr().offset(idx as isize)) }
426 /// Retrieves an element in the `VecDeque` mutably by index.
428 /// Element at index 0 is the front of the queue.
433 /// use std::collections::VecDeque;
435 /// let mut buf = VecDeque::new();
436 /// buf.push_back(3);
437 /// buf.push_back(4);
438 /// buf.push_back(5);
439 /// if let Some(elem) = buf.get_mut(1) {
443 /// assert_eq!(buf[1], 7);
445 #[stable(feature = "rust1", since = "1.0.0")]
446 pub fn get_mut(&mut self, index: usize) -> Option<&mut T> {
447 if index < self.len() {
448 let idx = self.wrap_add(self.tail, index);
449 unsafe { Some(&mut *self.ptr().offset(idx as isize)) }
455 /// Swaps elements at indices `i` and `j`.
457 /// `i` and `j` may be equal.
459 /// Fails if there is no element with either index.
461 /// Element at index 0 is the front of the queue.
466 /// use std::collections::VecDeque;
468 /// let mut buf = VecDeque::new();
469 /// buf.push_back(3);
470 /// buf.push_back(4);
471 /// buf.push_back(5);
473 /// assert_eq!(buf[0], 5);
474 /// assert_eq!(buf[2], 3);
476 #[stable(feature = "rust1", since = "1.0.0")]
477 pub fn swap(&mut self, i: usize, j: usize) {
478 assert!(i < self.len());
479 assert!(j < self.len());
480 let ri = self.wrap_add(self.tail, i);
481 let rj = self.wrap_add(self.tail, j);
483 ptr::swap(self.ptr().offset(ri as isize),
484 self.ptr().offset(rj as isize))
488 /// Returns the number of elements the `VecDeque` can hold without
494 /// use std::collections::VecDeque;
496 /// let buf: VecDeque<i32> = VecDeque::with_capacity(10);
497 /// assert!(buf.capacity() >= 10);
500 #[stable(feature = "rust1", since = "1.0.0")]
501 pub fn capacity(&self) -> usize {
505 /// Reserves the minimum capacity for exactly `additional` more elements to be inserted in the
506 /// given `VecDeque`. Does nothing if the capacity is already sufficient.
508 /// Note that the allocator may give the collection more space than it requests. Therefore
509 /// capacity can not be relied upon to be precisely minimal. Prefer `reserve` if future
510 /// insertions are expected.
514 /// Panics if the new capacity overflows `usize`.
519 /// use std::collections::VecDeque;
521 /// let mut buf: VecDeque<i32> = vec![1].into_iter().collect();
522 /// buf.reserve_exact(10);
523 /// assert!(buf.capacity() >= 11);
525 #[stable(feature = "rust1", since = "1.0.0")]
526 pub fn reserve_exact(&mut self, additional: usize) {
527 self.reserve(additional);
530 /// Reserves capacity for at least `additional` more elements to be inserted in the given
531 /// `VecDeque`. The collection may reserve more space to avoid frequent reallocations.
535 /// Panics if the new capacity overflows `usize`.
540 /// use std::collections::VecDeque;
542 /// let mut buf: VecDeque<i32> = vec![1].into_iter().collect();
544 /// assert!(buf.capacity() >= 11);
546 #[stable(feature = "rust1", since = "1.0.0")]
547 pub fn reserve(&mut self, additional: usize) {
548 let old_cap = self.cap();
549 let used_cap = self.len() + 1;
550 let new_cap = used_cap.checked_add(additional)
551 .and_then(|needed_cap| needed_cap.checked_next_power_of_two())
552 .expect("capacity overflow");
554 if new_cap > self.capacity() {
555 self.buf.reserve_exact(used_cap, new_cap - used_cap);
557 self.handle_cap_increase(old_cap);
562 /// Shrinks the capacity of the `VecDeque` as much as possible.
564 /// It will drop down as close as possible to the length but the allocator may still inform the
565 /// `VecDeque` that there is space for a few more elements.
570 /// use std::collections::VecDeque;
572 /// let mut buf = VecDeque::with_capacity(15);
573 /// buf.extend(0..4);
574 /// assert_eq!(buf.capacity(), 15);
575 /// buf.shrink_to_fit();
576 /// assert!(buf.capacity() >= 4);
578 #[stable(feature = "deque_extras_15", since = "1.5.0")]
579 pub fn shrink_to_fit(&mut self) {
580 // +1 since the ringbuffer always leaves one space empty
581 // len + 1 can't overflow for an existing, well-formed ringbuffer.
582 let target_cap = cmp::max(self.len() + 1, MINIMUM_CAPACITY + 1).next_power_of_two();
583 if target_cap < self.cap() {
584 // There are three cases of interest:
585 // All elements are out of desired bounds
586 // Elements are contiguous, and head is out of desired bounds
587 // Elements are discontiguous, and tail is out of desired bounds
589 // At all other times, element positions are unaffected.
591 // Indicates that elements at the head should be moved.
592 let head_outside = self.head == 0 || self.head >= target_cap;
593 // Move elements from out of desired bounds (positions after target_cap)
594 if self.tail >= target_cap && head_outside {
596 // [. . . . . . . . o o o o o o o . ]
598 // [o o o o o o o . ]
600 self.copy_nonoverlapping(0, self.tail, self.len());
602 self.head = self.len();
604 } else if self.tail != 0 && self.tail < target_cap && head_outside {
606 // [. . . o o o o o o o . . . . . . ]
608 // [o o . o o o o o ]
609 let len = self.wrap_sub(self.head, target_cap);
611 self.copy_nonoverlapping(0, target_cap, len);
614 debug_assert!(self.head < self.tail);
615 } else if self.tail >= target_cap {
617 // [o o o o o . . . . . . . . . o o ]
619 // [o o o o o . o o ]
620 debug_assert!(self.wrap_sub(self.head, 1) < target_cap);
621 let len = self.cap() - self.tail;
622 let new_tail = target_cap - len;
624 self.copy_nonoverlapping(new_tail, self.tail, len);
626 self.tail = new_tail;
627 debug_assert!(self.head < self.tail);
630 self.buf.shrink_to_fit(target_cap);
632 debug_assert!(self.head < self.cap());
633 debug_assert!(self.tail < self.cap());
634 debug_assert!(self.cap().count_ones() == 1);
638 /// Shortens a `VecDeque`, dropping excess elements from the back.
640 /// If `len` is greater than the `VecDeque`'s current length, this has no
646 /// #![feature(deque_extras)]
648 /// use std::collections::VecDeque;
650 /// let mut buf = VecDeque::new();
651 /// buf.push_back(5);
652 /// buf.push_back(10);
653 /// buf.push_back(15);
655 /// assert_eq!(buf.len(), 1);
656 /// assert_eq!(Some(&5), buf.get(0));
658 #[unstable(feature = "deque_extras",
659 reason = "matches collection reform specification; waiting on panic semantics",
661 pub fn truncate(&mut self, len: usize) {
662 for _ in len..self.len() {
667 /// Returns a front-to-back iterator.
672 /// use std::collections::VecDeque;
674 /// let mut buf = VecDeque::new();
675 /// buf.push_back(5);
676 /// buf.push_back(3);
677 /// buf.push_back(4);
678 /// let b: &[_] = &[&5, &3, &4];
679 /// let c: Vec<&i32> = buf.iter().collect();
680 /// assert_eq!(&c[..], b);
682 #[stable(feature = "rust1", since = "1.0.0")]
683 pub fn iter(&self) -> Iter<T> {
687 ring: unsafe { self.buffer_as_slice() },
691 /// Returns a front-to-back iterator that returns mutable references.
696 /// use std::collections::VecDeque;
698 /// let mut buf = VecDeque::new();
699 /// buf.push_back(5);
700 /// buf.push_back(3);
701 /// buf.push_back(4);
702 /// for num in buf.iter_mut() {
705 /// let b: &[_] = &[&mut 3, &mut 1, &mut 2];
706 /// assert_eq!(&buf.iter_mut().collect::<Vec<&mut i32>>()[..], b);
708 #[stable(feature = "rust1", since = "1.0.0")]
709 pub fn iter_mut(&mut self) -> IterMut<T> {
713 ring: unsafe { self.buffer_as_mut_slice() },
717 /// Returns a pair of slices which contain, in order, the contents of the
723 /// use std::collections::VecDeque;
725 /// let mut vector = VecDeque::new();
727 /// vector.push_back(0);
728 /// vector.push_back(1);
729 /// vector.push_back(2);
731 /// assert_eq!(vector.as_slices(), (&[0, 1, 2][..], &[][..]));
733 /// vector.push_front(10);
734 /// vector.push_front(9);
736 /// assert_eq!(vector.as_slices(), (&[9, 10][..], &[0, 1, 2][..]));
739 #[stable(feature = "deque_extras_15", since = "1.5.0")]
740 pub fn as_slices(&self) -> (&[T], &[T]) {
742 let buf = self.buffer_as_slice();
743 RingSlices::ring_slices(buf, self.head, self.tail)
747 /// Returns a pair of slices which contain, in order, the contents of the
753 /// use std::collections::VecDeque;
755 /// let mut vector = VecDeque::new();
757 /// vector.push_back(0);
758 /// vector.push_back(1);
760 /// vector.push_front(10);
761 /// vector.push_front(9);
763 /// vector.as_mut_slices().0[0] = 42;
764 /// vector.as_mut_slices().1[0] = 24;
765 /// assert_eq!(vector.as_slices(), (&[42, 10][..], &[24, 1][..]));
768 #[stable(feature = "deque_extras_15", since = "1.5.0")]
769 pub fn as_mut_slices(&mut self) -> (&mut [T], &mut [T]) {
771 let head = self.head;
772 let tail = self.tail;
773 let buf = self.buffer_as_mut_slice();
774 RingSlices::ring_slices(buf, head, tail)
778 /// Returns the number of elements in the `VecDeque`.
783 /// use std::collections::VecDeque;
785 /// let mut v = VecDeque::new();
786 /// assert_eq!(v.len(), 0);
788 /// assert_eq!(v.len(), 1);
790 #[stable(feature = "rust1", since = "1.0.0")]
791 pub fn len(&self) -> usize {
792 count(self.tail, self.head, self.cap())
795 /// Returns true if the buffer contains no elements
800 /// use std::collections::VecDeque;
802 /// let mut v = VecDeque::new();
803 /// assert!(v.is_empty());
805 /// assert!(!v.is_empty());
807 #[stable(feature = "rust1", since = "1.0.0")]
808 pub fn is_empty(&self) -> bool {
809 self.tail == self.head
812 /// Create a draining iterator that removes the specified range in the
813 /// `VecDeque` and yields the removed items.
815 /// Note 1: The element range is removed even if the iterator is not
816 /// consumed until the end.
818 /// Note 2: It is unspecified how many elements are removed from the deque,
819 /// if the `Drain` value is not dropped, but the borrow it holds expires
820 /// (eg. due to mem::forget).
824 /// Panics if the starting point is greater than the end point or if
825 /// the end point is greater than the length of the vector.
830 /// use std::collections::VecDeque;
832 /// let mut v: VecDeque<_> = vec![1, 2, 3].into_iter().collect();
833 /// assert_eq!(vec![3].into_iter().collect::<VecDeque<_>>(), v.drain(2..).collect());
834 /// assert_eq!(vec![1, 2].into_iter().collect::<VecDeque<_>>(), v);
836 /// // A full range clears all contents
838 /// assert!(v.is_empty());
841 #[stable(feature = "drain", since = "1.6.0")]
842 pub fn drain<R>(&mut self, range: R) -> Drain<T>
843 where R: RangeArgument<usize>
847 // When the Drain is first created, the source deque is shortened to
848 // make sure no uninitialized or moved-from elements are accessible at
849 // all if the Drain's destructor never gets to run.
851 // Drain will ptr::read out the values to remove.
852 // When finished, the remaining data will be copied back to cover the hole,
853 // and the head/tail values will be restored correctly.
855 let len = self.len();
856 let start = *range.start().unwrap_or(&0);
857 let end = *range.end().unwrap_or(&len);
858 assert!(start <= end, "drain lower bound was too large");
859 assert!(end <= len, "drain upper bound was too large");
861 // The deque's elements are parted into three segments:
862 // * self.tail -> drain_tail
863 // * drain_tail -> drain_head
864 // * drain_head -> self.head
866 // T = self.tail; H = self.head; t = drain_tail; h = drain_head
868 // We store drain_tail as self.head, and drain_head and self.head as
869 // after_tail and after_head respectively on the Drain. This also
870 // truncates the effective array such that if the Drain is leaked, we
871 // have forgotten about the potentially moved values after the start of
875 // [. . . o o x x o o . . .]
877 let drain_tail = self.wrap_add(self.tail, start);
878 let drain_head = self.wrap_add(self.tail, end);
879 let head = self.head;
881 // "forget" about the values after the start of the drain until after
882 // the drain is complete and the Drain destructor is run.
883 self.head = drain_tail;
886 deque: unsafe { Shared::new(self as *mut _) },
887 after_tail: drain_head,
892 ring: unsafe { self.buffer_as_mut_slice() },
897 /// Clears the buffer, removing all values.
902 /// use std::collections::VecDeque;
904 /// let mut v = VecDeque::new();
907 /// assert!(v.is_empty());
909 #[stable(feature = "rust1", since = "1.0.0")]
911 pub fn clear(&mut self) {
915 /// Returns `true` if the `VecDeque` contains an element equal to the
921 /// use std::collections::VecDeque;
923 /// let mut vector: VecDeque<u32> = VecDeque::new();
925 /// vector.push_back(0);
926 /// vector.push_back(1);
928 /// assert_eq!(vector.contains(&1), true);
929 /// assert_eq!(vector.contains(&10), false);
931 #[stable(feature = "vec_deque_contains", since = "1.12.0")]
932 pub fn contains(&self, x: &T) -> bool
933 where T: PartialEq<T>
935 let (a, b) = self.as_slices();
936 a.contains(x) || b.contains(x)
939 /// Provides a reference to the front element, or `None` if the sequence is
945 /// use std::collections::VecDeque;
947 /// let mut d = VecDeque::new();
948 /// assert_eq!(d.front(), None);
952 /// assert_eq!(d.front(), Some(&1));
954 #[stable(feature = "rust1", since = "1.0.0")]
955 pub fn front(&self) -> Option<&T> {
956 if !self.is_empty() {
963 /// Provides a mutable reference to the front element, or `None` if the
964 /// sequence is empty.
969 /// use std::collections::VecDeque;
971 /// let mut d = VecDeque::new();
972 /// assert_eq!(d.front_mut(), None);
976 /// match d.front_mut() {
977 /// Some(x) => *x = 9,
980 /// assert_eq!(d.front(), Some(&9));
982 #[stable(feature = "rust1", since = "1.0.0")]
983 pub fn front_mut(&mut self) -> Option<&mut T> {
984 if !self.is_empty() {
991 /// Provides a reference to the back element, or `None` if the sequence is
997 /// use std::collections::VecDeque;
999 /// let mut d = VecDeque::new();
1000 /// assert_eq!(d.back(), None);
1004 /// assert_eq!(d.back(), Some(&2));
1006 #[stable(feature = "rust1", since = "1.0.0")]
1007 pub fn back(&self) -> Option<&T> {
1008 if !self.is_empty() {
1009 Some(&self[self.len() - 1])
1015 /// Provides a mutable reference to the back element, or `None` if the
1016 /// sequence is empty.
1021 /// use std::collections::VecDeque;
1023 /// let mut d = VecDeque::new();
1024 /// assert_eq!(d.back(), None);
1028 /// match d.back_mut() {
1029 /// Some(x) => *x = 9,
1032 /// assert_eq!(d.back(), Some(&9));
1034 #[stable(feature = "rust1", since = "1.0.0")]
1035 pub fn back_mut(&mut self) -> Option<&mut T> {
1036 let len = self.len();
1037 if !self.is_empty() {
1038 Some(&mut self[len - 1])
1044 /// Removes the first element and returns it, or `None` if the sequence is
1050 /// use std::collections::VecDeque;
1052 /// let mut d = VecDeque::new();
1056 /// assert_eq!(d.pop_front(), Some(1));
1057 /// assert_eq!(d.pop_front(), Some(2));
1058 /// assert_eq!(d.pop_front(), None);
1060 #[stable(feature = "rust1", since = "1.0.0")]
1061 pub fn pop_front(&mut self) -> Option<T> {
1062 if self.is_empty() {
1065 let tail = self.tail;
1066 self.tail = self.wrap_add(self.tail, 1);
1067 unsafe { Some(self.buffer_read(tail)) }
1071 /// Inserts an element first in the sequence.
1076 /// use std::collections::VecDeque;
1078 /// let mut d = VecDeque::new();
1079 /// d.push_front(1);
1080 /// d.push_front(2);
1081 /// assert_eq!(d.front(), Some(&2));
1083 #[stable(feature = "rust1", since = "1.0.0")]
1084 pub fn push_front(&mut self, value: T) {
1086 let old_cap = self.cap();
1089 self.handle_cap_increase(old_cap);
1091 debug_assert!(!self.is_full());
1094 self.tail = self.wrap_sub(self.tail, 1);
1095 let tail = self.tail;
1097 self.buffer_write(tail, value);
1101 /// Appends an element to the back of a buffer
1106 /// use std::collections::VecDeque;
1108 /// let mut buf = VecDeque::new();
1109 /// buf.push_back(1);
1110 /// buf.push_back(3);
1111 /// assert_eq!(3, *buf.back().unwrap());
1113 #[stable(feature = "rust1", since = "1.0.0")]
1114 pub fn push_back(&mut self, value: T) {
1116 let old_cap = self.cap();
1119 self.handle_cap_increase(old_cap);
1121 debug_assert!(!self.is_full());
1124 let head = self.head;
1125 self.head = self.wrap_add(self.head, 1);
1126 unsafe { self.buffer_write(head, value) }
1129 /// Removes the last element from a buffer and returns it, or `None` if
1135 /// use std::collections::VecDeque;
1137 /// let mut buf = VecDeque::new();
1138 /// assert_eq!(buf.pop_back(), None);
1139 /// buf.push_back(1);
1140 /// buf.push_back(3);
1141 /// assert_eq!(buf.pop_back(), Some(3));
1143 #[stable(feature = "rust1", since = "1.0.0")]
1144 pub fn pop_back(&mut self) -> Option<T> {
1145 if self.is_empty() {
1148 self.head = self.wrap_sub(self.head, 1);
1149 let head = self.head;
1150 unsafe { Some(self.buffer_read(head)) }
1155 fn is_contiguous(&self) -> bool {
1156 self.tail <= self.head
1159 /// Removes an element from anywhere in the `VecDeque` and returns it, replacing it with the
1162 /// This does not preserve ordering, but is O(1).
1164 /// Returns `None` if `index` is out of bounds.
1166 /// Element at index 0 is the front of the queue.
1171 /// use std::collections::VecDeque;
1173 /// let mut buf = VecDeque::new();
1174 /// assert_eq!(buf.swap_remove_back(0), None);
1175 /// buf.push_back(1);
1176 /// buf.push_back(2);
1177 /// buf.push_back(3);
1179 /// assert_eq!(buf.swap_remove_back(0), Some(1));
1180 /// assert_eq!(buf.len(), 2);
1181 /// assert_eq!(buf[0], 3);
1182 /// assert_eq!(buf[1], 2);
1184 #[stable(feature = "deque_extras_15", since = "1.5.0")]
1185 pub fn swap_remove_back(&mut self, index: usize) -> Option<T> {
1186 let length = self.len();
1187 if length > 0 && index < length - 1 {
1188 self.swap(index, length - 1);
1189 } else if index >= length {
1195 /// Removes an element from anywhere in the `VecDeque` and returns it,
1196 /// replacing it with the first element.
1198 /// This does not preserve ordering, but is O(1).
1200 /// Returns `None` if `index` is out of bounds.
1202 /// Element at index 0 is the front of the queue.
1207 /// use std::collections::VecDeque;
1209 /// let mut buf = VecDeque::new();
1210 /// assert_eq!(buf.swap_remove_front(0), None);
1211 /// buf.push_back(1);
1212 /// buf.push_back(2);
1213 /// buf.push_back(3);
1215 /// assert_eq!(buf.swap_remove_front(2), Some(3));
1216 /// assert_eq!(buf.len(), 2);
1217 /// assert_eq!(buf[0], 2);
1218 /// assert_eq!(buf[1], 1);
1220 #[stable(feature = "deque_extras_15", since = "1.5.0")]
1221 pub fn swap_remove_front(&mut self, index: usize) -> Option<T> {
1222 let length = self.len();
1223 if length > 0 && index < length && index != 0 {
1224 self.swap(index, 0);
1225 } else if index >= length {
1231 /// Inserts an element at `index` within the `VecDeque`, shifting all elements with indices
1232 /// greater than or equal to `index` towards the back.
1234 /// Element at index 0 is the front of the queue.
1238 /// Panics if `index` is greater than `VecDeque`'s length
1243 /// use std::collections::VecDeque;
1245 /// let mut vec_deque = VecDeque::new();
1246 /// vec_deque.push_back('a');
1247 /// vec_deque.push_back('b');
1248 /// vec_deque.push_back('c');
1250 /// vec_deque.insert(1, 'd');
1252 /// let vec = vec_deque.into_iter().collect::<Vec<_>>();
1253 /// assert_eq!(vec, ['a', 'd', 'b', 'c']);
1255 #[stable(feature = "deque_extras_15", since = "1.5.0")]
1256 pub fn insert(&mut self, index: usize, value: T) {
1257 assert!(index <= self.len(), "index out of bounds");
1259 let old_cap = self.cap();
1262 self.handle_cap_increase(old_cap);
1264 debug_assert!(!self.is_full());
1267 // Move the least number of elements in the ring buffer and insert
1270 // At most len/2 - 1 elements will be moved. O(min(n, n-i))
1272 // There are three main cases:
1273 // Elements are contiguous
1274 // - special case when tail is 0
1275 // Elements are discontiguous and the insert is in the tail section
1276 // Elements are discontiguous and the insert is in the head section
1278 // For each of those there are two more cases:
1279 // Insert is closer to tail
1280 // Insert is closer to head
1282 // Key: H - self.head
1284 // o - Valid element
1285 // I - Insertion element
1286 // A - The element that should be after the insertion point
1287 // M - Indicates element was moved
1289 let idx = self.wrap_add(self.tail, index);
1291 let distance_to_tail = index;
1292 let distance_to_head = self.len() - index;
1294 let contiguous = self.is_contiguous();
1296 match (contiguous, distance_to_tail <= distance_to_head, idx >= self.tail) {
1297 (true, true, _) if index == 0 => {
1302 // [A o o o o o o . . . . . . . . .]
1305 // [A o o o o o o o . . . . . I]
1308 self.tail = self.wrap_sub(self.tail, 1);
1310 (true, true, _) => {
1312 // contiguous, insert closer to tail:
1315 // [. . . o o A o o o o . . . . . .]
1318 // [. . o o I A o o o o . . . . . .]
1321 // contiguous, insert closer to tail and tail is 0:
1325 // [o o A o o o o . . . . . . . . .]
1328 // [o I A o o o o o . . . . . . . o]
1331 let new_tail = self.wrap_sub(self.tail, 1);
1333 self.copy(new_tail, self.tail, 1);
1334 // Already moved the tail, so we only copy `index - 1` elements.
1335 self.copy(self.tail, self.tail + 1, index - 1);
1337 self.tail = new_tail;
1340 (true, false, _) => {
1342 // contiguous, insert closer to head:
1345 // [. . . o o o o A o o . . . . . .]
1348 // [. . . o o o o I A o o . . . . .]
1351 self.copy(idx + 1, idx, self.head - idx);
1352 self.head = self.wrap_add(self.head, 1);
1355 (false, true, true) => {
1357 // discontiguous, insert closer to tail, tail section:
1360 // [o o o o o o . . . . . o o A o o]
1363 // [o o o o o o . . . . o o I A o o]
1366 self.copy(self.tail - 1, self.tail, index);
1370 (false, false, true) => {
1372 // discontiguous, insert closer to head, tail section:
1375 // [o o . . . . . . . o o o o o A o]
1378 // [o o o . . . . . . o o o o o I A]
1381 // copy elements up to new head
1382 self.copy(1, 0, self.head);
1384 // copy last element into empty spot at bottom of buffer
1385 self.copy(0, self.cap() - 1, 1);
1387 // move elements from idx to end forward not including ^ element
1388 self.copy(idx + 1, idx, self.cap() - 1 - idx);
1393 (false, true, false) if idx == 0 => {
1395 // discontiguous, insert is closer to tail, head section,
1396 // and is at index zero in the internal buffer:
1399 // [A o o o o o o o o o . . . o o o]
1402 // [A o o o o o o o o o . . o o o I]
1405 // copy elements up to new tail
1406 self.copy(self.tail - 1, self.tail, self.cap() - self.tail);
1408 // copy last element into empty spot at bottom of buffer
1409 self.copy(self.cap() - 1, 0, 1);
1414 (false, true, false) => {
1416 // discontiguous, insert closer to tail, head section:
1419 // [o o o A o o o o o o . . . o o o]
1422 // [o o I A o o o o o o . . o o o o]
1425 // copy elements up to new tail
1426 self.copy(self.tail - 1, self.tail, self.cap() - self.tail);
1428 // copy last element into empty spot at bottom of buffer
1429 self.copy(self.cap() - 1, 0, 1);
1431 // move elements from idx-1 to end forward not including ^ element
1432 self.copy(0, 1, idx - 1);
1437 (false, false, false) => {
1439 // discontiguous, insert closer to head, head section:
1442 // [o o o o A o o . . . . . . o o o]
1445 // [o o o o I A o o . . . . . o o o]
1448 self.copy(idx + 1, idx, self.head - idx);
1454 // tail might've been changed so we need to recalculate
1455 let new_idx = self.wrap_add(self.tail, index);
1457 self.buffer_write(new_idx, value);
1461 /// Removes and returns the element at `index` from the `VecDeque`.
1462 /// Whichever end is closer to the removal point will be moved to make
1463 /// room, and all the affected elements will be moved to new positions.
1464 /// Returns `None` if `index` is out of bounds.
1466 /// Element at index 0 is the front of the queue.
1471 /// use std::collections::VecDeque;
1473 /// let mut buf = VecDeque::new();
1474 /// buf.push_back(1);
1475 /// buf.push_back(2);
1476 /// buf.push_back(3);
1478 /// assert_eq!(buf.remove(1), Some(2));
1479 /// assert_eq!(buf.get(1), Some(&3));
1481 #[stable(feature = "rust1", since = "1.0.0")]
1482 pub fn remove(&mut self, index: usize) -> Option<T> {
1483 if self.is_empty() || self.len() <= index {
1487 // There are three main cases:
1488 // Elements are contiguous
1489 // Elements are discontiguous and the removal is in the tail section
1490 // Elements are discontiguous and the removal is in the head section
1491 // - special case when elements are technically contiguous,
1492 // but self.head = 0
1494 // For each of those there are two more cases:
1495 // Insert is closer to tail
1496 // Insert is closer to head
1498 // Key: H - self.head
1500 // o - Valid element
1501 // x - Element marked for removal
1502 // R - Indicates element that is being removed
1503 // M - Indicates element was moved
1505 let idx = self.wrap_add(self.tail, index);
1507 let elem = unsafe { Some(self.buffer_read(idx)) };
1509 let distance_to_tail = index;
1510 let distance_to_head = self.len() - index;
1512 let contiguous = self.is_contiguous();
1514 match (contiguous, distance_to_tail <= distance_to_head, idx >= self.tail) {
1515 (true, true, _) => {
1517 // contiguous, remove closer to tail:
1520 // [. . . o o x o o o o . . . . . .]
1523 // [. . . . o o o o o o . . . . . .]
1526 self.copy(self.tail + 1, self.tail, index);
1530 (true, false, _) => {
1532 // contiguous, remove closer to head:
1535 // [. . . o o o o x o o . . . . . .]
1538 // [. . . o o o o o o . . . . . . .]
1541 self.copy(idx, idx + 1, self.head - idx - 1);
1545 (false, true, true) => {
1547 // discontiguous, remove closer to tail, tail section:
1550 // [o o o o o o . . . . . o o x o o]
1553 // [o o o o o o . . . . . . o o o o]
1556 self.copy(self.tail + 1, self.tail, index);
1557 self.tail = self.wrap_add(self.tail, 1);
1560 (false, false, false) => {
1562 // discontiguous, remove closer to head, head section:
1565 // [o o o o x o o . . . . . . o o o]
1568 // [o o o o o o . . . . . . . o o o]
1571 self.copy(idx, idx + 1, self.head - idx - 1);
1575 (false, false, true) => {
1577 // discontiguous, remove closer to head, tail section:
1580 // [o o o . . . . . . o o o o o x o]
1583 // [o o . . . . . . . o o o o o o o]
1586 // or quasi-discontiguous, remove next to head, tail section:
1589 // [. . . . . . . . . o o o o o x o]
1592 // [. . . . . . . . . o o o o o o .]
1595 // draw in elements in the tail section
1596 self.copy(idx, idx + 1, self.cap() - idx - 1);
1598 // Prevents underflow.
1600 // copy first element into empty spot
1601 self.copy(self.cap() - 1, 0, 1);
1603 // move elements in the head section backwards
1604 self.copy(0, 1, self.head - 1);
1607 self.head = self.wrap_sub(self.head, 1);
1610 (false, true, false) => {
1612 // discontiguous, remove closer to tail, head section:
1615 // [o o x o o o o o o o . . . o o o]
1618 // [o o o o o o o o o o . . . . o o]
1621 // draw in elements up to idx
1622 self.copy(1, 0, idx);
1624 // copy last element into empty spot
1625 self.copy(0, self.cap() - 1, 1);
1627 // move elements from tail to end forward, excluding the last one
1628 self.copy(self.tail + 1, self.tail, self.cap() - self.tail - 1);
1630 self.tail = self.wrap_add(self.tail, 1);
1638 /// Splits the collection into two at the given index.
1640 /// Returns a newly allocated `Self`. `self` contains elements `[0, at)`,
1641 /// and the returned `Self` contains elements `[at, len)`.
1643 /// Note that the capacity of `self` does not change.
1645 /// Element at index 0 is the front of the queue.
1649 /// Panics if `at > len`
1654 /// use std::collections::VecDeque;
1656 /// let mut buf: VecDeque<_> = vec![1,2,3].into_iter().collect();
1657 /// let buf2 = buf.split_off(1);
1658 /// // buf = [1], buf2 = [2, 3]
1659 /// assert_eq!(buf.len(), 1);
1660 /// assert_eq!(buf2.len(), 2);
1663 #[stable(feature = "split_off", since = "1.4.0")]
1664 pub fn split_off(&mut self, at: usize) -> Self {
1665 let len = self.len();
1666 assert!(at <= len, "`at` out of bounds");
1668 let other_len = len - at;
1669 let mut other = VecDeque::with_capacity(other_len);
1672 let (first_half, second_half) = self.as_slices();
1674 let first_len = first_half.len();
1675 let second_len = second_half.len();
1677 // `at` lies in the first half.
1678 let amount_in_first = first_len - at;
1680 ptr::copy_nonoverlapping(first_half.as_ptr().offset(at as isize),
1684 // just take all of the second half.
1685 ptr::copy_nonoverlapping(second_half.as_ptr(),
1686 other.ptr().offset(amount_in_first as isize),
1689 // `at` lies in the second half, need to factor in the elements we skipped
1690 // in the first half.
1691 let offset = at - first_len;
1692 let amount_in_second = second_len - offset;
1693 ptr::copy_nonoverlapping(second_half.as_ptr().offset(offset as isize),
1699 // Cleanup where the ends of the buffers are
1700 self.head = self.wrap_sub(self.head, other_len);
1701 other.head = other.wrap_index(other_len);
1706 /// Moves all the elements of `other` into `Self`, leaving `other` empty.
1710 /// Panics if the new number of elements in self overflows a `usize`.
1715 /// use std::collections::VecDeque;
1717 /// let mut buf: VecDeque<_> = vec![1, 2, 3].into_iter().collect();
1718 /// let mut buf2: VecDeque<_> = vec![4, 5, 6].into_iter().collect();
1719 /// buf.append(&mut buf2);
1720 /// assert_eq!(buf.len(), 6);
1721 /// assert_eq!(buf2.len(), 0);
1724 #[stable(feature = "append", since = "1.4.0")]
1725 pub fn append(&mut self, other: &mut Self) {
1727 self.extend(other.drain(..));
1730 /// Retains only the elements specified by the predicate.
1732 /// In other words, remove all elements `e` such that `f(&e)` returns false.
1733 /// This method operates in place and preserves the order of the retained
1739 /// use std::collections::VecDeque;
1741 /// let mut buf = VecDeque::new();
1742 /// buf.extend(1..5);
1743 /// buf.retain(|&x| x%2 == 0);
1745 /// let v: Vec<_> = buf.into_iter().collect();
1746 /// assert_eq!(&v[..], &[2, 4]);
1748 #[stable(feature = "vec_deque_retain", since = "1.4.0")]
1749 pub fn retain<F>(&mut self, mut f: F)
1750 where F: FnMut(&T) -> bool
1752 let len = self.len();
1758 self.swap(i - del, i);
1762 self.truncate(len - del);
1767 impl<T: Clone> VecDeque<T> {
1768 /// Modifies the `VecDeque` in-place so that `len()` is equal to new_len,
1769 /// either by removing excess elements or by appending copies of a value to the back.
1774 /// #![feature(deque_extras)]
1776 /// use std::collections::VecDeque;
1778 /// let mut buf = VecDeque::new();
1779 /// buf.push_back(5);
1780 /// buf.push_back(10);
1781 /// buf.push_back(15);
1782 /// buf.resize(2, 0);
1783 /// buf.resize(6, 20);
1784 /// for (a, b) in [5, 10, 20, 20, 20, 20].iter().zip(&buf) {
1785 /// assert_eq!(a, b);
1788 #[unstable(feature = "deque_extras",
1789 reason = "matches collection reform specification; waiting on panic semantics",
1791 pub fn resize(&mut self, new_len: usize, value: T) {
1792 let len = self.len();
1795 self.extend(repeat(value).take(new_len - len))
1797 self.truncate(new_len);
1802 /// Returns the index in the underlying buffer for a given logical element index.
1804 fn wrap_index(index: usize, size: usize) -> usize {
1805 // size is always a power of 2
1806 debug_assert!(size.is_power_of_two());
1810 /// Returns the two slices that cover the VecDeque's valid range
1811 trait RingSlices: Sized {
1812 fn slice(self, from: usize, to: usize) -> Self;
1813 fn split_at(self, i: usize) -> (Self, Self);
1815 fn ring_slices(buf: Self, head: usize, tail: usize) -> (Self, Self) {
1816 let contiguous = tail <= head;
1818 let (empty, buf) = buf.split_at(0);
1819 (buf.slice(tail, head), empty)
1821 let (mid, right) = buf.split_at(tail);
1822 let (left, _) = mid.split_at(head);
1828 impl<'a, T> RingSlices for &'a [T] {
1829 fn slice(self, from: usize, to: usize) -> Self {
1832 fn split_at(self, i: usize) -> (Self, Self) {
1837 impl<'a, T> RingSlices for &'a mut [T] {
1838 fn slice(self, from: usize, to: usize) -> Self {
1841 fn split_at(self, i: usize) -> (Self, Self) {
1842 (*self).split_at_mut(i)
1846 /// Calculate the number of elements left to be read in the buffer
1848 fn count(tail: usize, head: usize, size: usize) -> usize {
1849 // size is always a power of 2
1850 (head.wrapping_sub(tail)) & (size - 1)
1853 /// `VecDeque` iterator.
1854 #[stable(feature = "rust1", since = "1.0.0")]
1855 pub struct Iter<'a, T: 'a> {
1861 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
1862 #[stable(feature = "rust1", since = "1.0.0")]
1863 impl<'a, T> Clone for Iter<'a, T> {
1864 fn clone(&self) -> Iter<'a, T> {
1873 #[stable(feature = "rust1", since = "1.0.0")]
1874 impl<'a, T> Iterator for Iter<'a, T> {
1878 fn next(&mut self) -> Option<&'a T> {
1879 if self.tail == self.head {
1882 let tail = self.tail;
1883 self.tail = wrap_index(self.tail.wrapping_add(1), self.ring.len());
1884 unsafe { Some(self.ring.get_unchecked(tail)) }
1888 fn size_hint(&self) -> (usize, Option<usize>) {
1889 let len = count(self.tail, self.head, self.ring.len());
1893 fn fold<Acc, F>(self, mut accum: Acc, mut f: F) -> Acc
1894 where F: FnMut(Acc, Self::Item) -> Acc
1896 let (front, back) = RingSlices::ring_slices(self.ring, self.head, self.tail);
1897 accum = front.iter().fold(accum, &mut f);
1898 back.iter().fold(accum, &mut f)
1902 #[stable(feature = "rust1", since = "1.0.0")]
1903 impl<'a, T> DoubleEndedIterator for Iter<'a, T> {
1905 fn next_back(&mut self) -> Option<&'a T> {
1906 if self.tail == self.head {
1909 self.head = wrap_index(self.head.wrapping_sub(1), self.ring.len());
1910 unsafe { Some(self.ring.get_unchecked(self.head)) }
1914 #[stable(feature = "rust1", since = "1.0.0")]
1915 impl<'a, T> ExactSizeIterator for Iter<'a, T> {
1916 fn is_empty(&self) -> bool {
1917 self.head == self.tail
1921 #[unstable(feature = "fused", issue = "35602")]
1922 impl<'a, T> FusedIterator for Iter<'a, T> {}
1925 /// `VecDeque` mutable iterator.
1926 #[stable(feature = "rust1", since = "1.0.0")]
1927 pub struct IterMut<'a, T: 'a> {
1933 #[stable(feature = "rust1", since = "1.0.0")]
1934 impl<'a, T> Iterator for IterMut<'a, T> {
1935 type Item = &'a mut T;
1938 fn next(&mut self) -> Option<&'a mut T> {
1939 if self.tail == self.head {
1942 let tail = self.tail;
1943 self.tail = wrap_index(self.tail.wrapping_add(1), self.ring.len());
1946 let elem = self.ring.get_unchecked_mut(tail);
1947 Some(&mut *(elem as *mut _))
1952 fn size_hint(&self) -> (usize, Option<usize>) {
1953 let len = count(self.tail, self.head, self.ring.len());
1957 fn fold<Acc, F>(self, mut accum: Acc, mut f: F) -> Acc
1958 where F: FnMut(Acc, Self::Item) -> Acc
1960 let (front, back) = RingSlices::ring_slices(self.ring, self.head, self.tail);
1961 accum = front.iter_mut().fold(accum, &mut f);
1962 back.iter_mut().fold(accum, &mut f)
1966 #[stable(feature = "rust1", since = "1.0.0")]
1967 impl<'a, T> DoubleEndedIterator for IterMut<'a, T> {
1969 fn next_back(&mut self) -> Option<&'a mut T> {
1970 if self.tail == self.head {
1973 self.head = wrap_index(self.head.wrapping_sub(1), self.ring.len());
1976 let elem = self.ring.get_unchecked_mut(self.head);
1977 Some(&mut *(elem as *mut _))
1982 #[stable(feature = "rust1", since = "1.0.0")]
1983 impl<'a, T> ExactSizeIterator for IterMut<'a, T> {
1984 fn is_empty(&self) -> bool {
1985 self.head == self.tail
1989 #[unstable(feature = "fused", issue = "35602")]
1990 impl<'a, T> FusedIterator for IterMut<'a, T> {}
1992 /// A by-value VecDeque iterator
1994 #[stable(feature = "rust1", since = "1.0.0")]
1995 pub struct IntoIter<T> {
1999 #[stable(feature = "rust1", since = "1.0.0")]
2000 impl<T> Iterator for IntoIter<T> {
2004 fn next(&mut self) -> Option<T> {
2005 self.inner.pop_front()
2009 fn size_hint(&self) -> (usize, Option<usize>) {
2010 let len = self.inner.len();
2015 #[stable(feature = "rust1", since = "1.0.0")]
2016 impl<T> DoubleEndedIterator for IntoIter<T> {
2018 fn next_back(&mut self) -> Option<T> {
2019 self.inner.pop_back()
2023 #[stable(feature = "rust1", since = "1.0.0")]
2024 impl<T> ExactSizeIterator for IntoIter<T> {
2025 fn is_empty(&self) -> bool {
2026 self.inner.is_empty()
2030 #[unstable(feature = "fused", issue = "35602")]
2031 impl<T> FusedIterator for IntoIter<T> {}
2033 /// A draining VecDeque iterator
2034 #[stable(feature = "drain", since = "1.6.0")]
2035 pub struct Drain<'a, T: 'a> {
2039 deque: Shared<VecDeque<T>>,
2042 #[stable(feature = "drain", since = "1.6.0")]
2043 unsafe impl<'a, T: Sync> Sync for Drain<'a, T> {}
2044 #[stable(feature = "drain", since = "1.6.0")]
2045 unsafe impl<'a, T: Send> Send for Drain<'a, T> {}
2047 #[stable(feature = "drain", since = "1.6.0")]
2048 impl<'a, T: 'a> Drop for Drain<'a, T> {
2049 fn drop(&mut self) {
2050 for _ in self.by_ref() {}
2052 let source_deque = unsafe { &mut **self.deque };
2054 // T = source_deque_tail; H = source_deque_head; t = drain_tail; h = drain_head
2057 // [. . . o o x x o o . . .]
2059 let orig_tail = source_deque.tail;
2060 let drain_tail = source_deque.head;
2061 let drain_head = self.after_tail;
2062 let orig_head = self.after_head;
2064 let tail_len = count(orig_tail, drain_tail, source_deque.cap());
2065 let head_len = count(drain_head, orig_head, source_deque.cap());
2067 // Restore the original head value
2068 source_deque.head = orig_head;
2070 match (tail_len, head_len) {
2072 source_deque.head = 0;
2073 source_deque.tail = 0;
2076 source_deque.tail = drain_head;
2079 source_deque.head = drain_tail;
2082 if tail_len <= head_len {
2083 source_deque.tail = source_deque.wrap_sub(drain_head, tail_len);
2084 source_deque.wrap_copy(source_deque.tail, orig_tail, tail_len);
2086 source_deque.head = source_deque.wrap_add(drain_tail, head_len);
2087 source_deque.wrap_copy(drain_tail, drain_head, head_len);
2094 #[stable(feature = "drain", since = "1.6.0")]
2095 impl<'a, T: 'a> Iterator for Drain<'a, T> {
2099 fn next(&mut self) -> Option<T> {
2100 self.iter.next().map(|elt| unsafe { ptr::read(elt) })
2104 fn size_hint(&self) -> (usize, Option<usize>) {
2105 self.iter.size_hint()
2109 #[stable(feature = "drain", since = "1.6.0")]
2110 impl<'a, T: 'a> DoubleEndedIterator for Drain<'a, T> {
2112 fn next_back(&mut self) -> Option<T> {
2113 self.iter.next_back().map(|elt| unsafe { ptr::read(elt) })
2117 #[stable(feature = "drain", since = "1.6.0")]
2118 impl<'a, T: 'a> ExactSizeIterator for Drain<'a, T> {}
2120 #[unstable(feature = "fused", issue = "35602")]
2121 impl<'a, T: 'a> FusedIterator for Drain<'a, T> {}
2123 #[stable(feature = "rust1", since = "1.0.0")]
2124 impl<A: PartialEq> PartialEq for VecDeque<A> {
2125 fn eq(&self, other: &VecDeque<A>) -> bool {
2126 if self.len() != other.len() {
2129 let (sa, sb) = self.as_slices();
2130 let (oa, ob) = other.as_slices();
2131 if sa.len() == oa.len() {
2132 sa == oa && sb == ob
2133 } else if sa.len() < oa.len() {
2134 // Always divisible in three sections, for example:
2135 // self: [a b c|d e f]
2136 // other: [0 1 2 3|4 5]
2137 // front = 3, mid = 1,
2138 // [a b c] == [0 1 2] && [d] == [3] && [e f] == [4 5]
2139 let front = sa.len();
2140 let mid = oa.len() - front;
2142 let (oa_front, oa_mid) = oa.split_at(front);
2143 let (sb_mid, sb_back) = sb.split_at(mid);
2144 debug_assert_eq!(sa.len(), oa_front.len());
2145 debug_assert_eq!(sb_mid.len(), oa_mid.len());
2146 debug_assert_eq!(sb_back.len(), ob.len());
2147 sa == oa_front && sb_mid == oa_mid && sb_back == ob
2149 let front = oa.len();
2150 let mid = sa.len() - front;
2152 let (sa_front, sa_mid) = sa.split_at(front);
2153 let (ob_mid, ob_back) = ob.split_at(mid);
2154 debug_assert_eq!(sa_front.len(), oa.len());
2155 debug_assert_eq!(sa_mid.len(), ob_mid.len());
2156 debug_assert_eq!(sb.len(), ob_back.len());
2157 sa_front == oa && sa_mid == ob_mid && sb == ob_back
2162 #[stable(feature = "rust1", since = "1.0.0")]
2163 impl<A: Eq> Eq for VecDeque<A> {}
2165 #[stable(feature = "rust1", since = "1.0.0")]
2166 impl<A: PartialOrd> PartialOrd for VecDeque<A> {
2167 fn partial_cmp(&self, other: &VecDeque<A>) -> Option<Ordering> {
2168 self.iter().partial_cmp(other.iter())
2172 #[stable(feature = "rust1", since = "1.0.0")]
2173 impl<A: Ord> Ord for VecDeque<A> {
2175 fn cmp(&self, other: &VecDeque<A>) -> Ordering {
2176 self.iter().cmp(other.iter())
2180 #[stable(feature = "rust1", since = "1.0.0")]
2181 impl<A: Hash> Hash for VecDeque<A> {
2182 fn hash<H: Hasher>(&self, state: &mut H) {
2183 self.len().hash(state);
2184 let (a, b) = self.as_slices();
2185 Hash::hash_slice(a, state);
2186 Hash::hash_slice(b, state);
2190 #[stable(feature = "rust1", since = "1.0.0")]
2191 impl<A> Index<usize> for VecDeque<A> {
2195 fn index(&self, index: usize) -> &A {
2196 self.get(index).expect("Out of bounds access")
2200 #[stable(feature = "rust1", since = "1.0.0")]
2201 impl<A> IndexMut<usize> for VecDeque<A> {
2203 fn index_mut(&mut self, index: usize) -> &mut A {
2204 self.get_mut(index).expect("Out of bounds access")
2208 #[stable(feature = "rust1", since = "1.0.0")]
2209 impl<A> FromIterator<A> for VecDeque<A> {
2210 fn from_iter<T: IntoIterator<Item = A>>(iter: T) -> VecDeque<A> {
2211 let iterator = iter.into_iter();
2212 let (lower, _) = iterator.size_hint();
2213 let mut deq = VecDeque::with_capacity(lower);
2214 deq.extend(iterator);
2219 #[stable(feature = "rust1", since = "1.0.0")]
2220 impl<T> IntoIterator for VecDeque<T> {
2222 type IntoIter = IntoIter<T>;
2224 /// Consumes the list into a front-to-back iterator yielding elements by
2226 fn into_iter(self) -> IntoIter<T> {
2227 IntoIter { inner: self }
2231 #[stable(feature = "rust1", since = "1.0.0")]
2232 impl<'a, T> IntoIterator for &'a VecDeque<T> {
2234 type IntoIter = Iter<'a, T>;
2236 fn into_iter(self) -> Iter<'a, T> {
2241 #[stable(feature = "rust1", since = "1.0.0")]
2242 impl<'a, T> IntoIterator for &'a mut VecDeque<T> {
2243 type Item = &'a mut T;
2244 type IntoIter = IterMut<'a, T>;
2246 fn into_iter(mut self) -> IterMut<'a, T> {
2251 #[stable(feature = "rust1", since = "1.0.0")]
2252 impl<A> Extend<A> for VecDeque<A> {
2253 fn extend<T: IntoIterator<Item = A>>(&mut self, iter: T) {
2255 self.push_back(elt);
2260 #[stable(feature = "extend_ref", since = "1.2.0")]
2261 impl<'a, T: 'a + Copy> Extend<&'a T> for VecDeque<T> {
2262 fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I) {
2263 self.extend(iter.into_iter().cloned());
2267 #[stable(feature = "rust1", since = "1.0.0")]
2268 impl<T: fmt::Debug> fmt::Debug for VecDeque<T> {
2269 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2270 f.debug_list().entries(self).finish()
2274 #[stable(feature = "vecdeque_vec_conversions", since = "1.10.0")]
2275 impl<T> From<Vec<T>> for VecDeque<T> {
2276 fn from(mut other: Vec<T>) -> Self {
2278 let other_buf = other.as_mut_ptr();
2279 let mut buf = RawVec::from_raw_parts(other_buf, other.capacity());
2280 let len = other.len();
2283 // We need to extend the buf if it's not a power of two, too small
2284 // or doesn't have at least one free space
2285 if !buf.cap().is_power_of_two() || (buf.cap() < (MINIMUM_CAPACITY + 1)) ||
2286 (buf.cap() == len) {
2287 let cap = cmp::max(buf.cap() + 1, MINIMUM_CAPACITY + 1).next_power_of_two();
2288 buf.reserve_exact(len, cap - len);
2300 #[stable(feature = "vecdeque_vec_conversions", since = "1.10.0")]
2301 impl<T> From<VecDeque<T>> for Vec<T> {
2302 fn from(other: VecDeque<T>) -> Self {
2304 let buf = other.buf.ptr();
2305 let len = other.len();
2306 let tail = other.tail;
2307 let head = other.head;
2308 let cap = other.cap();
2310 // Need to move the ring to the front of the buffer, as vec will expect this.
2311 if other.is_contiguous() {
2312 ptr::copy(buf.offset(tail as isize), buf, len);
2314 if (tail - head) >= cmp::min((cap - tail), head) {
2315 // There is enough free space in the centre for the shortest block so we can
2316 // do this in at most three copy moves.
2317 if (cap - tail) > head {
2318 // right hand block is the long one; move that enough for the left
2319 ptr::copy(buf.offset(tail as isize),
2320 buf.offset((tail - head) as isize),
2322 // copy left in the end
2323 ptr::copy(buf, buf.offset((cap - head) as isize), head);
2324 // shift the new thing to the start
2325 ptr::copy(buf.offset((tail - head) as isize), buf, len);
2327 // left hand block is the long one, we can do it in two!
2328 ptr::copy(buf, buf.offset((cap - tail) as isize), head);
2329 ptr::copy(buf.offset(tail as isize), buf, cap - tail);
2332 // Need to use N swaps to move the ring
2333 // We can use the space at the end of the ring as a temp store
2335 let mut left_edge: usize = 0;
2336 let mut right_edge: usize = tail;
2338 // The general problem looks like this
2339 // GHIJKLM...ABCDEF - before any swaps
2340 // ABCDEFM...GHIJKL - after 1 pass of swaps
2341 // ABCDEFGHIJM...KL - swap until the left edge reaches the temp store
2342 // - then restart the algorithm with a new (smaller) store
2343 // Sometimes the temp store is reached when the right edge is at the end
2344 // of the buffer - this means we've hit the right order with fewer swaps!
2347 // ABCDEF.. - after four only swaps we've finished
2349 while left_edge < len && right_edge != cap {
2350 let mut right_offset = 0;
2351 for i in left_edge..right_edge {
2352 right_offset = (i - left_edge) % (cap - right_edge);
2353 let src: isize = (right_edge + right_offset) as isize;
2354 ptr::swap(buf.offset(i as isize), buf.offset(src));
2356 let n_ops = right_edge - left_edge;
2358 right_edge += right_offset + 1;
2364 let out = Vec::from_raw_parts(buf, len, cap);
2375 use super::VecDeque;
2378 fn bench_push_back_100(b: &mut test::Bencher) {
2379 let mut deq = VecDeque::with_capacity(101);
2390 fn bench_push_front_100(b: &mut test::Bencher) {
2391 let mut deq = VecDeque::with_capacity(101);
2402 fn bench_pop_back_100(b: &mut test::Bencher) {
2403 let mut deq = VecDeque::<i32>::with_capacity(101);
2408 while !deq.is_empty() {
2409 test::black_box(deq.pop_back());
2415 fn bench_pop_front_100(b: &mut test::Bencher) {
2416 let mut deq = VecDeque::<i32>::with_capacity(101);
2421 while !deq.is_empty() {
2422 test::black_box(deq.pop_front());
2428 fn test_swap_front_back_remove() {
2429 fn test(back: bool) {
2430 // This test checks that every single combination of tail position and length is tested.
2431 // Capacity 15 should be large enough to cover every case.
2432 let mut tester = VecDeque::with_capacity(15);
2433 let usable_cap = tester.capacity();
2434 let final_len = usable_cap / 2;
2436 for len in 0..final_len {
2437 let expected = if back {
2440 (0..len).rev().collect()
2442 for tail_pos in 0..usable_cap {
2443 tester.tail = tail_pos;
2444 tester.head = tail_pos;
2446 for i in 0..len * 2 {
2447 tester.push_front(i);
2450 assert_eq!(tester.swap_remove_back(i), Some(len * 2 - 1 - i));
2453 for i in 0..len * 2 {
2454 tester.push_back(i);
2457 let idx = tester.len() - 1 - i;
2458 assert_eq!(tester.swap_remove_front(idx), Some(len * 2 - 1 - i));
2461 assert!(tester.tail < tester.cap());
2462 assert!(tester.head < tester.cap());
2463 assert_eq!(tester, expected);
2473 // This test checks that every single combination of tail position, length, and
2474 // insertion position is tested. Capacity 15 should be large enough to cover every case.
2476 let mut tester = VecDeque::with_capacity(15);
2477 // can't guarantee we got 15, so have to get what we got.
2478 // 15 would be great, but we will definitely get 2^k - 1, for k >= 4, or else
2479 // this test isn't covering what it wants to
2480 let cap = tester.capacity();
2483 // len is the length *after* insertion
2485 // 0, 1, 2, .., len - 1
2486 let expected = (0..).take(len).collect();
2487 for tail_pos in 0..cap {
2488 for to_insert in 0..len {
2489 tester.tail = tail_pos;
2490 tester.head = tail_pos;
2493 tester.push_back(i);
2496 tester.insert(to_insert, to_insert);
2497 assert!(tester.tail < tester.cap());
2498 assert!(tester.head < tester.cap());
2499 assert_eq!(tester, expected);
2507 // This test checks that every single combination of tail position, length, and
2508 // removal position is tested. Capacity 15 should be large enough to cover every case.
2510 let mut tester = VecDeque::with_capacity(15);
2511 // can't guarantee we got 15, so have to get what we got.
2512 // 15 would be great, but we will definitely get 2^k - 1, for k >= 4, or else
2513 // this test isn't covering what it wants to
2514 let cap = tester.capacity();
2516 // len is the length *after* removal
2517 for len in 0..cap - 1 {
2518 // 0, 1, 2, .., len - 1
2519 let expected = (0..).take(len).collect();
2520 for tail_pos in 0..cap {
2521 for to_remove in 0..len + 1 {
2522 tester.tail = tail_pos;
2523 tester.head = tail_pos;
2526 tester.push_back(1234);
2528 tester.push_back(i);
2530 if to_remove == len {
2531 tester.push_back(1234);
2533 tester.remove(to_remove);
2534 assert!(tester.tail < tester.cap());
2535 assert!(tester.head < tester.cap());
2536 assert_eq!(tester, expected);
2544 let mut tester: VecDeque<usize> = VecDeque::with_capacity(7);
2546 let cap = tester.capacity();
2547 for len in 0..cap + 1 {
2548 for tail in 0..cap + 1 {
2549 for drain_start in 0..len + 1 {
2550 for drain_end in drain_start..len + 1 {
2554 tester.push_back(i);
2557 // Check that we drain the correct values
2558 let drained: VecDeque<_> = tester.drain(drain_start..drain_end).collect();
2559 let drained_expected: VecDeque<_> = (drain_start..drain_end).collect();
2560 assert_eq!(drained, drained_expected);
2562 // We shouldn't have changed the capacity or made the
2563 // head or tail out of bounds
2564 assert_eq!(tester.capacity(), cap);
2565 assert!(tester.tail < tester.cap());
2566 assert!(tester.head < tester.cap());
2568 // We should see the correct values in the VecDeque
2569 let expected: VecDeque<_> = (0..drain_start)
2570 .chain(drain_end..len)
2572 assert_eq!(expected, tester);
2580 fn test_shrink_to_fit() {
2581 // This test checks that every single combination of head and tail position,
2582 // is tested. Capacity 15 should be large enough to cover every case.
2584 let mut tester = VecDeque::with_capacity(15);
2585 // can't guarantee we got 15, so have to get what we got.
2586 // 15 would be great, but we will definitely get 2^k - 1, for k >= 4, or else
2587 // this test isn't covering what it wants to
2588 let cap = tester.capacity();
2590 let max_cap = tester.capacity();
2592 for len in 0..cap + 1 {
2593 // 0, 1, 2, .., len - 1
2594 let expected = (0..).take(len).collect();
2595 for tail_pos in 0..max_cap + 1 {
2596 tester.tail = tail_pos;
2597 tester.head = tail_pos;
2600 tester.push_back(i);
2602 tester.shrink_to_fit();
2603 assert!(tester.capacity() <= cap);
2604 assert!(tester.tail < tester.cap());
2605 assert!(tester.head < tester.cap());
2606 assert_eq!(tester, expected);
2612 fn test_split_off() {
2613 // This test checks that every single combination of tail position, length, and
2614 // split position is tested. Capacity 15 should be large enough to cover every case.
2616 let mut tester = VecDeque::with_capacity(15);
2617 // can't guarantee we got 15, so have to get what we got.
2618 // 15 would be great, but we will definitely get 2^k - 1, for k >= 4, or else
2619 // this test isn't covering what it wants to
2620 let cap = tester.capacity();
2622 // len is the length *before* splitting
2624 // index to split at
2625 for at in 0..len + 1 {
2626 // 0, 1, 2, .., at - 1 (may be empty)
2627 let expected_self = (0..).take(at).collect();
2628 // at, at + 1, .., len - 1 (may be empty)
2629 let expected_other = (at..).take(len - at).collect();
2631 for tail_pos in 0..cap {
2632 tester.tail = tail_pos;
2633 tester.head = tail_pos;
2635 tester.push_back(i);
2637 let result = tester.split_off(at);
2638 assert!(tester.tail < tester.cap());
2639 assert!(tester.head < tester.cap());
2640 assert!(result.tail < result.cap());
2641 assert!(result.head < result.cap());
2642 assert_eq!(tester, expected_self);
2643 assert_eq!(result, expected_other);
2650 fn test_from_vec() {
2651 use super::super::vec::Vec;
2653 for len in 0..cap + 1 {
2654 let mut vec = Vec::with_capacity(cap);
2657 let vd = VecDeque::from(vec.clone());
2658 assert!(vd.cap().is_power_of_two());
2659 assert_eq!(vd.len(), vec.len());
2660 assert!(vd.into_iter().eq(vec));
2666 fn test_vec_from_vecdeque() {
2667 use super::super::vec::Vec;
2669 fn create_vec_and_test_convert(cap: usize, offset: usize, len: usize) {
2670 let mut vd = VecDeque::with_capacity(cap);
2671 for _ in 0..offset {
2677 let vec: Vec<_> = Vec::from(vd.clone());
2678 assert_eq!(vec.len(), vd.len());
2679 assert!(vec.into_iter().eq(vd));
2682 for cap_pwr in 0..7 {
2683 // Make capacity as a (2^x)-1, so that the ring size is 2^x
2684 let cap = (2i32.pow(cap_pwr) - 1) as usize;
2686 // In these cases there is enough free space to solve it with copies
2687 for len in 0..((cap + 1) / 2) {
2688 // Test contiguous cases
2689 for offset in 0..(cap - len) {
2690 create_vec_and_test_convert(cap, offset, len)
2693 // Test cases where block at end of buffer is bigger than block at start
2694 for offset in (cap - len)..(cap - (len / 2)) {
2695 create_vec_and_test_convert(cap, offset, len)
2698 // Test cases where block at start of buffer is bigger than block at end
2699 for offset in (cap - (len / 2))..cap {
2700 create_vec_and_test_convert(cap, offset, len)
2704 // Now there's not (necessarily) space to straighten the ring with simple copies,
2705 // the ring will use swapping when:
2706 // (cap + 1 - offset) > (cap + 1 - len) && (len - (cap + 1 - offset)) > (cap + 1 - len))
2707 // right block size > free space && left block size > free space
2708 for len in ((cap + 1) / 2)..cap {
2709 // Test contiguous cases
2710 for offset in 0..(cap - len) {
2711 create_vec_and_test_convert(cap, offset, len)
2714 // Test cases where block at end of buffer is bigger than block at start
2715 for offset in (cap - len)..(cap - (len / 2)) {
2716 create_vec_and_test_convert(cap, offset, len)
2719 // Test cases where block at start of buffer is bigger than block at end
2720 for offset in (cap - (len / 2))..cap {
2721 create_vec_and_test_convert(cap, offset, len)