Struct nuuro::Timer

pub struct Timer { /* fields omitted */ }

Structure that allows calculating the time elapsed since its initialization or determining whether a certain period of time has elapsed.

Methods

impl Timer

pub fn new(expiration_time: u64, start_active: bool) -> Timer

Initialize a new Timer. If the expiration_time parameter equals 0, an endless Timer is started; if the parameter has any value (in milliseconds), a new Timer will start which will expire upon reaching this period of time. The timer_active parameter will determine if the Timer will start at once when initialized (note: if it is an endless timer, it will always be initialized started).

pub fn reset(&self)

Reset the elapsed time of the timer to 0, and if it has not started before, the time will begin to elapse.

pub fn set_time(&self, expiration_time: u64, start_active: bool)

Set a new expiration time for the timer and activation on start.

pub fn active(&self) -> bool

Get the timer status. If the expiration time has not been reached, the timer will be active.

pub fn expired(&self) -> bool

Indicates if the timer has expired.

pub fn elapsed(&self) -> Duration

Returns the time elapsed since the initialization of the last timer cycle.

pub fn elapsed_as_millis(&self) -> u64

Returns the time elapsed since the initialization of the last timer cycle as milliseconds.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Timer

fn drop(&mut self)

Executes the destructor for this type.