Struct bevy_utils::Parallel

source ·
pub struct Parallel<T: Send> { /* private fields */ }
Expand description

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

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

Implementations§

source§

impl<T: Send> Parallel<T>

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

source

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

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

source

pub fn clear(&mut self)

Clears all of the stored thread local values.

source§

impl<T: Default + Send> Parallel<T>

source

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.

source

pub fn borrow_local_mut(&self) -> impl DerefMut<Target = T> + '_

Mutably borrows the thread-local value.

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

source§

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

source

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.

source§

impl<T: Send> Parallel<Vec<T>>

source

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§

source§

impl<T: Default + Send> Default for Parallel<T>

source§

fn default() -> Parallel<T>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for Parallel<T>

§

impl<T> RefUnwindSafe for Parallel<T>

§

impl<T> Send for Parallel<T>

§

impl<T> Sync for Parallel<T>

§

impl<T> Unpin for Parallel<T>

§

impl<T> UnwindSafe for Parallel<T>
where T: UnwindSafe,

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>,

§

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>,

§

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,