github-actions[bot]
38 lines
6.0 KiB
HTML
38 lines
6.0 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="API documentation for the Rust `ctrl_c` fn in crate `tokio`."><meta name="keywords" content="rust, rustlang, rust-lang, ctrl_c"><title>tokio::signal::ctrl_c - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tokio/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="../index.html">tokio</a>::<wbr><a href="index.html">signal</a></p><div id="sidebar-vars" data-name="ctrl_c" data-ty="fn" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">tokio</a>::<wbr><a href="index.html">signal</a>::<wbr><a class="fn" href="">ctrl_c</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tokio/signal/ctrl_c.rs.html#50-53" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub async fn ctrl_c() -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></pre><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>
|
||
<h1 id="caveats" class="section-header"><a href="#caveats">Caveats</a></h1>
|
||
<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 "CTRL+C" 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 SIGINT
|
||
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>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">signal</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"waiting for ctrl-c"</span>);
|
||
|
||
<span class="ident">signal</span>::<span class="ident">ctrl_c</span>().<span class="kw">await</span>.<span class="ident">expect</span>(<span class="string">"failed to listen for event"</span>);
|
||
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"received ctrl-c event"</span>);
|
||
}</pre></div>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |