Struct CriticalTaskExecutionHandle 

pub struct CriticalTaskExecutionHandle { /* private fields */ }

The CriticalTaskExecutionHandle is a handle for a critical task that is expected to complete successfully. This handle provides two cancellation mechanisms:

1. Critical Failure: If the task returns an error or panics, the parent cancellation token is triggered immediately via a monitoring task that detects failures.

2. Graceful Shutdown: The task can be gracefully shut down via its child token, allowing it to complete cleanly without triggering system-wide cancellation.

This is useful for ensuring that critical detached tasks either complete successfully or trigger appropriate shutdown procedures when they fail.

Implementations

impl CriticalTaskExecutionHandle

pub fn new<Fut>( task_fn: impl FnOnce(CancellationToken) -> Fut + Send + 'static, parent_token: CancellationToken, description: &str, ) -> Result<Self>

where Fut: Future<Output = Result<()>> + Send + 'static,

pub fn new_with_runtime<Fut>( task_fn: impl FnOnce(CancellationToken) -> Fut + Send + 'static, parent_token: CancellationToken, description: &str, runtime: &Handle, ) -> Result<Self>

where Fut: Future<Output = Result<()>> + Send + 'static,

Create a new CriticalTaskExecutionHandle for a critical task.

Arguments

• task_fn - A function that takes a cancellation token and returns the critical task future
• parent_token - Token that will be cancelled if this critical task fails
• description - Description for logging purposes
• runtime - The runtime to use for the task.

pub fn is_finished(&self) -> bool

Check if the task awaiting on the [Server]s background event loop has finished.

pub fn is_cancelled(&self) -> bool

Check if the server’s event loop has been cancelled.

pub fn cancel(&self)

Gracefully cancel this critical task without triggering system-wide shutdown.

This signals the task to stop processing and exit cleanly. The task should monitor its cancellation token and respond appropriately.

This will not propagate to the parent CancellationToken unless an error occurs during the shutdown process.

pub async fn join(self) -> Result<()>

Join on the critical task and return its actual result.

This will return:

• Ok(()) if the task completed successfully or was gracefully cancelled
• Err(...) if the task failed or panicked, preserving the original error

Note: Both errors and panics trigger parent cancellation immediately via the monitor task.

pub fn detach(self)

Detach the task. This allows the task to continue running after the handle is dropped.

Trait Implementations

impl Drop for CriticalTaskExecutionHandle

fn drop(&mut self)

Executes the destructor for this type.