Struct Scope 

pub struct Scope<'s> { /* private fields */ }

A Scoped object that you can run fork-join workloads on.

Examples

let mut tp = ThreadPool::new();
let mut s = tp.scope();

let mut vals = [0; 2];
let (left, right) = vals.split_at_mut(1);

s.join(|_| left[0] = 1, |_| right[0] = 1);

assert_eq!(vals, [1; 2]);

Implementations

impl<'s> Scope<'s>

pub fn global() -> Scope<'static>

Returns the global scope.

Examples

let _s = Scope::global();

pub fn join<A, B, RA, RB>(&mut self, a: A, b: B) -> (RA, RB)

where A: FnOnce(&mut Scope<'_>) -> RA + Send, B: FnOnce(&mut Scope<'_>) -> RB + Send, RA: Send, RB: Send,

Runs a and b potentially in parallel on separate threads and returns the results.

This variant skips checking for a heartbeat every 16 calls for improved performance.

Examples

let mut vals = [0; 2];
let (left, right) = vals.split_at_mut(1);

Scope::global().join(|_| left[0] = 1, |_| right[0] = 1);

assert_eq!(vals, [1; 2]);

pub fn join_with_heartbeat_every<const TIMES: u8, A, B, RA, RB>( &mut self, a: A, b: B, ) -> (RA, RB)

where A: FnOnce(&mut Scope<'_>) -> RA + Send, B: FnOnce(&mut Scope<'_>) -> RB + Send, RA: Send, RB: Send,

Runs a and b potentially in parallel on separate threads and returns the results.

This variant skips checking for a heartbeat every TIMES - 1 calls for improved performance.

Examples

let mut vals = [0; 2];
let (left, right) = vals.split_at_mut(1);

// Skip checking 7/8 calls to join_with_heartbeat_every.
Scope::global().join_with_heartbeat_every::<8, _, _, _, _>(|_| left[0] = 1, |_| right[0] = 1);

assert_eq!(vals, [1; 2]);

Trait Implementations

impl<'s> Debug for Scope<'s>

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

Formats the value using the given formatter.