Skip to main content

ScheduledWork

Trait ScheduledWork 

Source
pub trait ScheduledWork: WithWorkInputOutput + WithWorkContextProvider {
    // Required methods
    fn tick(
        &mut self,
        input: Self::Tick,
        context: &mut <Self::WorkContextProvider as WorkContextProvider>::Item<'_>,
    ) -> WorkResult;
    fn on_scheduled_hook(&mut self, tick_input: Self::Tick);
}

Required Methods§

Source

fn tick( &mut self, input: Self::Tick, context: &mut <Self::WorkContextProvider as WorkContextProvider>::Item<'_>, ) -> WorkResult

Source

fn on_scheduled_hook(&mut self, tick_input: Self::Tick)

This hook is called once when the work enters the executor during the first tick after being scheduled.

Implementations on Foreign Types§

Source§

impl<Work, C> ScheduledWork for TickedContinuousWork<Work, C>

Source§

fn tick( &mut self, tick_input: <TickedContinuousWork<Work, C> as WithWorkInputOutput>::Tick, context: &mut <C as WorkContextProvider>::Item<'_>, ) -> WorkResult

Source§

fn on_scheduled_hook( &mut self, _tick_input: <TickedContinuousWork<Work, C> as WithWorkInputOutput>::Tick, )

Source§

impl<Work, C> ScheduledWork for TickedInvokedWork<Work, C>

Source§

fn tick( &mut self, tick_input: <TickedInvokedWork<Work, C> as WithWorkInputOutput>::Tick, context: &mut <C as WorkContextProvider>::Item<'_>, ) -> WorkResult

Source§

fn on_scheduled_hook( &mut self, _tick_input: <TickedInvokedWork<Work, C> as WithWorkInputOutput>::Tick, )

Source§

impl<Work, C> ScheduledWork for TickedDelayedOnceWork<Work, C>

Source§

fn tick( &mut self, tick: Tick, context: &mut <C as WorkContextProvider>::Item<'_>, ) -> WorkResult

Source§

fn on_scheduled_hook( &mut self, tick_input: <TickedDelayedOnceWork<Work, C> as WithWorkInputOutput>::Tick, )

Source§

impl<Work, C> ScheduledWork for TickedImmediateOnceWork<Work, C>

Source§

fn tick( &mut self, tick: Tick, context: &mut <C as WorkContextProvider>::Item<'_>, ) -> WorkResult

Source§

fn on_scheduled_hook( &mut self, _tick_input: <TickedImmediateOnceWork<Work, C> as WithWorkInputOutput>::Tick, )

Source§

impl<Work, C> ScheduledWork for TickedRepeatingWork<Work, C>

Source§

fn tick( &mut self, tick_input: <TickedRepeatingWork<Work, C> as WithWorkInputOutput>::Tick, context: &mut <C as WorkContextProvider>::Item<'_>, ) -> WorkResult

Source§

fn on_scheduled_hook( &mut self, tick_input: <TickedRepeatingWork<Work, C> as WithWorkInputOutput>::Tick, )

Implementors§