async-utility 0.3.1

Collection of async utilities.
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
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

// Copyright (c) 2022-2023 Yuki Kishimoto
// Distributed under the MIT software license

//! Time module

use core::future::Future;
use core::time::Duration;

use futures_util::future::{AbortHandle, Abortable};
#[cfg(target_arch = "wasm32")]
use wasm_bindgen_futures::spawn_local;

#[cfg(not(target_arch = "wasm32"))]
use crate::runtime;

/// Sleep
pub async fn sleep(duration: Duration) {
    #[cfg(not(target_arch = "wasm32"))]
    if runtime::is_tokio_context() {
        tokio::time::sleep(duration).await;
    } else {
        // No need to propagate error
        let _ = runtime::handle()
            .spawn(async move {
                tokio::time::sleep(duration).await;
            })
            .await;
    }

    #[cfg(target_arch = "wasm32")]
    gloo_timers::future::sleep(duration).await;
}

/// Timeout
pub async fn timeout<F>(timeout: Option<Duration>, future: F) -> Option<F::Output>
where
    F: Future,
{
    #[cfg(not(target_arch = "wasm32"))]
    if let Some(timeout) = timeout {
        if runtime::is_tokio_context() {
            tokio::time::timeout(timeout, future).await.ok()
        } else {
            let (abort_handle, abort_registration) = AbortHandle::new_pair();
            let future = Abortable::new(future, abort_registration);
            tokio::select! {
                res = future => {
                    res.ok()
                }
                _ = sleep(timeout) => {
                    abort_handle.abort();
                    None
                }
            }
        }
    } else {
        Some(future.await)
    }

    #[cfg(target_arch = "wasm32")]
    {
        if let Some(timeout) = timeout {
            let (abort_handle, abort_registration) = AbortHandle::new_pair();
            let future = Abortable::new(future, abort_registration);
            spawn_local(async move {
                gloo_timers::callback::Timeout::new(timeout.as_millis() as u32, move || {
                    abort_handle.abort();
                })
                .forget();
            });
            future.await.ok()
        } else {
            Some(future.await)
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    // TODO: test also wasm

    #[tokio::test]
    #[cfg(not(target_arch = "wasm32"))]
    async fn test_sleep_in_tokio() {
        sleep(Duration::from_secs(5)).await;
    }

    #[async_std::test]
    #[cfg(not(target_arch = "wasm32"))]
    async fn test_sleep_in_async_std() {
        sleep(Duration::from_secs(5)).await;
    }

    #[test]
    #[cfg(not(target_arch = "wasm32"))]
    fn test_sleep_in_smol() {
        smol::block_on(async {
            sleep(Duration::from_secs(5)).await;
        });
    }

    #[tokio::test]
    #[cfg(not(target_arch = "wasm32"))]
    async fn test_timeout_tokio() {
        // Timeout
        let result = timeout(Some(Duration::from_secs(1)), async {
            sleep(Duration::from_secs(2)).await;
        })
        .await;
        assert!(result.is_none());

        // Not timeout
        let result = timeout(Some(Duration::from_secs(10)), async {
            sleep(Duration::from_secs(1)).await;
        })
        .await;
        assert!(result.is_some());
    }

    #[async_std::test]
    #[cfg(not(target_arch = "wasm32"))]
    async fn test_timeout_async_std() {
        // Timeout
        let result = timeout(Some(Duration::from_secs(1)), async {
            sleep(Duration::from_secs(2)).await;
        })
        .await;
        assert!(result.is_none());

        // Not timeout
        let result = timeout(Some(Duration::from_secs(10)), async {
            sleep(Duration::from_secs(1)).await;
        })
        .await;
        assert!(result.is_some());
    }

    #[test]
    #[cfg(not(target_arch = "wasm32"))]
    fn test_timeout_smol() {
        smol::block_on(async {
            // Timeout
            let result = timeout(Some(Duration::from_secs(1)), async {
                sleep(Duration::from_secs(2)).await;
            })
            .await;
            assert!(result.is_none());

            // Not timeout
            let result = timeout(Some(Duration::from_secs(10)), async {
                sleep(Duration::from_secs(1)).await;
            })
            .await;
            assert!(result.is_some());
        });
    }
}