/
into_future.rs
97 lines (86 loc) · 3.51 KB
/
into_future.rs
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
use crate::stream::StreamExt;
use core::pin::Pin;
use futures_core::future::{FusedFuture, Future};
use futures_core::stream::Stream;
use futures_core::task::{Context, Poll};
use pin_utils::unsafe_pinned;
/// Future for the [`into_future`](super::StreamExt::into_future) method.
#[derive(Debug)]
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct StreamFuture<St> {
stream: Option<St>,
}
impl<St: Stream + Unpin> Unpin for StreamFuture<St> {}
impl<St: Stream + Unpin> StreamFuture<St> {
unsafe_pinned!(stream: Option<St>);
pub(super) fn new(stream: St) -> StreamFuture<St> {
StreamFuture { stream: Some(stream) }
}
/// Acquires a reference to the underlying stream that this combinator is
/// pulling from.
///
/// This method returns an `Option` to account for the fact that `StreamFuture`'s
/// implementation of `Future::poll` consumes the underlying stream during polling
/// in order to return it to the caller of `Future::poll` if the stream yielded
/// an element.
pub fn get_ref(&self) -> Option<&St> {
self.stream.as_ref()
}
/// Acquires a mutable reference to the underlying stream that this
/// combinator is pulling from.
///
/// Note that care must be taken to avoid tampering with the state of the
/// stream which may otherwise confuse this combinator.
///
/// This method returns an `Option` to account for the fact that `StreamFuture`'s
/// implementation of `Future::poll` consumes the underlying stream during polling
/// in order to return it to the caller of `Future::poll` if the stream yielded
/// an element.
pub fn get_mut(&mut self) -> Option<&mut St> {
self.stream.as_mut()
}
/// Acquires a pinned mutable reference to the underlying stream that this
/// combinator is pulling from.
///
/// Note that care must be taken to avoid tampering with the state of the
/// stream which may otherwise confuse this combinator.
///
/// This method returns an `Option` to account for the fact that `StreamFuture`'s
/// implementation of `Future::poll` consumes the underlying stream during polling
/// in order to return it to the caller of `Future::poll` if the stream yielded
/// an element.
pub fn get_pin_mut(self: Pin<&mut Self>) -> Option<Pin<&mut St>> {
self.stream().as_pin_mut()
}
/// Consumes this combinator, returning the underlying stream.
///
/// Note that this may discard intermediate state of this combinator, so
/// care should be taken to avoid losing resources when this is called.
///
/// This method returns an `Option` to account for the fact that `StreamFuture`'s
/// implementation of `Future::poll` consumes the underlying stream during polling
/// in order to return it to the caller of `Future::poll` if the stream yielded
/// an element.
pub fn into_inner(self) -> Option<St> {
self.stream
}
}
impl<St: Stream + Unpin> FusedFuture for StreamFuture<St> {
fn is_terminated(&self) -> bool {
self.stream.is_none()
}
}
impl<St: Stream + Unpin> Future for StreamFuture<St> {
type Output = (Option<St::Item>, St);
fn poll(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Self::Output> {
let item = {
let s = self.stream.as_mut().expect("polling StreamFuture twice");
ready!(s.poll_next_unpin(cx))
};
let stream = self.stream.take().unwrap();
Poll::Ready((item, stream))
}
}