Struct SupervisorHandle 

pub struct SupervisorHandle { /* private fields */ }

A handle for spawning dynamic children on a running Supervisor.

Obtained from Supervisor::handle. Handles are cheap to clone and can be shared across tasks. Spawning is async: the request is handed to the running supervisor and the call returns once the child has been started. If the supervisor isn’t currently running, spawning returns SpawnError::SupervisorGone.

Implementations

impl SupervisorHandle

pub fn name(&self) -> &str

Returns the name of the supervisor this handle refers to.

pub async fn spawn<T: Supervisable + 'static>( &self, worker: T, ) -> Result<ChildId, SpawnError>

Spawns a new dynamic worker.

Dynamic workers are temporary children that are not restarted by the supervisor when they die or when the supervisor itself is restarted. They are useful for short-lived, non-critical background tasks that require structured concurrency: the process should be cancelled when the supervisor itself is restarted or terminated, and so on.

Use spawn_with to configure the child’s restart policy or significance.

Errors

If the supervisor isn’t current running, or if the child specification is invalid, an error is returned.

pub async fn spawn_with( &self, spec: ChildSpecification<WorkerSpec>, ) -> Result<ChildId, SpawnError>

Spawns a new dynamic child from a fully configured ChildSpecification.

Dynamic workers are temporary children that are not restarted by the supervisor when they die or when the supervisor itself is restarted. They are useful for short-lived, non-critical background tasks that require structured concurrency: the process should be cancelled when the supervisor itself is restarted or terminated, and so on.

This method allows for configuring more advanced aspects of the child process, such as its restart type and significance.

Errors

If the supervisor isn’t current running, or if the child specification is invalid, an error is returned.

pub fn is_running(&self) -> bool

Returns whether the supervisor is currently running.

pub fn active_children(&self) -> usize

Returns the number of dynamic children currently running under the supervisor.

Trait Implementations

impl Clone for SupervisorHandle

fn clone(&self) -> SupervisorHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.