async_timer/
timed.rs

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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
//! Timed future

use core::future::Future;
use core::{fmt, task, time, mem};
use core::pin::Pin;

use crate::oneshot::Oneshot;
use crate::oneshot::Timer as PlatformTimer;

#[must_use = "Timed does nothing unless polled"]
///Limiter on time to wait for underlying `Future`
///
///# Usage
///
///```rust, no_run
///async fn job() {
///}
///
///async fn do_job() {
///    let work = unsafe {
///        async_timer::Timed::platform_new_unchecked(job(), core::time::Duration::from_secs(1))
///    };
///
///    match work.await {
///        Ok(_) => println!("I'm done!"),
///        //You can retry by polling `expired`
///        Err(expired) => println!("Job expired: {}", expired),
///    }
///}
///```
pub enum Timed<F, T=PlatformTimer> {
    #[doc(hidden)]
    Ongoing(T, F, time::Duration),
    #[doc(hidden)]
    Stopped,
}

impl<F: Future + Unpin> Timed<F> {
    #[inline]
    ///Creates new instance using [Timer](../oneshot/type.Timer.html) alias.
    pub fn platform_new(inner: F, timeout: time::Duration) -> Self {
        Timed::<F, PlatformTimer>::new(inner, timeout)
    }
}

impl<F: Future> Timed<F> {
    #[inline]
    ///Creates new instance using [Timer](../oneshot/type.Timer.html) alias.
    ///
    ///Unsafe version of `platform_new` that doesn't require `Unpin`.
    pub unsafe fn platform_new_unchecked(inner: F, timeout: time::Duration) -> Self {
        Timed::<F, PlatformTimer>::new_unchecked(inner, timeout)
    }
}

impl<F: Future + Unpin, T: Oneshot> Timed<F, T> {
    ///Creates new instance with specified timeout
    ///
    ///Requires to specify `Oneshot` type (e.g. `Timed::<oneshoot::Timer>::new()`)
    pub fn new(inner: F, timeout: time::Duration) -> Self {
        Timed::Ongoing(T::new(timeout), inner, timeout)
    }
}

impl<F: Future, T: Oneshot> Timed<F, T> {
    ///Creates new instance with specified timeout
    ///
    ///Unsafe version of `new` that doesn't require `Unpin`.
    ///
    ///Requires to specify `Oneshot` type (e.g. `Timed::<oneshoot::Timer>::new()`)
    pub unsafe fn new_unchecked(inner: F, timeout: time::Duration) -> Self {
        Timed::Ongoing(T::new(timeout), inner, timeout)
    }
}

impl<F: Future, T: Oneshot> Future for Timed<F, T> {
    type Output = Result<F::Output, Expired<F, T>>;

    fn poll(self: Pin<&mut Self>, ctx: &mut task::Context) -> task::Poll<Self::Output> {
        let mut state = Timed::Stopped;
        let mut this = unsafe { self.get_unchecked_mut() };
        mem::swap(&mut state, &mut this);

        match state {
            Timed::Ongoing(mut timer, mut future, timeout) => {
                match Future::poll(unsafe { Pin::new_unchecked(&mut future) }, ctx) {
                    task::Poll::Pending => (),
                    task::Poll::Ready(result) => return task::Poll::Ready(Ok(result)),
                }

                match Future::poll(Pin::new(&mut timer), ctx) {
                    task::Poll::Pending => (),
                    task::Poll::Ready(_) => return task::Poll::Ready(Err(Expired {
                        inner: Timed::Ongoing(timer, future, timeout),
                    })),
                }

                *this = Timed::Ongoing(timer, future, timeout);
                task::Poll::Pending
            },
            Timed::Stopped => task::Poll::Pending,
        }
    }
}

impl<F: Future + Unpin, T: Oneshot> Unpin for Timed<F, T> {}

///Error when [Timed](struct.Timed.html) expires
///
///Implements `Future` that can be used to restart `Timed`
///Note, that `Oneshot` starts execution immediately after resolving this Future
pub struct Expired<F, T> {
    inner: Timed<F, T>,
}

impl<F: Future, T: Oneshot> Expired<F, T> {
    ///Returns underlying `Future`
    pub fn into_inner(self) -> F {
        match self.inner {
            Timed::Ongoing(_, fut, _) => fut,
            _ => unreach!(),
        }
    }
}

impl<F: Future, T: Oneshot> Future for Expired<F, T> {
    type Output = Timed<F, T>;

    fn poll(self: Pin<&mut Self>, ctx: &mut task::Context) -> task::Poll<Self::Output> {
        let mut state = Timed::Stopped;
        let this = unsafe { self.get_unchecked_mut() };
        mem::swap(&mut this.inner, &mut state);

        match state {
            Timed::Ongoing(mut timer, future, timeout) => {
                timer.restart(timeout, ctx.waker());

                task::Poll::Ready(Timed::Ongoing(timer, future, timeout))
            },
            _ => task::Poll::Pending,
        }
    }
}

impl<F: Future + Unpin, T: Oneshot> Unpin for Expired<F, T> {}

#[cfg(not(feature = "no_std"))]
impl<F, T: Oneshot> crate::std::error::Error for Expired<F, T> {}
impl<F, T: Oneshot> fmt::Debug for Expired<F, T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self)
    }
}

impl<F, T: Oneshot> fmt::Display for Expired<F, T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self.inner {
            Timed::Stopped => write!(f, "Future is being re-tried."),
            Timed::Ongoing(_, _, timeout) => match timeout.as_secs() {
                0 => write!(f, "Future expired in {} ms", timeout.as_millis()),
                secs => write!(f, "Future expired in {} seconds and {} ms", secs, timeout.subsec_millis()),
            },
        }
    }
}