Crate ctrlc2

CtrlC2

For this reason, I have decided to create a fork of ctrlc and maintain it. I will try to keep it up to date with the original repo. If you have any suggestions or want to contribute, please open an issue or a PR. Thanks! I will respond to issues and PRs as soon as possible.

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

Documentation

Example usage

In cargo.toml:

[dependencies]
ctrlc2 = "3.7"

then, in main.rs

{
    let handle = ctrlc2::set_handler(move || {
        println!(" ");
        println!("Ctrl-C received, ready to exiting...");
        true
    })
    .unwrap();
    println!("Waiting for Ctrl-C...");
    handle.join().unwrap();
    println!("Got it! Exiting...");
}

Asynchronous support

This library now supports asynchronous operation. You can use the async feature, it very simple:

#[cfg(all(feature = "async", feature = "tokio"))]
#[tokio::main(flavor = "current_thread")]
async fn main() {
    let ctrlc = ctrlc2::AsyncCtrlC::new(move || {
        println!("Ctrl-C received! Ready to exiting...");
        true
    })
    .expect("cannot create Ctrl+C handler");

    println!("Waiting for Ctrl-C...");
    ctrlc.await.unwrap();
    println!("Got it! Exiting...");
}

#[cfg(not(all(feature = "async", feature = "tokio")))]
fn main() {
    println!("This example requires the `async` and `tokio` features to be enabled.");
}

You can alse select the tokio runtime using feature flags (e.g. –no-default-features –features tokio)

#[cfg(feature = "tokio")]
#[cfg_attr(feature = "tokio", tokio::main(flavor = "current_thread"))]
async fn main() {
    let (tx, mut rx) = tokio::sync::mpsc::channel::<()>(1);

    ctrlc2::set_async_handler(async move {
        tx.send(())
            .await
            .expect("Could not send signal on channel.");
    })
    .await;

    println!("Waiting for Ctrl-C...");
    rx.recv().await.expect("Could not receive from channel.");
    println!("Got it! Exiting...");
}

#[cfg(not(feature = "tokio"))]
fn main() {
    println!("This example requires the `tokio` features to be enabled.");
}

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 or APACHE)
• MIT license (LICENSE-MIT or 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
• tokio::signal

Structs

AsyncCtrlC

A future which is fulfilled when the program receives the Ctrl+C signal.

Enums

Error

Ctrl-C error.

SignalType

A cross-platform way to represent Ctrl-C or program termination signal. Other signals/events are supported via Other-variant.

Functions

set_async_handlerDeprecated

Register signal handler in tokio runtime for Ctrl-C.

set_handler

Register signal handler for Ctrl-C.

try_set_handler

The same as ctrlc2::set_handler but errors if a handler already exists for the signal(s).

Type Aliases

Signal

Platform specific signal type