Struct BackgroundTasks 

pub struct BackgroundTasks { /* private fields */ }

Collect bounded process-local work for a successful endpoint response.

Default-constructed instances are inert. Extract through a handler to obtain request ownership. Use Self::try_add to handle overload; Self::add logs a rejection and drops the rejected future.

Implementations

impl BackgroundTasks

pub fn add<F>(&mut self, fut: F)

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

Queue work, logging and discarding it when admission is rejected.

Args: fut: Future executed after a successful endpoint response.

Returns: Nothing; use Self::try_add to inspect rejection.

pub fn try_add<F>(&mut self, fut: F) -> Result<(), BackgroundTaskError>

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

Reserve bounded admission for work within this request.

Args: fut: Future whose execution requires a successful endpoint.

Returns: Success after admission; cancellation still discards queued work.

Errors

Closed request/app, unavailable ownership, or exhausted capacity.

pub fn add_fn<F, Fut>(&mut self, f: F)

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

Queue the future returned by f, with Self::add admission policy.

Args: f: Factory called immediately to construct the queued future.

Returns: Nothing; the future is discarded if admission is rejected.

Trait Implementations

impl Default for BackgroundTasks

fn default() -> BackgroundTasks

Returns the “default value” for a type.

impl FromRequestParts for BackgroundTasks

const BACKGROUND_TASKS: bool = true

Whether extraction needs a request-owned background queue. Custom wrappers delegating to BackgroundTasks must propagate this.

async fn from_request_parts(parts: &mut Parts) -> Result<Self, ApiError>

Perform the extraction.

fn describe(_op: &mut Operation, _registry: &mut SchemaRegistry)

Document this extractor on op (parameters, security, …).