blob: d773b4583ae1821d20ae2c1ecb8592fa2e74bfbb [file] [log] [blame]
<!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` mod in crate `nix`.">
<meta name="keywords" content="rust, rustlang, rust-lang, signal">
<title>nix::sys::signal - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'>Module signal</p><div class="block items"><ul><li><a href="#reexports">Reexports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a></p><script>window.sidebarCurrent = {name: 'signal', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a class="mod" 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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../../src/nix/sys/signal.rs.html#4-654' title='goto source code'>[src]</a></span></h1>
<h2 id='reexports' class='section-header'><a href="#reexports">Reexports</a></h2>
<table><tr><td><code>pub use self::<a class="enum" href="../../../nix/sys/signal/enum.Signal.html" title="enum nix::sys::signal::Signal">Signal</a>::*;</code></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.SaFlags.html"
title='struct nix::sys::signal::SaFlags'>SaFlags</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SigAction.html"
title='struct nix::sys::signal::SigAction'>SigAction</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SigEvent.html"
title='struct nix::sys::signal::SigEvent'>SigEvent</a></td>
<td class='docblock-short'>
<p>Used to request asynchronous notification of the completion of certain
events, such as POSIX AIO and timers.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SigSet.html"
title='struct nix::sys::signal::SigSet'>SigSet</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SignalIterator.html"
title='struct nix::sys::signal::SignalIterator'>SignalIterator</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.SigHandler.html"
title='enum nix::sys::signal::SigHandler'>SigHandler</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.SigevNotify.html"
title='enum nix::sys::signal::SigevNotify'>SigevNotify</a></td>
<td class='docblock-short'>
<p>Used to request asynchronous notification of certain events, for example,
with POSIX AIO, POSIX message queues, and POSIX timers.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.SigmaskHow.html"
title='enum nix::sys::signal::SigmaskHow'>SigmaskHow</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.Signal.html"
title='enum nix::sys::signal::Signal'>Signal</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table>
<tr class=' module-item'>
<td><a class="constant" href="constant.NSIG.html"
title='constant nix::sys::signal::NSIG'>NSIG</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.SA_NOCLDSTOP.html"
title='constant nix::sys::signal::SA_NOCLDSTOP'>SA_NOCLDSTOP</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.SA_NOCLDWAIT.html"
title='constant nix::sys::signal::SA_NOCLDWAIT'>SA_NOCLDWAIT</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.SA_NODEFER.html"
title='constant nix::sys::signal::SA_NODEFER'>SA_NODEFER</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.SA_ONSTACK.html"
title='constant nix::sys::signal::SA_ONSTACK'>SA_ONSTACK</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.SA_RESETHAND.html"
title='constant nix::sys::signal::SA_RESETHAND'>SA_RESETHAND</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.SA_RESTART.html"
title='constant nix::sys::signal::SA_RESTART'>SA_RESTART</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.SA_SIGINFO.html"
title='constant nix::sys::signal::SA_SIGINFO'>SA_SIGINFO</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.SIGIOT.html"
title='constant nix::sys::signal::SIGIOT'>SIGIOT</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.SIGPOLL.html"
title='constant nix::sys::signal::SIGPOLL'>SIGPOLL</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.SIGUNUSED.html"
title='constant nix::sys::signal::SIGUNUSED'>SIGUNUSED</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.kill.html"
title='fn nix::sys::signal::kill'>kill</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.pthread_sigmask.html"
title='fn nix::sys::signal::pthread_sigmask'>pthread_sigmask</a></td>
<td class='docblock-short'>
<p>Manages the signal mask (set of blocked signals) for the calling thread.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.raise.html"
title='fn nix::sys::signal::raise'>raise</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.sigaction.html"
title='fn nix::sys::signal::sigaction'>sigaction</a><a title='unsafe function' href='#'><sup></sup></a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="type" href="type.type_of_thread_id.html"
title='type nix::sys::signal::type_of_thread_id'>type_of_thread_id</a></td>
<td class='docblock-short'>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "nix";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>