|
|
<!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 `pselect` fn in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, pselect"><title>nix::sys::select::pselect - 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="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><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='../../../nix/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a href='index.html'>select</a></p><script>window.sidebarCurrent = {name: 'pselect', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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/nix/sys/select.rs.html#164-204' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a href='index.html'>select</a>::<wbr><a class="fn" href=''>pselect</a></span></h1><pre class='rust fn'>pub fn pselect<'a, N, R, W, E, T, S>(<br> nfds: N, <br> readfds: R, <br> writefds: W, <br> errorfds: E, <br> timeout: T, <br> sigmask: S<br>) -> <a class="type" href="../../../nix/type.Result.html" title="type nix::Result">Result</a><<a class="type" href="../../../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>> <span class="where fmt-newline">where<br> N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="../../../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>>>,<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="../../../nix/sys/select/struct.FdSet.html" title="struct nix::sys::select::FdSet">FdSet</a>>>,<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="../../../nix/sys/select/struct.FdSet.html" title="struct nix::sys::select::FdSet">FdSet</a>>>,<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="../../../nix/sys/select/struct.FdSet.html" title="struct nix::sys::select::FdSet">FdSet</a>>>,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="struct" href="../../../nix/sys/time/struct.TimeSpec.html" title="struct nix::sys::time::TimeSpec">TimeSpec</a>>>,<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="struct" href="../../../nix/sys/signal/struct.SigSet.html" title="struct nix::sys::signal::SigSet">SigSet</a>>>, </span></pre><div class='docblock'><p>Monitors file descriptors for readiness with an altered signal mask.</p>
|
|
|
<p>Returns the total number of ready file descriptors in all sets. The sets are changed so that all
|
|
|
file descriptors that are ready for the given operation are set.</p>
|
|
|
<p>When this function returns, the original signal mask is restored.</p>
|
|
|
<p>Unlike <a href="#fn.select"><code>select</code></a>, <code>pselect</code> does not mutate the <code>timeout</code> value.</p>
|
|
|
<h1 id="parameters" class="section-header"><a href="#parameters">Parameters</a></h1>
|
|
|
<ul>
|
|
|
<li><code>nfds</code>: The highest file descriptor set in any of the passed <code>FdSet</code>s, plus 1. If <code>None</code>, this
|
|
|
is calculated automatically by calling <a href="struct.FdSet.html#method.highest"><code>FdSet::highest</code></a> on all descriptor sets and adding 1
|
|
|
to the maximum of that.</li>
|
|
|
<li><code>readfds</code>: File descriptors to check for read readiness</li>
|
|
|
<li><code>writefds</code>: File descriptors to check for write readiness</li>
|
|
|
<li><code>errorfds</code>: File descriptors to check for pending error conditions.</li>
|
|
|
<li><code>timeout</code>: Maximum time to wait for descriptors to become ready (<code>None</code> to block
|
|
|
indefinitely).</li>
|
|
|
<li><code>sigmask</code>: Signal mask to activate while waiting for file descriptors to turn
|
|
|
ready (<code>None</code> to set no alternative signal mask).</li>
|
|
|
</ul>
|
|
|
<h1 id="references" class="section-header"><a href="#references">References</a></h1>
|
|
|
<p><a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/pselect.html">pselect(2)</a></p>
|
|
|
<p><a href="https://lwn.net/Articles/176911/">The new pselect() system call</a></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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "nix";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |
