Struct Timer 

pub struct Timer<S: TimerState> { /* private fields */ }

Timer which can either be in a paused state or a running state. To instantiate the timer run Timer::new(). To actually start it call Timer::init()

Example

use zentime_rs_timer::timer::{Timer, TimerEndHandler, TimerTickHandler, TimerStatus, Paused};
use zentime_rs_timer::TimerAction;
use std::thread;

// Handler which is passed to our timer implementation
pub struct OnEndHandler { }

impl TimerEndHandler for OnEndHandler {
    fn call(&mut self) {
        println!("Hi from timer");
    }
}

pub struct OnTickHandler {}

impl TimerTickHandler for OnTickHandler {
    fn call(&mut self, status: TimerStatus) -> Option<TimerAction> {
        println!("{}", status.current_time);
        None
    }
}

// Run timer in its own thread so it does not block the current one
thread::spawn(move || {
    Timer::<Paused>::new(
        10,
        Some(OnEndHandler {}),
        Some(OnTickHandler {})
    )
    .init();
});

Implementations

impl Timer<Paused>

Implementation of the Paused state for Timer

pub fn new<E, T>(time: u64, on_timer_end: Option<E>, on_tick: Option<T>) -> Self

where E: TimerEndHandler + 'static, T: TimerTickHandler + 'static,

Creates a new timer in paused state. You have to call Self::init() to start the timer

pub fn init(self)

Puts the paused timer into a waiting state waiting for input (e.g. to unpause the timer and transition it into a running state).

impl Timer<Running>

pub fn new<E, T>(time: u64, on_timer_end: Option<E>, on_tick: Option<T>) -> Self

where E: TimerEndHandler + 'static, T: TimerTickHandler + 'static,

Creates a new timer in paused state. You have to call Self::init() to start the timer

pub fn init(self)

Runs the timer and awaits input. Depending on the input [TimerInputAction] the timer might transition into a paused state or skip to the next interval.

Trait Implementations

impl<S: TimerState + Debug> Debug for Timer<S>

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

Formats the value using the given formatter.