Struct BackgroundTasks 

pub struct BackgroundTasks { /* private fields */ }

Spawns and tracks background tasks tied to the server lifecycle.

Tasks receive a Shutdown handle and are expected to return soon after it triggers. During graceful shutdown the server waits (up to the shutdown timeout) for every tracked task to finish.

This is intentionally small: it is not a job queue, it has no retries and no persistence.

use std::time::Duration;
use kerniq_runtime::{BackgroundTasks, Shutdown};

let shutdown = Shutdown::new();
let tasks = BackgroundTasks::new(shutdown.clone());
tasks.spawn("ticker", |shutdown| async move {
    let mut interval = tokio::time::interval(Duration::from_millis(10));
    loop {
        tokio::select! {
            _ = interval.tick() => { /* periodic work */ }
            () = shutdown.wait() => break,
        }
    }
});
shutdown.trigger();
assert!(tasks.shutdown(Duration::from_secs(1)).await);

Implementations

impl BackgroundTasks

pub fn new(shutdown: Shutdown) -> Self

Creates a task set bound to shutdown.

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

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

Spawns a named task on the current Tokio runtime.

Panics

Panics if called outside a Tokio runtime.

pub fn len(&self) -> usize

Number of tasks still running.

pub fn is_empty(&self) -> bool

Whether no tasks are running.

pub async fn shutdown(&self, timeout: Duration) -> bool

Triggers shutdown and waits up to timeout for all tasks to finish. Returns false if the timeout elapsed first.

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.