Trait Task

pub trait Task:
    Send
    + Sync
    + 'static {
    type Output: Send + Sync + 'static + Sized;

    const VARIANT: TaskVariant;

    // Required method
    fn run_once<'life0, 'async_trait>(
        &'life0 mut self,
    ) -> Pin<Box<dyn Future<Output = Result<Self::Output, BridgeError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
}

Task trait defining the core behavior for cancelable background tasks

This trait is implemented by any struct that needs to run as a background task. The run_once method contains the main logic of the task, and returns a bool indicating whether it did work (true) or needs to wait (false).

Required Associated Constants

const VARIANT: TaskVariant

The variant of the task

Required Associated Types

type Output: Send + Sync + 'static + Sized

The output of the fn run_once

Required Methods

fn run_once<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Self::Output, BridgeError>> + Send + 'async_trait>>

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

Run the task once, returning whether work was done

Returns:

• Ok(true) if the task did some work and is ready to run again immediately
• Ok(false) if the task did not do work and should wait before running again
• Err(...) if the task encountered an error

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Task for BitcoinSyncerTask

const VARIANT: TaskVariant = TaskVariant::BitcoinSyncer

type Output = bool

impl Task for TxSenderTask

const VARIANT: TaskVariant = TaskVariant::TxSender

type Output = bool

impl Task for AggregatorMetricPublisher

const VARIANT: TaskVariant = TaskVariant::MetricPublisher

type Output = bool

impl Task for TaskStatusMonitorTask

const VARIANT: TaskVariant = TaskVariant::TaskStatusMonitor

type Output = bool

impl<C> Task for PayoutCheckerTask<C>

where C: CitreaClientT,

const VARIANT: TaskVariant = TaskVariant::PayoutChecker

type Output = bool

impl<H: BlockHandler> Task for FinalizedBlockFetcherTask<H>

const VARIANT: TaskVariant = TaskVariant::FinalizedBlockFetcher

type Output = bool

impl<T: Owner + Debug + 'static> Task for MessageConsumerTask<T>

const VARIANT: TaskVariant = TaskVariant::StateManager

type Output = bool

impl<T: NamedEntity> Task for EntityMetricPublisher<T>

const VARIANT: TaskVariant = TaskVariant::MetricPublisher

type Output = bool

impl<T: Task + Sized + Debug> Task for BufferedErrors<T>

where T::Output: Default,

const VARIANT: TaskVariant = T::VARIANT

type Output = <T as Task>::Output

impl<T: Task + Sized + Debug> Task for IgnoreError<T>

where T::Output: Default,

const VARIANT: TaskVariant = T::VARIANT

type Output = <T as Task>::Output

impl<T: Task + Sized> Task for CancelableLoop<T>

const VARIANT: TaskVariant = T::VARIANT

type Output = ()

impl<T: Task + Sized, F: Fn(T::Output) -> T::Output + Send + Sync + 'static> Task for Map<T, F>

const VARIANT: TaskVariant = T::VARIANT

type Output = <T as Task>::Output

impl<T: Task> Task for CancelableTask<T>

const VARIANT: TaskVariant = T::VARIANT

type Output = CancelableResult<<T as Task>::Output>

impl<T: Task> Task for WithDelay<T>

where T::Output: Into<bool>,

const VARIANT: TaskVariant = T::VARIANT

type Output = bool