From 79cb96c17d12978a4308462400188c06855ec24a Mon Sep 17 00:00:00 2001 From: Jonathan Date: Thu, 14 Oct 2021 20:26:43 +0200 Subject: [PATCH 1/2] Add example with background listener --- tokio/src/signal/ctrl_c.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/tokio/src/signal/ctrl_c.rs b/tokio/src/signal/ctrl_c.rs index 1eeeb85aa17..da128b3f927 100644 --- a/tokio/src/signal/ctrl_c.rs +++ b/tokio/src/signal/ctrl_c.rs @@ -47,6 +47,15 @@ use std::io; /// println!("received ctrl-c event"); /// } /// ``` +/// +/// Listen in the background: +/// +/// ```rust,no_run +/// tokio::spawn(async move { +/// tokio::signal::ctrl_c().await; +/// // Your handler here +/// }); +/// ``` pub async fn ctrl_c() -> io::Result<()> { os_impl::ctrl_c()?.recv().await; Ok(()) From 365cda276a8b51ca3af8e89a011176aab9f9bec4 Mon Sep 17 00:00:00 2001 From: Jonathan Date: Fri, 15 Oct 2021 16:20:02 +0200 Subject: [PATCH 2/2] Update tokio/src/signal/ctrl_c.rs Co-authored-by: Alice Ryhl --- tokio/src/signal/ctrl_c.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tokio/src/signal/ctrl_c.rs b/tokio/src/signal/ctrl_c.rs index da128b3f927..b26ab7ead64 100644 --- a/tokio/src/signal/ctrl_c.rs +++ b/tokio/src/signal/ctrl_c.rs @@ -52,7 +52,7 @@ use std::io; /// /// ```rust,no_run /// tokio::spawn(async move { -/// tokio::signal::ctrl_c().await; +/// tokio::signal::ctrl_c().await.unwrap(); /// // Your handler here /// }); /// ```