sync-oneshot 0.2.0

A minimal oneshot channel for synchronous Rust.
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

# sync-oneshot
[![crates.io][crates.io-badge]][crates.io-url]
[![docs.rs][docs-rs-badge]][docs-rs-url]
[![GitHub License][licence-badge]][licence-url]
[![Build Status][actions-badge]][actions-url]

[crates.io-badge]: https://img.shields.io/crates/v/sync-oneshot.svg
[crates.io-url]: https://crates.io/crates/sync-oneshot
[docs-rs-badge]: https://img.shields.io/docsrs/sync-oneshot/latest
[docs-rs-url]: https://docs.rs/sync-oneshot
[licence-badge]: https://img.shields.io/github/license/locksmith-rs/sync-oneshot
[licence-url]: https://github.com/locksmith-rs/sync-oneshot/blob/docs-readme/LICENSE
[actions-badge]: https://github.com/locksmith-rs/sync-oneshot/workflows/ci/badge.svg
[actions-url]: https://github.com/locksmith-rs/sync-oneshot/actions?query=branch%3Amain+workflow%3ACI+

A minimal oneshot channel for synchronous Rust.

A oneshot channel is used for sending a single message between threads.  
The `channel` function is used to create a `Sender` and `Receiver`
handle pair that form the channel.

The `Sender` handle is used by the producer to send the value.  
The `Receiver` handle is used by the consumer to receive the value.

Each handle can be used on other threads.

`Sender::send` will no block the calling thread.  
`Receiver::recv` will **block** the calling thread.

## Example
```rust
use std::time::Duration;

let (tx, rx) = sync_oneshot::channel();

std::thread::spawn(move || {
    std::thread::sleep(Duration::from_millis(200));
    tx.send(5).unwrap();
});

// blocking thread until a message available
let val = rx.recv().unwrap();
assert_eq!(val, 5);
```

## Licence
`sync-oneshot` is provided under the MIT license.See [LICENSE](LICENSE)