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

use std::marker::PhantomData;
use std::pin::Pin;

use pin_project_lite::pin_project;

use crate::future::Future;
use crate::stream::Stream;
use crate::task::{Context, Poll};

pin_project! {
    /// A stream that yields elements by calling a closure.
    ///
    /// This stream is created by the [`from_fn`] function. See its
    /// documentation for more.
    ///
    /// [`from_fn`]: fn.from_fn.html
    #[derive(Debug)]
    pub struct FromFn<F, Fut, T> {
        f: F,
        #[pin]
        future: Option<Fut>,
        __t: PhantomData<T>,
    }
}

/// Creates a new stream where to produce each new element a provided closure is called.
///
/// This allows creating a custom stream with any behaviour without using the more verbose
/// syntax of creating a dedicated type and implementing a `Stream` trait for it.
///
/// # Examples
///
/// ```
/// # async_std::task::block_on(async {
/// #
/// use async_std::prelude::*;
/// use async_std::sync::Mutex;
/// use std::sync::Arc;
/// use async_std::stream;
///
/// let count = Arc::new(Mutex::new(0u8));
/// let s = stream::from_fn(|| {
///     let count = Arc::clone(&count);
///
///     async move {
///         *count.lock().await += 1;
///
///         if *count.lock().await > 3 {
///             None
///         } else {
///             Some(*count.lock().await)
///         }
///     }
/// });
///
/// pin_utils::pin_mut!(s);
/// assert_eq!(s.next().await, Some(1));
/// assert_eq!(s.next().await, Some(2));
/// assert_eq!(s.next().await, Some(3));
/// assert_eq!(s.next().await, None);
/// #
/// # })
/// ```
pub fn from_fn<T, F, Fut>(f: F) -> FromFn<F, Fut, T>
where
    F: FnMut() -> Fut,
    Fut: Future<Output = Option<T>>,
{
    FromFn {
        f,
        future: None,
        __t: PhantomData,
    }
}

impl<F, Fut, T> Stream for FromFn<F, Fut, T>
where
    F: FnMut() -> Fut,
    Fut: Future<Output = Option<T>>,
{
    type Item = T;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let mut this = self.project();
        loop {
            if this.future.is_some() {
                let next =
                    futures_core::ready!(this.future.as_mut().as_pin_mut().unwrap().poll(cx));
                this.future.set(None);

                return Poll::Ready(next);
            } else {
                let fut = (this.f)();
                this.future.set(Some(fut));
            }
        }
    }
}