Function tokio::signal::ctrl_c

pub async fn ctrl_c() -> Result<()>

This is supported on feature="signal" only.

Completes when a "ctrl-c" notification is sent to the process.

While signals are handled very differently between Unix and Windows, both platforms support receiving a signal on "ctrl-c". This function provides a portable API for receiving this notification.

Once the returned future is polled, a listener a listener is registered. The future will complete on the first received ctrl-c after the initial call to either Future::poll or .await.

Examples

use tokio::signal;

#[tokio::main]
async fn main() {
    println!("waiting for ctrl-c");

    signal::ctrl_c().await.expect("failed to listen for event");

    println!("received ctrl-c event");
}