Struct SupervisorHandle 

pub struct SupervisorHandle { /* private fields */ }

Controls a running supervisor. Cheap to clone.

Dropping the last handle shuts the supervisor down gracefully.

Implementations

impl SupervisorHandle

pub async fn add_task( &self, name: &str, task: impl SupervisedTask, ) -> Result<(), SupervisorHandleError>

Registers and starts a task. Returns once it is Running.

pub async fn restart_task( &self, name: &str, ) -> Result<(), SupervisorHandleError>

Restarts a task with an empty restart history and returns once the new run is Running.

A running task is cancelled first and has stop_timeout to exit. Returns Closed if the supervisor shuts down before the new run starts.

pub async fn kill_task(&self, name: &str) -> Result<(), SupervisorHandleError>

Stops a task permanently and returns once it is Dead, which takes at most stop_timeout. Idempotent.

pub async fn task_status( &self, name: &str, ) -> Result<TaskStatus, SupervisorHandleError>

Current status of one task.

pub async fn task_statuses( &self, ) -> Result<HashMap<Arc<str>, TaskStatus>, SupervisorHandleError>

Current status of every task, keyed by name.

pub async fn shutdown(&self) -> Result<(), SupervisorError>

Cancels every task, waits for them to exit (bounded by stop_timeout) and returns the supervisor outcome. Same as wait if the supervisor already exited.

pub async fn wait(&self) -> Result<(), SupervisorError>

Waits for the supervisor to exit. Can be awaited any number of times, from any clone.

Trait Implementations

impl Clone for SupervisorHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SupervisorHandle

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

Formats the value using the given formatter.