Struct BackgroundTasks 

pub struct BackgroundTasks { /* private fields */ }

Background tasks that run in rounds until shutdown, or once.

Every round runs as its own tokio task. A round that panics is logged and the task continues. On shutdown no new round starts, a running round or one-off task is not interrupted.

Implementations

impl BackgroundTasks

pub fn new() -> Self

pub fn shutdown_token(&self) -> CancellationToken

Cancelled on shutdown. Rounds that may run for a long time, e.g. docs builds, use it to stop early.

pub fn request_shutdown(&self)

pub fn spawn_periodic<F, Fut>( &self, name: &'static str, interval: Duration, first_round: FirstRound, round: F, )

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

Run round every interval. A round that takes longer than the interval delays the next one.

pub fn spawn_loop<F, Fut>(&self, name: &'static str, round: F)

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

Run round repeatedly, starting immediately. Each round returns the delay until the next one.

pub fn spawn_tracked<Fut>(&self, task: Fut) -> JoinHandle<Fut::Output>

where Fut: Future + Send + 'static, Fut::Output: Send + 'static,

Run task once. Shutdown waits for it like for a running round.

pub fn spawn_once<Fut>(&self, name: &'static str, task: Fut) -> JoinHandle<()>

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

Run task once and log it if it panics. Shutdown waits for it like for a running round.

pub async fn wait_for_shutdown(&self, timeout: Duration)

Wait until shutdown is requested, then up to timeout for the running rounds to finish.

Trait Implementations

impl Clone for BackgroundTasks

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 BackgroundTasks

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

Formats the value using the given formatter.

impl Default for BackgroundTasks

fn default() -> Self

Returns the “default value” for a type.