ctrlc-async

Crates.ioctrlc-async
lib.rsctrlc-async
version3.2.2
sourcesrc
created_at2021-10-17 14:03:29.606431
updated_at2021-10-17 15:27:31.779839
descriptionEasy asynchronous Ctrl-C handler for Rust projects
homepagehttps://github.com/Detegr/rust-ctrlc
repositoryhttps://github.com/Detegr/rust-ctrlc.git
max_upload_size
id466199
size62,666
Johnathan Sharratt (john-sharratt)

documentation

http://detegr.github.io/doc/ctrlc

README

CtrlC

Build Status Build status

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

Documentation

Example usage

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.

[dependencies]
ctrlc = { version = "3.0", features = ["termination"] }

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.

Commit count: 199

cargo fmt