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

//! Definition of the MaybeDone combinator

use core::marker::Unpin;
use core::mem::{self, PinMut};
use futures_core::future::Future;
use futures_core::task::{self, Poll};

/// `MaybeDone`, a future that may have completed.
///
/// This is created by the `maybe_done` function.
#[derive(Debug)]
pub enum MaybeDone<Fut: Future> {
    /// A not-yet-completed future
    Future(Fut),
    /// The output of the completed future
    Done(Fut::Output),
    /// The empty variant after the result of a `maybe_done` has been
    /// taken using the `take_output` method.
    Gone,
}

// Safe because we never generate `PinMut<Fut::Output>`
impl<Fut: Future + Unpin> Unpin for MaybeDone<Fut> {}

/// Creates a new future from a closure.
pub fn maybe_done<Fut: Future>(future: Fut) -> MaybeDone<Fut> {
    MaybeDone::Future(future)
}

impl<Fut: Future> MaybeDone<Fut> {
    /// Attempt to take the output of a `MaybeDone` without driving it
    /// towards completion.
    pub fn take_output(self: PinMut<Self>) -> Option<Fut::Output> {
        unsafe {
            let this = PinMut::get_mut_unchecked(self);
            match this {
                MaybeDone::Done(_) => {},
                MaybeDone::Future(_) | MaybeDone::Gone => return None,
            };
            if let MaybeDone::Done(output) = mem::replace(this, MaybeDone::Gone) {
                Some(output)
            } else {
                unreachable!()
            }
        }
    }
}

impl<Fut: Future> Future for MaybeDone<Fut> {
    type Output = ();

    fn poll(mut self: PinMut<Self>, cx: &mut task::Context) -> Poll<Self::Output> {
        let res = unsafe {
            match PinMut::get_mut_unchecked(self.reborrow()) {
                MaybeDone::Future(a) => {
                    if let Poll::Ready(res) = PinMut::new_unchecked(a).poll(cx) {
                        res
                    } else {
                        return Poll::Pending
                    }
                }
                MaybeDone::Done(_) => return Poll::Ready(()),
                MaybeDone::Gone => panic!("MaybeDone polled after value taken"),
            }
        };
        PinMut::set(self, MaybeDone::Done(res));
        Poll::Ready(())
    }
}