Struct valence::ecs::event::EventParIter

pub struct EventParIter<'a, E>
where
    E: Event,
{ /* private fields */ }

A parallel iterator over Events.

Implementations

impl<'a, E> EventParIter<'a, E>

where E: Event,

pub fn new( reader: &'a mut ManualEventReader<E>, events: &'a Events<E>, ) -> EventParIter<'a, E>

Creates a new parallel iterator over events that have not yet been seen by reader.

pub fn batching_strategy( self, strategy: BatchingStrategy, ) -> EventParIter<'a, E>

Changes the batching strategy used when iterating.

For more information on how this affects the resultant iteration, see BatchingStrategy.

pub fn for_each<FN>(self, func: FN)

where FN: Fn(&'a E) + Send + Sync + Clone,

Runs the provided closure for each unread event in parallel.

Unlike normal iteration, the event order is not guaranteed in any form.

Panics

If the ComputeTaskPool is not initialized. If using this from an event reader that is being initialized and run from the ECS scheduler, this should never panic.

pub fn for_each_with_id<FN>(self, func: FN)

where FN: Fn(&'a E, EventId<E>) + Send + Sync + Clone,

Runs the provided closure for each unread event in parallel, like for_each, but additionally provides the EventId to the closure.

Note that the order of iteration is not guaranteed, but EventIds are ordered by send order.

Panics

If the ComputeTaskPool is not initialized. If using this from an event reader that is being initialized and run from the ECS scheduler, this should never panic.

pub fn len(&self) -> usize

Returns the number of Events to be iterated.

pub fn is_empty(&self) -> bool

Returns true if there are no events remaining in this iterator.

Trait Implementations

impl<'a, E> Debug for EventParIter<'a, E>

where E: Debug + Event,

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

Formats the value using the given formatter.

impl<'a, E> IntoIterator for EventParIter<'a, E>

where E: Event,

type IntoIter = EventIteratorWithId<'a, E>

Which kind of iterator are we turning this into?

type Item = <<EventParIter<'a, E> as IntoIterator>::IntoIter as Iterator>::Item

The type of the elements being iterated over.

fn into_iter(self) -> <EventParIter<'a, E> as IntoIterator>::IntoIter

Creates an iterator from a value.