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

use core::marker::PhantomData;
use core::pin::Pin;

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

/// Creates a stream that doesn't yield any items.

///

/// This `struct` is created by the [`empty`] function. See its

/// documentation for more.

///

/// [`empty`]: fn.empty.html

///

/// # Examples

///

/// ```

/// # async_std::task::block_on(async {

/// #

/// use async_std::prelude::*;

/// use async_std::stream;

///

/// let mut s = stream::empty::<i32>();

///

/// assert_eq!(s.next().await, None);

/// #

/// # })

/// ```

pub fn empty<T>() -> Empty<T> {
    Empty {
        _marker: PhantomData,
    }
}

/// A stream that doesn't yield any items.

///

/// This stream is constructed by the [`empty`] function.

///

/// [`empty`]: fn.empty.html

#[derive(Debug)]
pub struct Empty<T> {
    _marker: PhantomData<T>,
}

impl<T> Stream for Empty<T> {
    type Item = T;

    fn poll_next(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        Poll::Ready(None)
    }
}