Struct Drain

pub struct Drain<'a, T: 'a, A: Allocator = Global> { pub(in ::collections::vec_deque) deque: NonNull<VecDeque<T, A>>, pub(in ::collections::vec_deque) drain_len: usize, pub(in ::collections::vec_deque) idx: usize, pub(in ::collections::vec_deque) tail_len: usize, pub(in ::collections::vec_deque) remaining: usize, pub(in ::collections::vec_deque::drain) _marker: PhantomData<&'a T> }

A draining iterator over the elements of a VecDeque.

This struct is created by the drain method on VecDeque. See its documentation for more.

Fields

deque: NonNull<VecDeque<T, A>>
drain_len: usize
idx: usize
tail_len: usize
remaining: usize
_marker: PhantomData<&'a T>

Implementations

impl<'a, T, A: Allocator> Drain<'a, T, A>

unsafe fn new(deque: &'a mut VecDeque<T, A>, drain_start: usize, drain_len: usize) -> Self
unsafe fn as_slices(&self) -> (*mut [T], *mut [T])

impl<T, A: Allocator> Drain<'_, T, A>

unsafe fn fill<I: Iterator<Item = T>>(&mut self, replace_with: &mut I) -> bool

The range from self.deque.len to self.deque.len + self.drain_len contains elements that have been moved out. Fill that range as much as possible with new elements from the replace_with iterator. Returns true if we filled the entire range. (replace_with.next() didn’t return None.)

Safety

self.deque must be valid. self.deque.len and self.deque.len + self.drain_len must be less than twice the deque's capacity.

unsafe fn move_tail(&mut self, additional: usize)

Makes room for inserting more elements before the tail.

Safety

self.deque must be valid.

Trait Implementations

impl<T, A: Allocator> DoubleEndedIterator for Drain<'_, T, A>

fn next_back(&mut self) -> Option<T>

impl<T, A: Allocator> Drop for Drain<'_, T, A>

fn drop(&mut self)

impl<T, A: Allocator> ExactSizeIterator for Drain<'_, T, A>

impl<T, A: Allocator> FusedIterator for Drain<'_, T, A>

impl<T, A: Allocator> Iterator for Drain<'_, T, A>

type Item = T;
fn next(&mut self) -> Option<T>
fn size_hint(&self) -> (usize, Option<usize>)

impl<T: Debug, A: Allocator> Debug for Drain<'_, T, A>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<T: Send, A: Allocator + Send> Send for Drain<'_, T, A>

impl<T: Sync, A: Allocator + Sync> Sync for Drain<'_, T, A>

Auto Trait Implementations

impl<'a, T, A> Freeze for Drain<'a, T, A> where NonNull<VecDeque<T, A>>: Freeze, PhantomData<&'a T>: Freeze,

impl<'a, T, A> RefUnwindSafe for Drain<'a, T, A> where NonNull<VecDeque<T, A>>: RefUnwindSafe, PhantomData<&'a T>: RefUnwindSafe,

impl<'a, T, A> Unpin for Drain<'a, T, A> where NonNull<VecDeque<T, A>>: Unpin, PhantomData<&'a T>: Unpin,

impl<'a, T, A> UnsafeUnpin for Drain<'a, T, A> where NonNull<VecDeque<T, A>>: UnsafeUnpin, PhantomData<&'a T>: UnsafeUnpin,

impl<'a, T, A> UnwindSafe for Drain<'a, T, A> where NonNull<VecDeque<T, A>>: UnwindSafe, PhantomData<&'a T>: UnwindSafe,

Blanket Implementations

impl<I> IntoIterator for Drain<'a, T, A> where I: Iterator,

type Item = <I as Iterator>::Item;
type IntoIter = I;
fn into_iter(self) -> I

impl<T> Any for Drain<'a, T, A> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Drain<'a, T, A> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Drain<'a, T, A> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for Drain<'a, T, A>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> SizeHint for Drain<'a, T, A> where T: ?Sized,

fn lower_bound(&self) -> usize
fn upper_bound(&self) -> Option<usize>

impl<T> SizedTypeProperties for Drain<'a, T, A>

impl<T, U> Into<U> for Drain<'a, T, A> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for Drain<'a, T, A> where U: Into<T>,

type Error = Infallible;
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Drain<'a, T, A> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>