Struct Scope

source

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

Expand description

Represents a fork-join scope which can be used to spawn any number of tasks. See scope() for more information.

Implementations§

source §

impl<'scope> Scope<'scope>

source

pub fn spawn<BODY>(&self, body: BODY)
where BODY: FnOnce(&Scope<'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.

§Returns

Nothing. The spawned closures cannot pass back values to the caller directly, though they can write to local variables on the stack (if those variables outlive the scope) or communicate through shared channels.

(The intention is to eventually integrate with Rust futures to support spawns of functions that compute a value.)

§Examples

let mut value_a = None;
let mut value_b = None;
let mut value_c = None;
rayon::scope(|s| {
    s.spawn(|s1| {
          // ^ this is the same scope as `s`; this handle `s1`
          //   is intended for use by the spawned task,
          //   since scope handles cannot cross thread boundaries.

        value_a = Some(22);

        // the scope `s` will not end until all these tasks are done
        s1.spawn(|_| {
            value_b = Some(44);
        });
    });

    s.spawn(|_| {
        value_c = Some(66);
    });
});
assert_eq!(value_a, Some(22));
assert_eq!(value_b, Some(44));
assert_eq!(value_c, Some(66));

§See also

The scope function has more extensive documentation about task spawning.

source

pub fn spawn_broadcast<BODY>(&self, body: BODY)
where BODY: Fn(&Scope<'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.