futures 0.1.6

An implementation of futures and streams featuring zero allocations, composability, and iterator-like interfaces.
Documentation 
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

//! Definition of the Ok combinator, a successful value that's immediately
//! ready.

use core::marker;

use {Future, Poll, Async};

/// A future representing a finished successful computation.
///
/// Created by the `finished` function.
#[must_use = "futures do nothing unless polled"]
pub struct Ok<T, E> {
    t: Option<T>,
    _e: marker::PhantomData<E>,
}

/// Creates a "leaf future" from an immediate value of a finished and
/// successful computation.
///
/// The returned future is similar to `done` where it will immediately run a
/// scheduled callback with the provided value.
///
/// # Examples
///
/// ```
/// use futures::future::*;
///
/// let future_of_1 = ok::<u32, u32>(1);
/// ```
pub fn ok<T, E>(t: T) -> Ok<T, E> {
    Ok { t: Some(t), _e: marker::PhantomData }
}

impl<T, E> Future for Ok<T, E> {
    type Item = T;
    type Error = E;


    fn poll(&mut self) -> Poll<T, E> {
        Ok(Async::Ready(self.t.take().expect("cannot poll Ok twice")))
    }
}