Trait Push

Source

pub trait Push<T> {
    // Required method
    fn push(&mut self, element: &mut Option<T>);

    // Provided methods
    fn send(&mut self, element: T) { ... }
    fn done(&mut self) { ... }
}

Expand description

Pushing elements of type T.

This trait moves data around using references rather than ownership, which provides the opportunity for zero-copy operation. In the call to push(element) the implementor can swap some other value to replace element, effectively returning the value to the caller.

Conventionally, a sequence of calls to push() should conclude with a call of push(&mut None) or done() to signal to implementors that another call to push() may not be coming.

Required Methods§

Source

fn push(&mut self, element: &mut Option<T>)

Pushes element with the opportunity to take ownership.

Provided Methods§

Source

fn send(&mut self, element: T)

Pushes element and drops any resulting resources.

Examples found in repository ?

examples/comm_hello.rs (line 19)

6fn main() {
7
8    // extract the configuration from user-supplied arguments, initialize the computation.
9    let config = timely_communication::Config::from_args(std::env::args()).unwrap();
10    let guards = timely_communication::initialize(config, |mut allocator| {
11
12        println!("worker {} of {} started", allocator.index(), allocator.peers());
13
14        // allocates a pair of senders list and one receiver.
15        let (mut senders, mut receiver) = allocator.allocate(0);
16
17        // send typed data along each channel
18        for i in 0 .. allocator.peers() {
19            senders[i].send(Message::from_typed(format!("hello, {}", i)));
20            senders[i].done();
21        }
22
23        // no support for termination notification,
24        // we have to count down ourselves.
25        let mut received = 0;
26        while received < allocator.peers() {
27
28            allocator.receive();
29
30            if let Some(message) = receiver.recv() {
31                println!("worker {}: received: <{}>", allocator.index(), message.deref());
32                received += 1;
33            }
34
35            allocator.release();
36        }
37
38        allocator.index()
39    });
40
41    // computation runs until guards are joined or dropped.
42    if let Ok(guards) = guards {
43        for guard in guards.join() {
44            println!("result: {:?}", guard);
45        }
46    }
47    else { println!("error in computation"); }
48}

Source

fn done(&mut self)

Pushes None, conventionally signalling a flush.

Examples found in repository ?

examples/comm_hello.rs (line 20)

6fn main() {
7
8    // extract the configuration from user-supplied arguments, initialize the computation.
9    let config = timely_communication::Config::from_args(std::env::args()).unwrap();
10    let guards = timely_communication::initialize(config, |mut allocator| {
11
12        println!("worker {} of {} started", allocator.index(), allocator.peers());
13
14        // allocates a pair of senders list and one receiver.
15        let (mut senders, mut receiver) = allocator.allocate(0);
16
17        // send typed data along each channel
18        for i in 0 .. allocator.peers() {
19            senders[i].send(Message::from_typed(format!("hello, {}", i)));
20            senders[i].done();
21        }
22
23        // no support for termination notification,
24        // we have to count down ourselves.
25        let mut received = 0;
26        while received < allocator.peers() {
27
28            allocator.receive();
29
30            if let Some(message) = receiver.recv() {
31                println!("worker {}: received: <{}>", allocator.index(), message.deref());
32                received += 1;
33            }
34
35            allocator.release();
36        }
37
38        allocator.index()
39    });
40
41    // computation runs until guards are joined or dropped.
42    if let Ok(guards) = guards {
43        for guard in guards.join() {
44            println!("result: {:?}", guard);
45        }
46    }
47    else { println!("error in computation"); }
48}