38 lines
5.9 KiB
HTML
38 lines
5.9 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Completes when a “ctrl-c” notification is sent to the process."><title>ctrl_c in tokio::signal - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="tokio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">ctrl_c</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../tokio/index.html">tokio</a><span class="version">1.49.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">ctrl_c</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#caveats" title="Caveats">Caveats</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In tokio::<wbr>signal</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">tokio</a>::<wbr><a href="index.html">signal</a></div><h1>Function <span class="fn">ctrl_c</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/tokio/signal/ctrl_c.rs.html#59-62">Source</a> </span></div><pre class="rust item-decl"><code>pub async fn ctrl_c() -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Completes when a “ctrl-c” notification is sent to the process.</p>
|
|
<p>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.</p>
|
|
<p>Once the returned future is polled, a listener is registered. The future
|
|
will complete on the first received <code>ctrl-c</code> <strong>after</strong> the initial call to
|
|
either <code>Future::poll</code> or <code>.await</code>.</p>
|
|
<h2 id="caveats"><a class="doc-anchor" href="#caveats">§</a>Caveats</h2>
|
|
<p>On Unix platforms, the first time that a <code>Signal</code> instance is registered for a
|
|
particular signal kind, an OS signal-handler is installed which replaces the
|
|
default platform behavior when that signal is received, <strong>for the duration of
|
|
the entire process</strong>.</p>
|
|
<p>For example, Unix systems will terminate a process by default when it
|
|
receives a signal generated by <code>"CTRL+C"</code> on the terminal. But, when a
|
|
<code>ctrl_c</code> stream is created to listen for this signal, the time it arrives,
|
|
it will be translated to a stream event, and the process will continue to
|
|
execute. <strong>Even if this <code>Signal</code> instance is dropped, subsequent <code>SIGINT</code>
|
|
deliveries will end up captured by Tokio, and the default platform behavior
|
|
will NOT be reset</strong>.</p>
|
|
<p>Thus, applications should take care to ensure the expected signal behavior
|
|
occurs as expected after listening for specific signals.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::signal;
|
|
|
|
<span class="attr">#[tokio::main]
|
|
</span><span class="kw">async fn </span>main() {
|
|
<span class="macro">println!</span>(<span class="string">"waiting for ctrl-c"</span>);
|
|
|
|
signal::ctrl_c().<span class="kw">await</span>.expect(<span class="string">"failed to listen for event"</span>);
|
|
|
|
<span class="macro">println!</span>(<span class="string">"received ctrl-c event"</span>);
|
|
}</code></pre></div>
|
|
<p>Listen in the background:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>tokio::spawn(<span class="kw">async move </span>{
|
|
tokio::signal::ctrl_c().<span class="kw">await</span>.unwrap();
|
|
<span class="comment">// Your handler here
|
|
</span>});</code></pre></div></div></details></section></div></main></body></html> |