Trait bevy::tasks::prelude::ParallelIterator
[−]pub trait ParallelIterator<B>: Send where
B: Iterator<Item = Self::Item> + Send, {
type Item;
Show 32 methods
fn next_batch(&mut self) -> Option<B>;
fn size_hint(&self) -> (usize, Option<usize>) { ... }
fn count(self, pool: &TaskPool) -> usize { ... }
fn last(self, _pool: &TaskPool) -> Option<Self::Item> { ... }
fn nth(self, _pool: &TaskPool, n: usize) -> Option<Self::Item> { ... }
fn chain<U>(self, other: U) -> Chain<Self, U>
where
U: ParallelIterator<B, Item = Self::Item>,
{ ... }
fn map<T, F>(self, f: F) -> Map<Self, F>
where
F: FnMut(Self::Item) -> T + Send + Clone,
{ ... }
fn for_each<F>(self, pool: &TaskPool, f: F)
where
F: FnMut(Self::Item) + Send + Clone + Sync,
{ ... }
fn filter<F>(self, predicate: F) -> Filter<Self, F>
where
F: FnMut(&Self::Item) -> bool,
{ ... }
fn filter_map<R, F>(self, f: F) -> FilterMap<Self, F>
where
F: FnMut(Self::Item) -> Option<R>,
{ ... }
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, F>
where
F: FnMut(Self::Item) -> U,
U: IntoIterator,
{ ... }
fn flatten(self) -> Flatten<Self>
where
Self::Item: IntoIterator,
{ ... }
fn fuse(self) -> Fuse<Self> { ... }
fn inspect<F>(self, f: F) -> Inspect<Self, F>
where
F: FnMut(&Self::Item),
{ ... }
fn by_ref(&mut self) -> &mut Self { ... }
fn collect<C>(self, pool: &TaskPool) -> C
where
C: FromIterator<Self::Item>,
Self::Item: 'static,
Self::Item: Send,
{ ... }
fn partition<C, F>(self, pool: &TaskPool, f: F) -> (C, C)
where
C: Default + Extend<Self::Item> + Send,
F: FnMut(&Self::Item) -> bool + Send + Sync + Clone,
Self::Item: 'static,
Self::Item: Send,
{ ... }
fn fold<C, F, D>(self, pool: &TaskPool, init: C, f: F) -> Vec<C, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
where
F: FnMut(C, Self::Item) -> C + Send + Sync + Clone,
C: 'static + Clone + Send + Sync,
{ ... }
fn all<F>(self, pool: &TaskPool, f: F) -> bool
where
F: FnMut(Self::Item) -> bool + Send + Sync + Clone,
{ ... }
fn any<F>(self, pool: &TaskPool, f: F) -> bool
where
F: FnMut(Self::Item) -> bool + Send + Sync + Clone,
{ ... }
fn position<F>(self, pool: &TaskPool, f: F) -> Option<usize>
where
F: FnMut(Self::Item) -> bool + Send + Sync + Clone,
{ ... }
fn max(self, pool: &TaskPool) -> Option<Self::Item>
where
Self::Item: 'static,
Self::Item: Ord,
Self::Item: Send,
{ ... }
fn min(self, pool: &TaskPool) -> Option<Self::Item>
where
Self::Item: 'static,
Self::Item: Ord,
Self::Item: Send,
{ ... }
fn max_by_key<R, F>(self, pool: &TaskPool, f: F) -> Option<Self::Item>
where
R: Ord,
F: FnMut(&Self::Item) -> R + Send + Sync + Clone,
Self::Item: 'static,
Self::Item: Send,
{ ... }
fn max_by<F>(self, pool: &TaskPool, f: F) -> Option<Self::Item>
where
F: FnMut(&Self::Item, &Self::Item) -> Ordering + Send + Sync + Clone,
Self::Item: 'static,
Self::Item: Send,
{ ... }
fn min_by_key<R, F>(self, pool: &TaskPool, f: F) -> Option<Self::Item>
where
R: Ord,
F: FnMut(&Self::Item) -> R + Send + Sync + Clone,
Self::Item: 'static,
Self::Item: Send,
{ ... }
fn min_by<F>(self, pool: &TaskPool, f: F) -> Option<Self::Item>
where
F: FnMut(&Self::Item, &Self::Item) -> Ordering + Send + Sync + Clone,
Self::Item: 'static,
Self::Item: Send,
{ ... }
fn copied<'a, T>(self) -> Copied<Self>
where
Self: ParallelIterator<B, Item = &'a T>,
T: 'a + Copy,
{ ... }
fn cloned<'a, T>(self) -> Cloned<Self>
where
Self: ParallelIterator<B, Item = &'a T>,
T: 'a + Copy,
{ ... }
fn cycle(self) -> Cycle<Self>
where
Self: Clone,
{ ... }
fn sum<S, R>(self, pool: &TaskPool) -> R
where
S: 'static + Sum<Self::Item> + Send,
R: Sum<S>,
{ ... }
fn product<S, R>(self, pool: &TaskPool) -> R
where
S: 'static + Product<Self::Item> + Send,
R: Product<S>,
{ ... }
}
Expand description
ParallelIterator
closely emulates the std::iter::Iterator
interface. However, it uses bevy_task
to compute batches in parallel.
Note that the overhead of ParallelIterator
is high relative to some
workloads. In particular, if the batch size is too small or task being
run in parallel is inexpensive, a ParallelIterator
could take longer
than a normal Iterator
. Therefore, you should profile your code before
using ParallelIterator
.
Associated Types
type Item
Required methods
fn next_batch(&mut self) -> Option<B>
fn next_batch(&mut self) -> Option<B>
Returns the next batch of items for processing.
Each batch is an iterator with items of the same type as the
ParallelIterator
. Returns None
when there are no batches left.
Provided methods
Returns the bounds on the remaining number of items in the parallel iterator.
Consumes the parallel iterator and returns the number of items.
Consumes the parallel iterator and returns the last item.
See Iterator::last()
Consumes the parallel iterator and returns the nth item.
See Iterator::nth()
fn chain<U>(self, other: U) -> Chain<Self, U> where
U: ParallelIterator<B, Item = Self::Item>,
fn chain<U>(self, other: U) -> Chain<Self, U> where
U: ParallelIterator<B, Item = Self::Item>,
Takes two parallel iterators and returns a parallel iterators over both in sequence.
Takes a closure and creates a parallel iterator which calls that closure on each item.
See Iterator::map()
Calls a closure on each item of a parallel iterator.
Creates a parallel iterator which uses a closure to determine if an element should be yielded.
fn filter_map<R, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<R>,
fn filter_map<R, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<R>,
Creates a parallel iterator that both filters and maps.
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, F> where
F: FnMut(Self::Item) -> U,
U: IntoIterator,
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, F> where
F: FnMut(Self::Item) -> U,
U: IntoIterator,
Creates a parallel iterator that works like map, but flattens nested structure.
fn flatten(self) -> Flatten<Self> where
Self::Item: IntoIterator,
fn flatten(self) -> Flatten<Self> where
Self::Item: IntoIterator,
Creates a parallel iterator that flattens nested structure.
fn fuse(self) -> Fuse<Self>
fn fuse(self) -> Fuse<Self>
Creates a parallel iterator which ends after the first None.
See Iterator::fuse()
Does something with each item of a parallel iterator, passing the value on.
Borrows a parallel iterator, rather than consuming it.
Transforms a parallel iterator into a collection.
Consumes a parallel iterator, creating two collections from it.
Repeatedly applies a function to items of each batch of a parallel iterator, producing a Vec of final values.
Note that this folds each batch independently and returns a Vec of results (in batch order).
See Iterator::fold()
Tests if every element of the parallel iterator matches a predicate.
Note that all is not short circuiting.
See Iterator::all()
Tests if any element of the parallel iterator matches a predicate.
Note that any is not short circuiting.
See Iterator::any()
Searches for an element in a parallel iterator, returning its index.
Note that position consumes the whole iterator.
Returns the maximum item of a parallel iterator.
See Iterator::max()
Returns the minimum item of a parallel iterator.
See Iterator::min()
Returns the item that gives the maximum value from the specified function.
Returns the item that gives the maximum value with respect to the specified comparison function.
Returns the item that gives the minimum value from the specified function.
Returns the item that gives the minimum value with respect to the specified comparison function.
fn copied<'a, T>(self) -> Copied<Self> where
Self: ParallelIterator<B, Item = &'a T>,
T: 'a + Copy,
fn copied<'a, T>(self) -> Copied<Self> where
Self: ParallelIterator<B, Item = &'a T>,
T: 'a + Copy,
Creates a parallel iterator which copies all of its items.
fn cloned<'a, T>(self) -> Cloned<Self> where
Self: ParallelIterator<B, Item = &'a T>,
T: 'a + Copy,
fn cloned<'a, T>(self) -> Cloned<Self> where
Self: ParallelIterator<B, Item = &'a T>,
T: 'a + Copy,
Creates a parallel iterator which clones all of its items.
Repeats a parallel iterator endlessly.
Sums the items of a parallel iterator.
See Iterator::sum()