Struct bevy::utils::Parallel

pub struct Parallel<T>
where
    T: Send,
{ /* private fields */ }

A cohesive set of thread-local values of a given type.

Mutable references can be fetched if T: Default via Parallel::scope.

Implementations

impl<T> Parallel<T>

where T: Send,

A scope guard of a Parallel, when this struct is dropped ,the value will writeback to its Parallel

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Gets a mutable iterator over all of the per-thread queues.

pub fn clear(&mut self)

Clears all of the stored thread local values.

impl<T> Parallel<T>

where T: Default + Send,

pub fn scope<R>(&self, f: impl FnOnce(&mut T) -> R) -> R

Retrieves the thread-local value for the current thread and runs f on it.

If there is no thread-local value, it will be initialized to its default.

pub fn borrow_local_mut(&self) -> impl DerefMut

Mutably borrows the thread-local value.

If there is no thread-local value, it will be initialized to it’s default.

impl<T, I> Parallel<I>

where I: IntoIterator<Item = T> + Default + Send + 'static,

pub fn drain<B>(&mut self) -> impl Iterator<Item = T>

where B: FromIterator<T>,

Drains all enqueued items from all threads and returns an iterator over them.

Unlike Vec::drain, this will piecemeal remove chunks of the data stored. If iteration is terminated part way, the rest of the enqueued items in the same chunk will be dropped, and the rest of the undrained elements will remain.

The ordering is not guaranteed.

impl<T> Parallel<Vec<T>>

where T: Send,

pub fn drain_into(&mut self, out: &mut Vec<T>)

Collect all enqueued items from all threads and appends them to the end of a single Vec.

The ordering is not guaranteed.

Trait Implementations

impl<T> Default for Parallel<T>

where T: Default + Send,

fn default() -> Parallel<T>

Returns the “default value” for a type.