Struct bevy_ecs::query::QueryParIter
source · pub struct QueryParIter<'w, 's, D: QueryData, F: QueryFilter> { /* private fields */ }
Expand description
A parallel iterator over query results of a Query
.
This struct is created by the Query::par_iter
and
Query::par_iter_mut
methods.
Implementations§
source§impl<'w, 's, D: QueryData, F: QueryFilter> QueryParIter<'w, 's, D, F>
impl<'w, 's, D: QueryData, F: QueryFilter> QueryParIter<'w, 's, D, F>
sourcepub fn batching_strategy(self, strategy: BatchingStrategy) -> Self
pub fn batching_strategy(self, strategy: BatchingStrategy) -> Self
Changes the batching strategy used when iterating.
For more information on how this affects the resultant iteration, see
BatchingStrategy
.
sourcepub fn for_each<FN: Fn(QueryItem<'w, D>) + Send + Sync + Clone>(self, func: FN)
pub fn for_each<FN: Fn(QueryItem<'w, D>) + Send + Sync + Clone>(self, func: FN)
Runs func
on each query result in parallel.
§Panics
If the ComputeTaskPool
is not initialized. If using this from a query that is being
initialized and run from the ECS scheduler, this should never panic.
sourcepub fn for_each_init<FN, INIT, T>(self, init: INIT, func: FN)
pub fn for_each_init<FN, INIT, T>(self, init: INIT, func: FN)
Runs func
on each query result in parallel on a value returned by init
.
init
may be called multiple times per thread, and the values returned may be discarded between tasks on any given thread.
Callers should avoid using this function as if it were a parallel version
of Iterator::fold
.
§Example
use bevy_utils::Parallel;
use crate::{bevy_ecs::prelude::Component, bevy_ecs::system::Query};
#[derive(Component)]
struct T;
fn system(query: Query<&T>){
let mut queue: Parallel<usize> = Parallel::default();
// queue.borrow_local_mut() will get or create a thread_local queue for each task/thread;
query.par_iter().for_each_init(|| queue.borrow_local_mut(),|local_queue,item| {
**local_queue += 1;
});
// collect value from every thread
let entity_count: usize = queue.iter_mut().map(|v| *v).sum();
}
§Panics
If the ComputeTaskPool
is not initialized. If using this from a query that is being
initialized and run from the ECS scheduler, this should never panic.
Auto Trait Implementations§
impl<'w, 's, D, F> Freeze for QueryParIter<'w, 's, D, F>
impl<'w, 's, D, F> !RefUnwindSafe for QueryParIter<'w, 's, D, F>
impl<'w, 's, D, F> Send for QueryParIter<'w, 's, D, F>
impl<'w, 's, D, F> Sync for QueryParIter<'w, 's, D, F>
impl<'w, 's, D, F> Unpin for QueryParIter<'w, 's, D, F>
impl<'w, 's, D, F> !UnwindSafe for QueryParIter<'w, 's, D, F>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.