Struct Timer 

pub struct Timer<R> { /* private fields */ }

A timer suitable for use by actors.

Implementations

impl<R: SupportsTimers> Timer<R>

pub fn new(runtime: R) -> Self

Construct a new timer with the provided runtime.

pub fn state(&self) -> TimerState

Get the state of the timer

pub fn is_active(&self) -> bool

True if this timer is expected to tick in the future.

pub fn clear(&mut self)

Reset the timer to the inactive state.

pub fn tick(&mut self) -> bool

Check if the timer has elapsed.

pub fn set_interval_at_weak<T: Tick>( &mut self, addr: WeakAddr<T>, start: Instant, interval: Duration, )

Configure the timer to tick at a set interval with an initial delay. The timer will not try to keep the actor alive.

pub fn set_interval_at_strong<T: Tick>( &mut self, addr: Addr<T>, start: Instant, interval: Duration, )

Configure the timer to tick at a set interval with an initial delay. The timer will try to keep the actor alive.

pub fn set_interval_weak<T: Tick>( &mut self, addr: WeakAddr<T>, interval: Duration, )

Configure the timer to tick at a set interval, with the initial tick sent immediately. The timer will not try to keep the actor alive.

pub fn set_interval_strong<T: Tick>( &mut self, addr: Addr<T>, interval: Duration, )

Configure the timer to tick at a set interval, with the initial tick sent immediately. The timer will try to keep the actor alive.

pub fn set_timeout_weak<T: Tick>( &mut self, addr: WeakAddr<T>, deadline: Instant, )

Configure the timer to tick once at the specified time. The timer will not try to keep the actor alive.

pub fn set_timeout_strong<T: Tick>(&mut self, addr: Addr<T>, deadline: Instant)

Configure the timer to tick once at the specified time. The timer will try to keep the actor alive until that time.

pub fn set_timeout_for_weak<T: Tick>( &mut self, addr: WeakAddr<T>, duration: Duration, )

Configure the timer to tick once after a delay. The timer will not try to keep the actor alive.

pub fn set_timeout_for_strong<T: Tick>( &mut self, addr: Addr<T>, duration: Duration, )

Configure the timer to tick once after a delay. The timer will try to keep the actor alive until that time.

pub fn run_with_timeout_weak<T: Tick + ?Sized, F: Future<Output = ()> + Send + 'static>( &mut self, addr: WeakAddr<T>, deadline: Instant, f: impl FnOnce(WeakAddr<T>) -> F + Send + 'static, )

Configure the timer to tick once at the specified time, whilst simultaneously running a task to completion. If the timeout completes first, the task will be dropped. The timer will not try to keep the actor alive.

pub fn run_with_timeout_strong<T: Tick + ?Sized, F: Future<Output = ()> + Send + 'static>( &mut self, addr: Addr<T>, deadline: Instant, f: impl FnOnce(Addr<T>) -> F + Send + 'static, )

Configure the timer to tick once at the specified time, whilst simultaneously running a task to completion. If the timeout completes first, the task will be dropped. The timer will try to keep the actor alive until that time.

pub fn run_with_timeout_for_weak<T: Tick + ?Sized, F: Future<Output = ()> + Send + 'static>( &mut self, addr: WeakAddr<T>, duration: Duration, f: impl FnOnce(WeakAddr<T>) -> F + Send + 'static, )

Configure the timer to tick once at the specified time, whilst simultaneously running a task to completion. If the timeout completes first, the task will be dropped. The timer will not try to keep the actor alive.

pub fn run_with_timeout_for_strong<T: Tick + ?Sized, F: Future<Output = ()> + Send + 'static>( &mut self, addr: Addr<T>, duration: Duration, f: impl FnOnce(Addr<T>) -> F + Send + 'static, )

Configure the timer to tick once at the specified time, whilst simultaneously running a task to completion. If the timeout completes first, the task will be dropped. The timer will try to keep the actor alive until that time.

Trait Implementations

impl<R: Debug> Debug for Timer<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R: Default> Default for Timer<R>

fn default() -> Timer<R>

Returns the “default value” for a type.