atomic-take 1.0.0

Atomically take a value out of a container once.
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
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

# Atomic Take

![License](https://img.shields.io/badge/license-MIT-green.svg)
[![Cargo](https://img.shields.io/crates/v/atomic-take.svg)](https://crates.io/crates/atomic-take)
[![Documentation](https://docs.rs/atomic-take/badge.svg)](https://docs.rs/atomic-take)

This crate allows you to store a value that you can later take out atomically. As this
crate uses atomics, no locking is involved in taking the value out.

As an example, you could store the [`Sender`] of an oneshot channel in an
[`AtomicTake`], which would allow you to notify the first time a closure is called.

```rust
use atomic_take::AtomicTake;
use futures::sync::oneshot;

let (send, mut recv) = oneshot::channel();

let take = AtomicTake::new(send);
let closure = move || {
    if let Some(send) = take.take() {
        // Notify the first time this closure is called.
        send.send(()).unwrap();
    }
};

closure();
assert_eq!(recv.try_recv().unwrap(), Some(()));

closure(); // This does nothing.
```

Additionally the closure above can be called concurrently from many threads. For
example, if you put the `AtomicTake` in an [`Arc`], you can share it between several
threads and receive a message from the first thread to run.

```rust
use std::thread;
use std::sync::Arc;
use atomic_take::AtomicTake;
use futures::sync::oneshot;

let (send, mut recv) = oneshot::channel();

// Use an Arc to share the AtomicTake between several threads.
let take = Arc::new(AtomicTake::new(send));

// Spawn three threads and try to send a message from each.
let mut handles = Vec::new();
for i in 0..3 {
    let take_clone = Arc::clone(&take);
    let join_handle = thread::spawn(move || {

        // Check if this thread is first and send a message if so.
        if let Some(send) = take_clone.take() {
            // Send the index of the thread.
            send.send(i).unwrap();
        }

    });
    handles.push(join_handle);
}
// Wait for all three threads to finish.
for handle in handles {
    handle.join().unwrap();
}

// After all the threads finished, try to send again.
if let Some(send) = take.take() {
    // This will definitely not happen.
    send.send(100).unwrap();
}

// Confirm that one of the first three threads got to send the message first.
assert!(recv.try_recv().unwrap().unwrap() < 3);
```

This crate does not require the standard library.

[`Sender`]: https://docs.rs/futures/0.1.29/futures/sync/oneshot/struct.Sender.html
[`AtomicTake`]: https://docs.rs/atomic-take/1.0.0/atomic-take/struct.AtomicTake.html
[`Arc`]: https://doc.rust-lang.org/std/sync/struct.Arc.html