futures_util/future/poll_fn.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
//! Definition of the `PollFn` adapter combinator
use futures_core::{Future, Poll};
use futures_core::task;
/// A future which adapts a function returning `Poll`.
///
/// Created by the `poll_fn` function.
#[derive(Debug)]
#[must_use = "futures do nothing unless polled"]
pub struct PollFn<F> {
inner: F,
}
/// Creates a new future wrapping around a function returning `Poll`.
///
/// Polling the returned future delegates to the wrapped function.
///
/// # Examples
///
/// ```
/// # extern crate futures;
/// use futures::prelude::*;
/// use futures::future::poll_fn;
/// use futures::never::Never;
/// use futures::task;
///
/// # fn main() {
/// fn read_line(cx: &mut task::Context) -> Poll<String, Never> {
/// Ok(Async::Ready("Hello, World!".into()))
/// }
///
/// let read_future = poll_fn(read_line);
/// # }
/// ```
pub fn poll_fn<T, E, F>(f: F) -> PollFn<F>
where F: FnMut(&mut task::Context) -> Poll<T, E>
{
PollFn { inner: f }
}
impl<T, E, F> Future for PollFn<F>
where F: FnMut(&mut task::Context) -> Poll<T, E>
{
type Item = T;
type Error = E;
fn poll(&mut self, cx: &mut task::Context) -> Poll<T, E> {
(self.inner)(cx)
}
}