Struct Event 

pub struct Event<T> { /* private fields */ }

A scheduled event stored in the wheel.

Event values are returned by read/pop/remove operations. They carry metadata used by the wheel scheduler:

• tick: absolute tick when the event can be processed.
• delta_tick: wave index within the same tick.

Example

use okee_wheel_timer::HashedWheelTimer;

let mut wheel = HashedWheelTimer::new(8);
let id = wheel.schedule(0, "payload").id;

let events = wheel.pop_events();
assert_eq!(events[0].id(), id);
assert_eq!(events[0].tick(), 0);
assert_eq!(events[0].data(), &"payload");

Implementations

impl<T> Event<T>

pub fn id(&self) -> EventId

Returns the unique ID of this event.

pub fn tick(&self) -> u64

Returns the absolute tick when this event becomes available.

pub fn delta_tick(&self) -> u64

Returns the wave number inside tick.

Events with the same (tick, delta_tick) are popped together.

pub fn data(&self) -> &T

Returns a shared reference to the payload.

pub fn into_data(self) -> T

Consumes the event and returns its payload.

Trait Implementations

impl<T: Clone> Clone for Event<T>

fn clone(&self) -> Event<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Event<T>

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

Formats the value using the given formatter.

impl<T: Copy> Copy for Event<T>