Struct BackgroundTasks 

pub struct BackgroundTasks { /* private fields */ }

A request-scoped handle for scheduling work that runs after the response.

A handler injects it with Extension<BackgroundTasks> and schedules work anywhere in its body, instead of restructuring its return type around Background<T>.

A scheduled task is attached to the response dispatch produces whatever the outcome is, including a rejection, a typed domain error, and an aborted invocation, so an adapter runs it once the body has been written. This is the one behavioral difference from Background<T>, whose tasks ride on a success value and are therefore discarded when the operation fails.

Implementations

impl BackgroundTasks

pub fn new() -> Self

pub fn add_task(&self, task: BackgroundTask)

Schedules a prepared task.

pub fn add<Task, TaskFuture>(&self, task: Task)

where Task: FnOnce() -> TaskFuture + 'static, TaskFuture: Future<Output = Result<(), BackgroundTaskError>> + 'static,

Schedules a fallible after-response task.

pub fn add_infallible<Task, TaskFuture>(&self, task: Task)

where Task: FnOnce() -> TaskFuture + 'static, TaskFuture: Future<Output = ()> + 'static,

Schedules an after-response task that cannot fail.

pub fn len(&self) -> usize

Number of tasks scheduled so far.

pub fn is_empty(&self) -> bool

Returns whether nothing has been scheduled yet.

pub fn take(&self) -> Vec<BackgroundTask>

Takes the scheduled tasks, leaving the handle empty.

Trait Implementations

impl Clone for BackgroundTasks

fn clone(&self) -> BackgroundTasks

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() -> BackgroundTasks

Returns the “default value” for a type.

impl FromInvocation for BackgroundTasks

fn from_invocation( input: &InvocationInput<'_>, name: &str, _required: bool, ) -> Result<Self, InputRejection>

Extracts one handler argument.