Struct timer_rs::Timer

pub struct Timer { /* private fields */ }

A timer, used to schedule execution of callbacks in a given future.

If the callback does not provide the new time period, the next execution will be scheduled for a distant future.

Implementations

impl Timer

pub fn new( callback: impl Fn() -> Option<NaiveDateTime> + Send + 'static ) -> Self

Creates a Timer instance.

pub fn with_graceful_shutdown<O>( self, shutdown: impl Future<Output = O> + Send + 'static ) -> Self

pub async fn schedule(&self, deadline: NaiveDateTime) -> Result<(), TimerError>

Schedule for execution after a delay.

pub fn scheduler(&self) -> Scheduler

Creates a handler to schedule new executions.

Trait Implementations

impl IntoFuture for Timer

type Output = ()

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <Timer as IntoFuture>::Output>, Global>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.