thread-guard 0.1.0

A simple thread guard.
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

# Thread guard

This crate contains a simple thread guard.

The thread guard is used to ensure that the thread in question is always
joined.

Pre-action and post-action can be defined to execute before and after
thread joining, respectively. The pre-action is typically used to send a
message to the thread, triggering its exit, while the post-action handles
the thread's result.

In the simplest case, the guard can be used without pre-action and
post-action:

```rust
use std::thread;
use thread_guard::ThreadGuard;

let guard = ThreadGuard::new(
    thread::spawn(|| {
        // Do something and exit.
    }));
```

The post-action can be used to handle the thread result:

```rust
use std::thread;
use thread_guard::ThreadGuard;

let guard = ThreadGuard::with_post_action(
    thread::spawn(|| {
        1
    }),
    |r| {println!("The thread exited with the result {:?}", r)});
```

If the thread needs to be signaled to exit, a pre-action can be used:

```rust
use std::sync::mpsc::{channel, RecvError};
use std::thread;
use thread_guard::ThreadGuard;

let (tx, rx) = channel();
let guard = ThreadGuard::with_pre_action(
    thread::spawn(move || -> Result<(), RecvError>{
        rx.recv()?;
        Ok(())
    }),
    move |_| {let _ = tx.send(());});
```

Finally, a pre-action may need some data that outlives the appropriate
closure. An example is provided in the `examples` directory.