Struct StopHandle 

pub struct StopHandle { /* private fields */ }

A spawned background task and the CancellationToken that stops it.

StopHandle::spawn hands the task the same token the handle stores, so the pairing holds by construction. Dropping the handle detaches the task (like dropping a bare JoinHandle); stop it with StopHandle::shutdown instead.

Implementations

impl StopHandle

pub fn spawn<F, Fut>(task: F) -> Self

where F: FnOnce(CancellationToken) -> Fut, Fut: Future<Output = ()> + Send + 'static,

Spawn task onto the runtime with a fresh stop token. The closure receives the token this handle later cancels, so the task observes exactly the signal Self::cancel and Self::shutdown fire.

pub fn cancel(&self)

Signal the task to stop without awaiting it. Idempotent — Self::shutdown cancels again as a no-op. Use this to start a drain early and overlap it with other teardown work before the final shutdown().await.

pub fn abort_handle(&self) -> AbortHandle

Last-resort abort for a drain that overruns its deadline: dropping a timed-out Self::shutdown future merely detaches the task, so the caller takes this handle first and fires it when the timeout lands.

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

Stop the task and await it: cancel the token, then join. The cancel is unconditional and comes first, so this cannot hang on queue senders that outlive shutdown the way a bare JoinHandle await can.

Trait Implementations

impl Debug for StopHandle

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

Formats the value using the given formatter.