Struct Timer 

#[repr(C)]
pub struct Timer {
    pub refany: RefAny,
    pub node_id: OptionDomNodeId,
    pub created: Instant,
    pub last_run: OptionInstant,
    pub run_count: usize,
    pub delay: OptionDuration,
    pub interval: OptionDuration,
    pub timeout: OptionDuration,
    pub callback: TimerCallback,
}

A Timer is a function that runs on every frame or at intervals.

Fields

refany: RefAny

node_id: OptionDomNodeId

created: Instant

last_run: OptionInstant

run_count: usize

delay: OptionDuration

interval: OptionDuration

timeout: OptionDuration

callback: TimerCallback

Implementations

impl Timer

pub fn create<C: Into<TimerCallback>>( refany: RefAny, callback: C, get_system_time_fn: GetSystemTimeCallback, ) -> Self

pub fn tick_millis(&self) -> u64

pub fn is_about_to_finish(&self, instant_now: &Instant) -> bool

pub fn instant_of_next_run(&self) -> Instant

pub fn with_delay(self, delay: Duration) -> Self

pub fn with_interval(self, interval: Duration) -> Self

pub fn with_timeout(self, timeout: Duration) -> Self

pub fn invoke( &mut self, callback_info: &CallbackInfo, get_system_time_fn: &GetSystemTimeCallback, ) -> TimerCallbackReturn

Invoke the timer callback and update internal state

Returns DoNothing + Continue if the timer is not ready to run yet (delay not elapsed for first run, or interval not elapsed for subsequent runs).

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Timer

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

Formats the value using the given formatter.

impl Default for Timer

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Timer

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Timer

fn eq(&self, other: &Timer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Timer

impl StructuralPartialEq for Timer