github-actions[bot]
26 lines
5.1 KiB
HTML
26 lines
5.1 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 `signal` fn in crate `tokio`."><meta name="keywords" content="rust, rustlang, rust-lang, signal"><title>tokio::signal::unix::signal - 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>::<wbr><a href="index.html">unix</a></p><div id="sidebar-vars" data-name="signal" 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 href="index.html">unix</a>::<wbr><a class="fn" href="">signal</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/unix.rs.html#354-360" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub fn signal(kind: <a class="struct" href="../../../tokio/signal/unix/struct.SignalKind.html" title="struct tokio::signal::unix::SignalKind">SignalKind</a>) -> <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="struct" href="../../../tokio/signal/unix/struct.Signal.html" title="struct tokio::signal::unix::Signal">Signal</a>></pre><div class="docblock"><p>Creates a new stream which will receive notifications when the current
|
||
process receives the specified signal <code>kind</code>.</p>
|
||
<p>This function will create a new stream which binds to the default reactor.
|
||
The <code>Signal</code> stream is an infinite stream which will receive
|
||
notifications whenever a signal is received. More documentation can be
|
||
found on <code>Signal</code> itself, but to reiterate:</p>
|
||
<ul>
|
||
<li>Signals may be coalesced beyond what the kernel already does.</li>
|
||
<li>Once a signal handler is registered with the process the underlying
|
||
libc signal handler is never unregistered.</li>
|
||
</ul>
|
||
<p>A <code>Signal</code> stream can be created for a particular signal number
|
||
multiple times. When a signal is received then all the associated
|
||
channels will receive the signal notification.</p>
|
||
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
|
||
<ul>
|
||
<li>If the lower-level C functions fail for some reason.</li>
|
||
<li>If the previous initialization of this specific signal failed.</li>
|
||
<li>If the signal is one of
|
||
<a href="../../../signal_hook_registry/fn.register.html#panics"><code>signal_hook::FORBIDDEN</code></a></li>
|
||
</ul>
|
||
</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> |