Struct SupervisorHandle 

pub struct SupervisorHandle { /* private fields */ }

Handle used to interact with the Supervisor.

Cloning this handle is cheap. All clones share the same connection to the supervisor. Multiple clones can call wait() concurrently and all will receive the result.

Implementations

impl SupervisorHandle

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

Waits for the supervisor to complete its execution.

Multiple callers can wait() concurrently; all will receive the same result.

Returns

• Ok(()) if the supervisor completed successfully.
• Err(SupervisorError) if the supervisor returned an error.

pub fn add_task<T: SupervisedTask + Clone>( &self, task_name: &str, task: T, ) -> Result<(), SupervisorHandleError>

Adds a new task to the supervisor.

Arguments

• task_name: The unique name of the task.
• task: The task to be added, which must implement SupervisedTask.

Returns

• Ok(()) if the message was sent successfully.
• Err(SendError) if the supervisor is no longer running.

pub fn restart(&self, task_name: &str) -> Result<(), SupervisorHandleError>

Requests the supervisor to restart a specific task.

Arguments

• task_name: The name of the task to restart.

Returns

• Ok(()) if the message was sent successfully.
• Err(SendError) if the supervisor is no longer running.

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

Requests the supervisor to kill a specific task.

Arguments

• task_name: The name of the task to kill.

Returns

• Ok(()) if the message was sent successfully.
• Err(SendError) if the supervisor is no longer running.

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

Requests the supervisor to shut down all tasks and stop supervision.

Returns

• Ok(()) if the message was sent successfully.
• Err(SendError) if the supervisor is no longer running.

pub async fn get_task_status( &self, task_name: &str, ) -> Result<Option<TaskStatus>, SupervisorHandleError>

Queries the status of a specific task asynchronously.

Arguments

• task_name: The name of the task to query.

Returns

• Ok(Some(TaskStatus)) if the task exists and its status is returned.
• Ok(None) if the task does not exist.
• Err(RecvError) if communication with the supervisor fails (e.g., it has shut down).

pub async fn get_all_task_statuses( &self, ) -> Result<HashMap<String, TaskStatus>, SupervisorHandleError>

Queries the statuses of all tasks asynchronously.

Returns

• Ok(HashMap<TaskName, TaskStatus>) containing the statuses of all tasks.
• Err(RecvError) if communication with the supervisor fails (e.g., it has shut down).

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.

impl Debug for SupervisorHandle

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

Formats the value using the given formatter.

impl Drop for SupervisorHandle

fn drop(&mut self)

Automatically shuts down the supervisor when the handle is dropped.