Struct ScopeFifo

pub struct ScopeFifo<'scope> { /* private fields */ }

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.

Implementations

impl<'scope> ScopeFifo<'scope>

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.

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

Auto Trait Implementations

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

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

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

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

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

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

impl<'scope> UnsafeUnpin for ScopeFifo<'scope>

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for ScopeFifo<'scope> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for ScopeFifo<'scope> where T: ?Sized,

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

impl<T> From<T> for ScopeFifo<'scope>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Pointable for ScopeFifo<'scope>

const ALIGN: usize = _;
type Init = T;
unsafe fn init(init: <T as Pointable>::Init) -> usize
unsafe fn deref<'a>(ptr: usize) -> &'a T
unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
unsafe fn drop(ptr: usize)

impl<T, U> Into<U> for ScopeFifo<'scope> 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, U> TryFrom<U> for ScopeFifo<'scope> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for ScopeFifo<'scope> where U: TryFrom<T>,

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