fugit-timer 0.2.0

A Count Down Timer abstaction that uses fugit time primitives
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

#![no_std]

/// Reexport `fugit`
pub use fugit::*;

/// Provides non-blocking `CountDown` timing capabilities
pub trait Timer<const TIMER_HZ: u64> {
    /// An error that might happen during waiting
    type Error: core::fmt::Debug;

    /// Return current time `Instant`
    fn now(&mut self) -> TimerInstantU32<TIMER_HZ>;

    /// Start timer with a `duration`
    fn start(&mut self, duration: TimerDurationU32<TIMER_HZ>) -> Result<(), Self::Error>;

    /// Tries to stop this timer.
    /// An error will be returned if the timer has already been canceled or was never started.
    /// An error is also returned if the timer is not `Periodic` and has already expired.
    fn cancel(&mut self) -> Result<(), Self::Error>;

    /// Wait until timer `duration` has expired.
    /// Must return `nb::Error::WouldBlock` if timer `duration` is not yet over.
    /// Must return `OK(())` as soon as timer `duration` has expired.
    fn wait(&mut self) -> nb::Result<(), Self::Error>;
}

/// Provides blocking `Delay`
pub trait Delay<const TIMER_HZ: u64> {
    /// An error that might happen during waiting
    type Error: core::fmt::Debug;

    /// Wait until timer `duration` has expired.
    fn delay(&mut self, duration: TimerDurationU32<TIMER_HZ>) -> Result<(), Self::Error>;
}