Trait ParallelDrainFull

pub trait ParallelDrainFull {
    type Iter: ParallelIterator<Item = Self::Item>;
    type Item: Send;

    // Required method
    fn par_drain(self) -> Self::Iter;
}

Available on crate feature dep_rayon only.

ParallelDrainFull creates a parallel iterator that moves all items from a collection while retaining the original capacity.

Types which are indexable typically implement ParallelDrainRange instead, where you can drain fully with par_drain(..).

Required Associated Types

type Iter: ParallelIterator<Item = Self::Item>

The draining parallel iterator type that will be created.

type Item: Send

The type of item that the parallel iterator will produce. This is usually the same as IntoParallelIterator::Item.

Required Methods

fn par_drain(self) -> Self::Iter

Returns a draining parallel iterator over an entire collection.

When the iterator is dropped, all items are removed, even if the iterator was not fully consumed. If the iterator is leaked, for example using std::mem::forget, it is unspecified how many items are removed.

Examples

use rayon::prelude::*;
use std::collections::{BinaryHeap, HashSet};

let squares: HashSet<i32> = (0..10).map(|x| x * x).collect();

let mut heap: BinaryHeap<_> = squares.iter().copied().collect();
assert_eq!(
    // heaps are drained in arbitrary order
    heap.par_drain()
        .inspect(|x| assert!(squares.contains(x)))
        .count(),
    squares.len(),
);
assert!(heap.is_empty());
assert!(heap.capacity() >= squares.len());

Implementors

impl<'a, K, V, S> ParallelDrainFull for &'a mut HashMap<K, V, S>

where K: Hash + Eq + Send, V: Send, S: BuildHasher,

type Iter = Drain<'a, K, V>

type Item = (K, V)

impl<'a, T> ParallelDrainFull for &'a mut BinaryHeap<T>

where T: Ord + Send,

type Iter = Drain<'a, T>

type Item = T

impl<'a, T, S> ParallelDrainFull for &'a mut HashSet<T, S>

where T: Hash + Eq + Send, S: BuildHasher,

type Iter = Drain<'a, T>

type Item = T