Struct hierarchical_hash_wheel_timer::PeriodicClosureState

pub struct PeriodicClosureState<I> { /* fields omitted */ }

A timeout state for a periodic timer using a closure as the triggering action

Methods

impl<I> PeriodicClosureState<I>

pub fn new<F>(id: I, action: F) -> Self where
    F: FnMut(I) -> TimerReturn<()> + Send + 'static, 

Produces a new instance of this state type from a unique id and the action to be executed every time it expires.

impl PeriodicClosureState<Uuid>

pub fn with_random_id<F>(action: F) -> Self where
    F: FnMut(Uuid) -> TimerReturn<()> + Send + 'static, 

Produces a new instance of this state type using a random unique id and the action to be executed every time it expires.

Uses Uuid::new_v4() internally.

Trait Implementations

impl<I> Debug for PeriodicClosureState<I> where
    I: Hash + Clone + Eq + Debug, 

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

Formats the value using the given formatter.

impl<I> PeriodicState for PeriodicClosureState<I> where
    I: Hash + Clone + Eq, 

type Id = I

The type of the unique id of the outstanding timeout

fn id(&self) -> &Self::Id

A reference to the id associated with this state

fn trigger(self) -> TimerReturn<Self> where
    Self: Sized, 

Trigger should be called by the timer implementation when the timeout has expired.