Struct SupervisorHandle 

pub struct SupervisorHandle<W: Worker> { /* private fields */ }

Handle used to interact with a running supervisor tree.

Implementations

impl<W: Worker> SupervisorHandle<W>

pub fn start(spec: SupervisorSpec<W>) -> Self

Spawns a supervisor tree based on the provided specification.

pub async fn start_child( &self, id: impl Into<String>, factory: impl Fn() -> W + Send + Sync + 'static, restart_policy: RestartPolicy, ) -> Result<ChildId, SupervisorError>

Dynamically starts a new child worker

Errors

Returns an error if the supervisor is shutting down or a child with this ID already exists.

pub async fn start_child_linked( &self, id: impl Into<String>, factory: impl Fn() -> W + Send + Sync + 'static, restart_policy: RestartPolicy, timeout: Duration, ) -> Result<ChildId, SupervisorError>

Dynamically starts a new child worker with linked initialization.

This method waits for the worker’s initialization to complete before returning. If initialization fails or times out, an error is returned and the worker is not added.

Arguments

• id - Unique identifier for the child
• factory - Factory function to create the worker
• restart_policy - How to handle worker termination after it starts running
• timeout - Maximum time to wait for initialization

Errors

• SupervisorError::InitializationFailed - Worker initialization returned an error
• SupervisorError::InitializationTimeout - Worker didn’t initialize within timeout
• SupervisorError::ChildAlreadyExists - A child with this ID already exists
• SupervisorError::ShuttingDown - Supervisor is shutting down

Note

Initialization failures do NOT trigger restart policies. The worker must successfully initialize before restart policies take effect.

pub async fn terminate_child(&self, id: &str) -> Result<(), SupervisorError>

Dynamically terminates a child

Errors

Returns an error if the child is not found or the supervisor is shutting down.

pub async fn which_children(&self) -> Result<Vec<ChildInfo>, SupervisorError>

Returns information about all children

Errors

Returns an error if the supervisor is shutting down.

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

Requests a graceful shutdown of the supervisor tree.

Errors

Returns an error if the supervisor channel is already closed.

pub fn name(&self) -> &str

Returns the supervisor’s name.

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

Returns the supervisor’s restart strategy.

Errors

Returns an error if the supervisor is shutting down.

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

Returns the supervisor’s uptime in seconds.

Errors

Returns an error if the supervisor is shutting down.

Trait Implementations

impl<W: Clone + Worker> Clone for SupervisorHandle<W>

fn clone(&self) -> SupervisorHandle<W>

Returns a duplicate of the value.

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

Performs copy-assignment from source.