Trait DrainContainer

pub trait DrainContainer {
    type Item<'a>
       where Self: 'a;
    type DrainIter<'a>: Iterator<Item = Self::Item<'a>>
       where Self: 'a;

    // Required method
    fn drain(&mut self) -> Self::DrainIter<'_>;
}

A container that can drain itself.

Draining the container presents items in an implementation-specific order. The container is in an undefined state after calling [drain]. Dropping the iterator also leaves the container in an undefined state.

Required Associated Types

type Item<'a> where Self: 'a

The type of elements when draining the container.

type DrainIter<'a>: Iterator<Item = Self::Item<'a>> where Self: 'a

Iterator type when draining the container.

Required Methods

fn drain(&mut self) -> Self::DrainIter<'_>

Returns an iterator that drains the contents of this container. Drain leaves the container in an undefined state.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T> DrainContainer for Rc<T>

where T: IterContainer,

type Item<'a> = <T as IterContainer>::ItemRef<'a> where Rc<T>: 'a

type DrainIter<'a> = <T as IterContainer>::Iter<'a> where Rc<T>: 'a

fn drain(&mut self) -> <Rc<T> as DrainContainer>::DrainIter<'_>

impl<T> DrainContainer for Arc<T>

where T: IterContainer,

type Item<'a> = <T as IterContainer>::ItemRef<'a> where Arc<T>: 'a

type DrainIter<'a> = <T as IterContainer>::Iter<'a> where Arc<T>: 'a

fn drain(&mut self) -> <Arc<T> as DrainContainer>::DrainIter<'_>

impl<T> DrainContainer for Vec<T>

type Item<'a> = T where T: 'a

type DrainIter<'a> = Drain<'a, T> where Vec<T>: 'a

fn drain(&mut self) -> <Vec<T> as DrainContainer>::DrainIter<'_>

Implementors