Struct rayon_core::ScopeFifo

pub struct ScopeFifo<'scope> {
    base: ScopeBase<'scope>,
    fifos: Vec<JobFifo>,
}

Expand description

Represents a fork-join scope which can be used to spawn any number of tasks. Those spawned from the same thread are prioritized in relative FIFO order. See scope_fifo() for more information.

Fields§

§base: ScopeBase<'scope>§fifos: Vec<JobFifo>

Implementations§

impl<'scope> ScopeFifo<'scope>

fn new(owner: Option<&WorkerThread>, registry: Option<&Arc<Registry>>) -> Self

pub fn spawn_fifo<BODY>(&self, body: BODY)
where BODY: FnOnce(&ScopeFifo<'scope>) + Send + 'scope,

Spawns a job into the fork-join scope self. This job will execute sometime before the fork-join scope completes. The job is specified as a closure, and this closure receives its own reference to the scope self as argument. This can be used to inject new jobs into self.

§See also

This method is akin to Scope::spawn(), but with a FIFO priority. The scope_fifo function has more details about this distinction.

pub fn spawn_broadcast<BODY>(&self, body: BODY)
where BODY: Fn(&ScopeFifo<'scope>, BroadcastContext<'_>) + Send + Sync + 'scope,

Spawns a job into every thread of the fork-join scope self. This job will execute on each thread sometime before the fork-join scope completes. The job is specified as a closure, and this closure receives its own reference to the scope self as argument, as well as a BroadcastContext.

Trait Implementations§

impl<'scope> Debug for ScopeFifo<'scope>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<'scope> !Freeze for ScopeFifo<'scope>

impl<'scope> !RefUnwindSafe for ScopeFifo<'scope>

impl<'scope> Send for ScopeFifo<'scope>

impl<'scope> Sync for ScopeFifo<'scope>

impl<'scope> Unpin for ScopeFifo<'scope>

impl<'scope> !UnwindSafe for ScopeFifo<'scope>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.