about summary refs log tree commit diff
path: root/src/libcore/future.rs
blob: 83dc6b7178b702ae93a17699885fcdfcf1e5aa0e (plain)
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/*!
 * A type representing values that may be computed concurrently and
 * operations for working with them.
 *
 * # Example
 *
 * ~~~
 * let delayed_fib = future::spawn {|| fib(5000) };
 * make_a_sandwich();
 * io::println(fmt!{"fib(5000) = %?", delayed_fib.get()})
 * ~~~
 */

import either::either;
import pipes::recv;

export future;
export extensions;
export from_value;
export from_port;
export from_fn;
export get;
export with;
export spawn;

// for task.rs
export future_pipe;

#[doc = "The future type"]
enum future<A> = {
    mut v: either<@A, fn@() -> A>
};

/// Methods on the `future` type
impl extensions<A:copy send> for future<A> {

    fn get() -> A {
        //! Get the value of the future

        get(self)
    }

    fn with<B>(blk: fn(A) -> B) -> B {
        //! Work with the value without copying it

        with(self, blk)
    }
}

fn from_value<A>(+val: A) -> future<A> {
    /*!
     * Create a future from a value
     *
     * The value is immediately available and calling `get` later will
     * not block.
     */

    future({
        mut v: either::left(@val)
    })
}

macro_rules! move{
    {$x:expr} => { unsafe { let y <- *ptr::addr_of($x); y } }
}

fn from_port<A:send>(-port: future_pipe::client::waiting<A>) -> future<A> {
    #[doc = "
    Create a future from a port

    The first time that the value is requested the task will block
    waiting for the result to be received on the port.
    "];

    let port = ~mut some(port);
    do from_fn |move port| {
        let mut port_ = none;
        port_ <-> *port;
        let port = option::unwrap(port_);
        alt recv(port) {
          future_pipe::completed(data) { move!{data} }
        }
    }
}

fn from_fn<A>(f: fn@() -> A) -> future<A> {
    /*!
     * Create a future from a function.
     *
     * The first time that the value is requested it will be retreived by
     * calling the function.  Note that this function is a local
     * function. It is not spawned into another task.
     */

    future({
        mut v: either::right(f)
    })
}

fn spawn<A:send>(+blk: fn~() -> A) -> future<A> {
    /*!
     * Create a future from a unique closure.
     *
     * The closure will be run in a new task and its result used as the
     * value of the future.
     */

    from_port(pipes::spawn_service_recv(future_pipe::init, |ch| {
        future_pipe::server::completed(ch, blk());
    }))
}

fn get<A:copy>(future: future<A>) -> A {
    //! Get the value of the future

    do with(future) |v| { v }
}

fn with<A,B>(future: future<A>, blk: fn(A) -> B) -> B {
    //! Work with the value without copying it

    let v = alt copy future.v {
      either::left(v) { v }
      either::right(f) {
        let v = @f();
        future.v = either::left(v);
        v
      }
    };
    blk(*v)
}

proto! future_pipe {
    waiting:recv<T:send> {
        completed(T) -> !
    }
}

#[test]
fn test_from_value() {
    let f = from_value(~"snail");
    assert get(f) == ~"snail";
}

#[test]
fn test_from_port() {
    let (po, ch) = future_pipe::init();
    future_pipe::server::completed(ch, ~"whale");
    let f = from_port(po);
    assert get(f) == ~"whale";
}

#[test]
fn test_from_fn() {
    let f = fn@() -> ~str { ~"brail" };
    let f = from_fn(f);
    assert get(f) == ~"brail";
}

#[test]
fn test_iface_get() {
    let f = from_value(~"fail");
    assert f.get() == ~"fail";
}

#[test]
fn test_with() {
    let f = from_value(~"nail");
    assert with(f, |v| v) == ~"nail";
}

#[test]
fn test_iface_with() {
    let f = from_value(~"kale");
    assert f.with(|v| v) == ~"kale";
}

#[test]
fn test_spawn() {
    let f = spawn(|| ~"bale");
    assert get(f) == ~"bale";
}

#[test]
#[should_fail]
#[ignore(cfg(target_os = "win32"))]
fn test_futurefail() {
    let f = spawn(|| fail);
    let _x: ~str = get(f);
}