Struct thread_tree::ThreadTreeCtx

pub struct ThreadTreeCtx<'a> { /* fields omitted */ }

A level-specific handle to the thread tree, that can be used to inject jobs.

See ThreadTree::top() for more information.

Implementations

impl<'_> ThreadTreeCtx<'_>

pub fn is_parallel(&self) -> bool

Return true if this level will parallelize in join (or if we are at the bottom of the tree)

pub fn join<A, B, RA, RB>(&self, a: A, b: B) -> (RA, RB) where
    A: FnOnce(ThreadTreeCtx<'_>) -> RA + Send,
    B: FnOnce(ThreadTreeCtx<'_>) -> RB + Send,
    RA: Send,
    RB: Send, 

Run a and b simultaneously (and return their results, if applicable).

A runs on the current thread while b runs on the sibling thread; each is passed a lower level of the thread tree (if applicable, or a stub if the bottom is reached).

Warning: functions that execute on worker threads here must not panic (it will abort on panic). Out of a and b, at most one will execute on a worker thread from here, and at least one (or both) will execute on the current thread.

Warning: You must not .join() into the same tree from nested jobs. Nested jobs must be spawned using the context that each job receives as the first parameter.

Trait Implementations

impl<'a> Clone for ThreadTreeCtx<'a>

pub fn clone(&self) -> ThreadTreeCtx<'a>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for ThreadTreeCtx<'a>

impl<'a> Debug for ThreadTreeCtx<'a>

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

Formats the value using the given formatter.