blob: c75f87e973c2adfb828b032120f328a6b9c4f06b (
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
|
# CtrlC
[](https://travis-ci.org/Detegr/rust-ctrlc)
[](https://ci.appveyor.com/project/Detegr/rust-ctrlc/branch/master)
A simple easy to use wrapper around Ctrl-C signal.
[Documentation](http://detegr.github.io/doc/ctrlc/)
## Example usage
In `cargo.toml`:
```toml
[dependencies]
ctrlc = "3.4.0"
```
then, in `main.rs`
```rust
use std::sync::mpsc::channel;
use ctrlc;
fn main() {
let (tx, rx) = channel();
ctrlc::set_handler(move || tx.send(()).expect("Could not send signal on channel."))
.expect("Error setting Ctrl-C handler");
println!("Waiting for Ctrl-C...");
rx.recv().expect("Could not receive from channel.");
println!("Got it! Exiting...");
}
```
#### Try the example yourself
`cargo build --examples && target/debug/examples/readme_example`
## Handling SIGTERM and SIGHUP
Add CtrlC to Cargo.toml using `termination` feature and CtrlC will handle SIGINT, SIGTERM and SIGHUP.
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you shall be dual licensed as above, without any
additional terms or conditions.
## Similar crates
There are alternatives that give you more control over the different signals and/or add async support.
- [signal-hook](https://github.com/vorner/signal-hook)
- [tokio::signal](https://docs.rs/tokio/latest/tokio/signal/index.html)
|
