Struct MockTimer 

pub struct MockTimer;

A mocked version of embassy_time::Timer that can be used in its place for unit tests.

This mocked version just immediately returns Poll::Ready when await’ed on.

Examples

use embassy_futures::block_on;
use embassy_mock::time::{MockTimer, Timer};
use embassy_time::Duration;

let timer = MockTimer::after(Duration::from_secs(1));
block_on(timer);

Trait Implementations

impl Debug for MockTimer

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

Formats the value using the given formatter.

impl Eq for MockTimer

impl Future for MockTimer

fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Self::Output>

Immediately return Poll::Ready.

type Output = ()

The type of value produced on completion.

impl PartialEq for MockTimer

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MockTimer

impl Timer for MockTimer

fn after(_duration: Duration) -> Self

Create a MockTimer that can be used to unit test code.

Examples

use embassy_mock::time::Timer;
use embassy_time::Duration;

async fn production_code<T: Timer>() {
    // Do something...
    T::after(Duration::from_millis(100)).await;
    // Do something else...
}

// The unit tests that use the `MockTimer`
#[cfg(test)]
mod tests {
    use super::*;
    use embassy_futures::block_on;
    use embassy_mock::time::MockTimer;

    #[test]
    fn test_creating_timer() {
        block_on(production_code::<MockTimer>());
    }
}