Struct PeriodicTimerMember 

pub struct PeriodicTimerMember<'group> { /* private fields */ }

A periodic timer owned by a CleanupGroup.

Behaves like ThreadpoolPeriodicTimer – including that its ticks may run concurrently with one another – but is released by the group rather than by its own drop.

Implementations

impl PeriodicTimerMember<'_>

pub fn period(&self) -> Duration

The period this timer ticks on.

pub fn start(&self)

Start ticking, with the first tick one period from now.

pub fn start_after(&self, first_delay: Duration)

Start ticking, with the first tick first_delay from now.

pub fn stop(&self)

Stop the timer.

pub fn is_running(&self) -> bool

Whether the timer is currently started.

pub fn wait(&self)

Block until all queued and executing ticks have completed.

pub fn stop_and_drain(&self)

Stop the timer and wait until no tick is queued or executing.

As with ThreadpoolPeriodicTimer::stop_and_drain, this holds provided no other thread starts the member during the call: the start* methods take &self, so a start landing between the stop and the drain would leave a schedule installed on return.

Trait Implementations

impl<'group> Debug for PeriodicTimerMember<'group>

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

Formats the value using the given formatter.