MessageParIter

Struct MessageParIter 

Source
pub struct MessageParIter<'a, M: Message> { /* private fields */ }
Expand description

A parallel iterator over Messages.

Implementations§

Source§

impl<'a, M: Message> MessageParIter<'a, M>

Source

pub fn new(reader: &'a mut MessageCursor<M>, messages: &'a Messages<M>) -> Self

Creates a new parallel iterator over messages 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 M) + Send + Sync + Clone>(self, func: FN)

Runs the provided closure for each unread message in parallel.

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

§Panics

If the ComputeTaskPool is not initialized. If using this from a message 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 M, MessageId<M>) + Send + Sync + Clone>( self, func: FN, )

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

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

§Panics

If the ComputeTaskPool is not initialized. If using this from a message 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 Messages to be iterated.

Source

pub fn is_empty(&self) -> bool

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

Trait Implementations§

Source§

impl<'a, M: Debug + Message> Debug for MessageParIter<'a, M>

Source§

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

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

impl<'a, M: Message> IntoIterator for MessageParIter<'a, M>

Available on crate feature multi_threaded only.
Source§

type IntoIter = MessageIteratorWithId<'a, M>

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

type Item = <<MessageParIter<'a, M> 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, M> Freeze for MessageParIter<'a, M>

§

impl<'a, M> RefUnwindSafe for MessageParIter<'a, M>
where M: RefUnwindSafe,

§

impl<'a, M> Send for MessageParIter<'a, M>

§

impl<'a, M> Sync for MessageParIter<'a, M>

§

impl<'a, M> Unpin for MessageParIter<'a, M>

§

impl<'a, M> !UnwindSafe for MessageParIter<'a, M>

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &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)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
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> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
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,