bevy_ecs::event

Struct EventParIter

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

A parallel iterator over Events.

Implementations§

Source§

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

Source

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

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

Source

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.

Source

pub fn for_each<FN: Fn(&'a E) + Send + Sync + Clone>(self, func: FN)

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.

Source

pub fn for_each_with_id<FN: Fn(&'a E, EventId<E>) + Send + Sync + Clone>( self, func: FN, )

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.

Source

pub fn len(&self) -> usize

Returns the number of Events to be iterated.

Source

pub fn is_empty(&self) -> bool

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

Trait Implementations§

Source§

impl<'a, E: Debug + Event> Debug for EventParIter<'a, E>

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

type IntoIter = EventIteratorWithId<'a, E>

Which kind of iterator are we turning this into?
Source§

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

The type of the elements being iterated over.
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

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

§

impl<'a, E> RefUnwindSafe for EventParIter<'a, E>
where E: RefUnwindSafe,

§

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

§

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

§

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

§

impl<'a, E> !UnwindSafe for EventParIter<'a, E>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,