blob: 58a8943bb2257a31afe7056496da300f5c769fc9 [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 `pthread_sigmask` fn in crate `nix`.">
<meta name="keywords" content="rust, rustlang, rust-lang, pthread_sigmask">
<title>nix::sys::signal::pthread_sigmask - 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 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">
<p class='location'><a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a href='index.html'>signal</a></p><script>window.sidebarCurrent = {name: 'pthread_sigmask', ty: 'fn', 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'>Function <a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a href='index.html'>signal</a>::<wbr><a class="fn" href=''>pthread_sigmask</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#375-392' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn pthread_sigmask(<br>&nbsp;&nbsp;&nbsp;&nbsp;how: <a class="enum" href="../../../nix/sys/signal/enum.SigmaskHow.html" title="enum nix::sys::signal::SigmaskHow">SigmaskHow</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;set: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../../../nix/sys/signal/struct.SigSet.html" title="struct nix::sys::signal::SigSet">SigSet</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;oldset: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;mut <a class="struct" href="../../../nix/sys/signal/struct.SigSet.html" title="struct nix::sys::signal::SigSet">SigSet</a>&gt;<br>) -&gt; <a class="type" href="../../../nix/type.Result.html" title="type nix::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>&gt;</pre><div class='docblock'><p>Manages the signal mask (set of blocked signals) for the calling thread.</p>
<p>If the <code>set</code> parameter is <code>Some(..)</code>, then the signal mask will be updated with the signal set.
The <code>how</code> flag decides the type of update. If <code>set</code> is <code>None</code>, <code>how</code> will be ignored,
and no modification will take place.</p>
<p>If the &#39;oldset&#39; parameter is <code>Some(..)</code> then the current signal mask will be written into it.</p>
<p>If both <code>set</code> and <code>oldset</code> is <code>Some(..)</code>, the current signal mask will be written into oldset,
and then it will be updated with <code>set</code>.</p>
<p>If both <code>set</code> and <code>oldset</code> is None, this function is a no-op.</p>
<p>For more information, visit the <a href="http://man7.org/linux/man-pages/man3/pthread_sigmask.3.html">pthread_sigmask</a>,
or <a href="http://man7.org/linux/man-pages/man2/sigprocmask.2.html">sigprocmask</a> man pages.</p>
</div></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>