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
166
167
168
169
170
171
use std::pin::Pin;
use std::sync::{Arc, Mutex};

use futures::Future;
use futures::task::{Context, Poll};

/// An adapter between callbacks and futures.
///
/// Allows wrapping asynchronous API with callbacks into futures.
/// Calls loader upon first `Future::poll` call; stores result and wakes upon getting callback.
pub struct CallbackFuture<T> {
    loader: Option<Box<dyn FnOnce(Box<dyn FnOnce(T) + Send + 'static>) + Send + 'static>>,
    result: Arc<Mutex<Option<T>>>,
}

impl<T> CallbackFuture<T> {
    /// Creates a new CallbackFuture
    ///
    /// # Examples
    /// ```
    /// use callback_future::CallbackFuture;
    /// use futures::executor::block_on;
    /// use std::thread;
    /// use std::time::Duration;
    ///
    /// let future = CallbackFuture::new(|complete| {
    ///     // make call with callback here, call `complete` upon callback reception, e.g.:
    ///     thread::spawn(move || {
    ///         complete("Test");
    ///     });
    /// });
    /// assert_eq!(block_on(future), "Test");
    /// ```
    pub fn new(loader: impl FnOnce(Box<dyn FnOnce(T) + Send + 'static>) + Send + 'static)
               -> CallbackFuture<T> {
        CallbackFuture {
            loader: Some(Box::new(loader)),
            result: Arc::new(Mutex::new(None)),
        }
    }

    /// Creates a ready CallbackFuture
    ///
    /// # Examples
    /// ```
    /// use callback_future::CallbackFuture;
    /// use futures::executor::block_on;
    ///
    /// assert_eq!(block_on(CallbackFuture::ready("Test")), "Test");
    /// ```
    pub fn ready(value: T) -> CallbackFuture<T> {
        CallbackFuture {
            loader: None,
            result: Arc::new(Mutex::new(Some(value))),
        }
    }
}

impl<T: Send + 'static> Future for CallbackFuture<T> {
    type Output = T;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        let self_mut = self.get_mut();
        match self_mut.loader.take() {
            // in case loader is still present, loader was not yet invoked: invoke it
            Some(loader) => {
                let waker = cx.waker().clone();
                let result = self_mut.result.clone();
                loader(Box::new(move |value| {
                    *result.lock().unwrap() = Some(value);
                    waker.wake();
                }));
                Poll::Pending
            }
            // in case loader was moved-out: either result is already ready,
            // or we haven't yet received callback
            None => {
                match self_mut.result.lock().unwrap().take() {
                    Some(value) => Poll::Ready(value),
                    None => Poll::Pending, // we haven't received callback yet
                }
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use std::thread;
    use std::time::Duration;

    use futures::{executor::block_on, join};

    use crate::CallbackFuture;

    #[test]
    fn test_complete_async() {
        let fu = CallbackFuture::new(move |complete| {
            thread::spawn(move || { complete(42); });
        });

        assert_eq!(block_on(fu), 42);
    }

    #[test]
    fn test_complete_sync() {
        let fu = CallbackFuture::new(move |complete| {
            complete(42);
        });

        assert_eq!(block_on(fu), 42);
    }

    #[test]
    fn test_ready() {
        let fu = CallbackFuture::ready(42);

        assert_eq!(block_on(fu), 42);
    }

    #[test]
    fn test_join() {
        let all = async {
            let fu1 = CallbackFuture::new(move |complete| {
                complete("Hello");
            });

            let fu2 = CallbackFuture::ready(", ");

            let fu3 = CallbackFuture::new(move |complete| {
                thread::spawn(move || { complete("world!"); });
            });

            let (r1, r2, r3) = join!(fu1, fu2, fu3);
            [r1, r2, r3].concat()
        };

        assert_eq!(block_on(all), "Hello, world!");
    }

    #[test]
    fn test_await() {
        let all = async {
            let r1 = CallbackFuture::new(move |complete| {
                thread::sleep(Duration::from_millis(100));
                complete("Hello");
            }).await;

            let r2 = CallbackFuture::ready(", ").await;

            let r3 = CallbackFuture::new(move |complete| {
                thread::spawn(move || { complete("world!"); });
            }).await;

            [r1, r2, r3].concat()
        };

        assert_eq!(block_on(all), "Hello, world!");
    }

    #[test]
    fn test_async_fn() {
        async fn do_async() -> String {
            CallbackFuture::new(move |complete| {
                thread::spawn(move || { complete("Hello, world!".to_string()); });
            }).await
        }

        assert_eq!(block_on(do_async()), "Hello, world!");
    }
}