Struct UnadoptedScope 

pub struct UnadoptedScope { /* private fields */ }

A scope that no process owns yet.

The scope holds the children that are spawned into it until a worker adopts it. Then the children start as children of that worker. If the UnadoptedScope is dropped before a worker adopts it, the scope closes, and it drops the children that wait and each child that is spawned into it later.

Most code does not use this type. Every supervised worker already has a scope, which is available through current or spawn.

Implementations

impl UnadoptedScope

pub fn new<N: Into<String>>(name: N) -> Self

Creates a scope that no process owns yet.

pub fn scope(&self) -> &Scope

Returns a handle to the scope, through which children can be spawned into it before a worker adopts it.

pub fn into_host(self) -> ChildSpecification<WorkerSpec>

Describes a worker that owns this scope, for a supervisor to add as a child.

The worker only holds the children of the scope. It runs until it is told to stop, and then the scope closes. Use this for work that is spawned outside supervised processes, such as work at startup before the supervision tree runs. The worker makes that work part of the tree when the tree runs. The worker fails if one of the children of the scope fails its owner. The worker passes that failure to the supervisor or scope that it is added to.

If the supervisor starts the worker again, for example because the supervisor restarts, the new worker holds nothing. The scope closed when the first worker stopped, and the scope drops each child that is spawned into it after that.

Trait Implementations

impl Debug for UnadoptedScope

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

Formats the value using the given formatter.

impl Drop for UnadoptedScope

fn drop(&mut self)

Executes the destructor for this type.