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

//! Delays
//!
//! # What's the difference between these traits and the `timer::CountDown` trait?
//!
//! The `Timer` trait provides a *non-blocking* timer abstraction and it's meant to be used to build
//! higher level abstractions like I/O operations with timeouts. OTOH, these delays traits only
//! provide *blocking* functionality. Note that you can also use the `timer::CountDown` trait to
//! implement blocking delays.

/// Blocking delay traits
pub mod blocking {
    /// Millisecond delay
    ///
    /// `UXX` denotes the range type of the delay time. `UXX` can be `u8`, `u16`, etc. A single type can
    /// implement this trait for different types of `UXX`.
    pub trait DelayMs<UXX> {
        /// Enumeration of `DelayMs` errors
        type Error: core::fmt::Debug;

        /// Pauses execution for `ms` milliseconds
        fn delay_ms(&mut self, ms: UXX) -> Result<(), Self::Error>;
    }

    /// Microsecond delay
    ///
    /// `UXX` denotes the range type of the delay time. `UXX` can be `u8`, `u16`, etc. A single type can
    /// implement this trait for different types of `UXX`.
    pub trait DelayUs<UXX> {
        /// Enumeration of `DelayMs` errors
        type Error: core::fmt::Debug;

        /// Pauses execution for `us` microseconds
        fn delay_us(&mut self, us: UXX) -> Result<(), Self::Error>;
    }
}