Struct Scope 

pub struct Scope { /* private fields */ }

A set of children owned by one process.

See the module documentation for a description of a scope. A Scope is a handle. A clone of it costs little, and any task can use it. A spawn through a Scope always succeeds. But, as with tokio::spawn, a successful spawn does not guarantee that the child runs. If a child is spawned after its scope closed, the child is dropped.

A handle does not hold the children that wait to start. The owner of the scope holds them, or the UnadoptedScope before a worker adopts the scope. Thus, a child can hold a handle to its own scope without keeping the scope alive.

Implementations

impl Scope

pub fn name(&self) -> &str

Returns the scope’s name.

pub fn spawn<S, T>(&self, child: T) -> ChildId

where S: ChildState, T: Into<ChildSpecification<S>>,

Spawns a child into the scope.

Accepts all values that SupervisorHandle::spawn accepts. This includes a nested supervisor. By default, the child is hosted.

The returned ChildId identifies the child in this scope.

pub fn enter<F: Future>(&self, fut: F) -> impl Future<Output = F::Output>

Runs fut with this scope as the current one.

If fut spawns into the current scope, the spawn goes into this scope instead. This applies to spawns through current, spawn, or nested. While fut runs, this scope replaces the scope that was current before.

pub fn enter_sync<R>(&self, f: impl FnOnce() -> R) -> R

Runs f with this scope as the current one.

This is the synchronous version of enter.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.