34 stable releases (3 major)

3.4.5 Aug 13, 2024
3.4.4 Mar 10, 2024
3.4.2 Dec 22, 2023
3.4.1 Sep 3, 2023
0.1.1 Jul 16, 2015

#6 in Operating systems

Download history 311610/week @ 2024-07-18 330700/week @ 2024-07-25 300720/week @ 2024-08-01 348955/week @ 2024-08-08 359791/week @ 2024-08-15 381243/week @ 2024-08-22 353949/week @ 2024-08-29 416386/week @ 2024-09-05 405814/week @ 2024-09-12 412345/week @ 2024-09-19 441989/week @ 2024-09-26 458788/week @ 2024-10-03 447209/week @ 2024-10-10 472728/week @ 2024-10-17 489873/week @ 2024-10-24 441427/week @ 2024-10-31

1,946,154 downloads per month
Used in 1,116 crates (882 directly)

MIT/Apache

21KB
294 lines

CtrlC

A simple easy to use wrapper around Ctrl-C signal.

Documentation

Example usage

In cargo.toml:

[dependencies]
ctrlc = "3.4"

then, in main.rs

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

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.

Dependencies

~1.5–9.5MB
~96K SLoC