Struct TimeEventMessage 

pub struct TimeEventMessage { /* private fields */ }

A send-safe live time event channel payload.

The dispatch representation is private so local callbacks can never be embedded in a cross-thread message.

Implementations

impl TimeEventMessage

pub fn new(event: TimeEvent, callback: TimeEventCallback) -> Self

Creates a message from a time event and callback.

Panics

Panics if the process-wide callback ID or lease count is exhausted.

pub const fn event(&self) -> &TimeEvent

Returns the time event carried by this message.

pub fn dispatch(self) -> bool

Resolves and runs this message on the receiving thread.

Messages for a RustLocal callback must be dispatched on the thread where the callback was registered. Dispatching them elsewhere drops the event and returns false.

Returns true when a callback was dispatched. Cleanup messages and wrong-thread registered messages return false.

Trait Implementations

impl Debug for TimeEventMessage

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

Formats the value using the given formatter.