Trait BackgroundTask 

pub trait BackgroundTask: Sync + Send {
    // Required method
    fn execute<'life0, 'async_trait>(
        &'life0 self,
        count: u32,
    ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
}

A unified trait for any task that can be run in the background.

Required Methods

fn execute<'life0, 'async_trait>( &'life0 self, count: u32, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes a single iteration of the task.

Arguments

• count - The current execution cycle number.

Returns

• Ok(true) if the task performed meaningful work and should be logged as “success”.
• Ok(false) if the task was skipped or did no work.
• Err(Error) if the task failed.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors