Struct KeyedHashedWheelTimer 

pub struct KeyedHashedWheelTimer<T, K, F>
where
    K: Eq + Hash + Clone,
    F: Fn(&T) -> K,
{ /* private fields */ }

Keyed wrapper over HashedWheelTimer.

A dedup key is produced by dedup_key_fn. Scheduling/updating an event with an existing key replaces the previous one.

Implementations

impl<T, K, F> KeyedHashedWheelTimer<T, K, F>

where K: Eq + Hash + Clone, F: Fn(&T) -> K,

pub fn new(buckets_num: usize, dedup_key_fn: F) -> Self

Creates a keyed timer.

pub fn count_all(&self) -> usize

Returns total number of scheduled events.

pub fn count_in_bucket( &self, bucket_index: usize, ) -> Result<usize, TimeWheelError>

Returns number of events in bucket by index.

pub fn is_empty(&self) -> bool

Returns true when no events are scheduled.

pub fn is_empty_bucket( &self, bucket_index: usize, ) -> Result<bool, TimeWheelError>

Returns true when bucket contains no events.

pub fn has_events_in_current_tick(&self) -> bool

Returns true if current tick still has events to pop.

pub fn curr_tick(&self) -> u64

Returns current absolute tick.

pub fn curr_bucket(&self) -> usize

Returns current bucket index.

pub fn curr_delta_tick(&self) -> u64

Returns current wave (delta_tick) in the current tick.

pub fn curr_seq_id(&self) -> EventId

Returns latest assigned sequence ID.

pub fn step(&mut self)

Advances timer by one tick.

pub fn reset(&mut self)

Clears all events and key index, then resets timer state.

pub fn contains_by_id(&self, id: EventId) -> bool

Returns true if event with ID exists.

pub fn contains_by_key(&self, key: &K) -> bool

Returns true if key exists.

pub fn id_by_key(&self, key: &K) -> Option<EventId>

Returns event ID by key.

pub fn get(&self, id: EventId) -> Option<&Event<T>>

Returns event by ID.

pub fn get_by_key(&self, key: &K) -> Option<&Event<T>>

Returns event by key.

pub fn schedule(&mut self, on_tick: u64, data: T) -> KeyedScheduleResult

Schedules an event.

If key already exists, previous event is replaced.

pub fn remove(&mut self, id: EventId) -> Option<Event<T>>

Removes event by ID and updates key index.

pub fn remove_by_key(&mut self, key: &K) -> Option<Event<T>>

Removes event by dedup key.

pub fn update( &mut self, id: EventId, on_tick: u64, data: T, ) -> Option<KeyedUpdateResult>

Updates event by ID and applies key replacement semantics.

pub fn update_by_key( &mut self, key: &K, on_tick: u64, data: T, ) -> Option<KeyedUpdateResult>

Updates event by key.

pub fn reschedule( &mut self, id: EventId, on_tick: u64, ) -> Option<KeyedUpdateResult>

Reschedules event by ID preserving payload and key.

pub fn reschedule_by_key( &mut self, key: &K, on_tick: u64, ) -> Option<KeyedUpdateResult>

Reschedules event by key.

pub fn pop_events(&mut self) -> Vec<Event<T>>

Pops one current-tick wave and keeps key index in sync.

Trait Implementations

impl<T: Debug, K, F> Debug for KeyedHashedWheelTimer<T, K, F>

where K: Eq + Hash + Clone + Debug, F: Fn(&T) -> K + Debug,

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

Formats the value using the given formatter.