448 lines
58 KiB
HTML
448 lines
58 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 `UnixReady` struct in crate `mio`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, UnixReady">
|
|||
|
|
|
|||
|
|
<title>mio::unix::UnixReady - 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="../../main.css" id="themeStyle">
|
|||
|
|
<script src="../../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc struct">
|
|||
|
|
<!--[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>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct UnixReady</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.aio">aio</a><a href="#method.error">error</a><a href="#method.hup">hup</a><a href="#method.is_aio">is_aio</a><a href="#method.is_error">is_error</a><a href="#method.is_hup">is_hup</a></div><a class="sidebar-title" href="#deref-methods">Methods from Deref<Target=Ready></a><div class="sidebar-links"><a href="#method.is_empty">is_empty</a><a href="#method.is_readable">is_readable</a><a href="#method.is_writable">is_writable</a><a href="#method.contains">contains</a><a href="#method.as_usize">as_usize</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Copy">Copy</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Eq">Eq</a><a href="#impl-Clone">Clone</a><a href="#impl-PartialOrd">PartialOrd</a><a href="#impl-Ord">Ord</a><a href="#impl-From%3CReady%3E">From<Ready></a><a href="#impl-From%3CUnixReady%3E">From<UnixReady></a><a href="#impl-Deref">Deref</a><a href="#impl-DerefMut">DerefMut</a><a href="#impl-BitOr">BitOr</a><a href="#impl-BitXor">BitXor</a><a href="#impl-BitAnd">BitAnd</a><a href="#impl-Sub">Sub</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='../index.html'>mio</a>::<wbr><a href='index.html'>unix</a></p><script>window.sidebarCurrent = {name: 'UnixReady', ty: 'struct', 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">
|
|||
|
|
<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'>Struct <a href='../index.html'>mio</a>::<wbr><a href='index.html'>unix</a>::<wbr><a class="struct" href=''>UnixReady</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/mio/sys/unix/ready.rs.html#93' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct UnixReady(_);</pre><div class='docblock'><p>Unix specific extensions to <code>Ready</code></p>
|
|||
|
|
<p>Provides additional readiness event kinds that are available on unix
|
|||
|
|
platforms. Unix platforms are able to provide readiness events for
|
|||
|
|
additional socket events, such as HUP and error.</p>
|
|||
|
|
<p>HUP events occur when the remote end of a socket hangs up. In the TCP case,
|
|||
|
|
this occurs when the remote end of a TCP socket shuts down writes.</p>
|
|||
|
|
<p>Error events occur when the socket enters an error state. In this case, the
|
|||
|
|
socket will also receive a readable or writable event. Reading or writing to
|
|||
|
|
the socket will result in an error.</p>
|
|||
|
|
<p>Conversion traits are implemented between <code>Ready</code> and <code>UnixReady</code>. See the
|
|||
|
|
examples.</p>
|
|||
|
|
<p>For high level documentation on polling and readiness, see <a href="../struct.Poll.html"><code>Poll</code></a>.</p>
|
|||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|||
|
|
<p>Most of the time, all that is needed is using bit operations</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">UnixReady</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">readable</span>() <span class="op">|</span> <span class="ident">UnixReady</span>::<span class="ident">hup</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_readable</span>());
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">UnixReady</span>::<span class="ident">from</span>(<span class="ident">ready</span>).<span class="ident">is_hup</span>());</pre>
|
|||
|
|
<p>Basic conversion between ready types.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">UnixReady</span>;
|
|||
|
|
|
|||
|
|
<span class="comment">// Start with a portable ready</span>
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">readable</span>();
|
|||
|
|
|
|||
|
|
<span class="comment">// Convert to a unix ready, adding HUP</span>
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">unix_ready</span> <span class="op">=</span> <span class="ident">UnixReady</span>::<span class="ident">from</span>(<span class="ident">ready</span>) <span class="op">|</span> <span class="ident">UnixReady</span>::<span class="ident">hup</span>();
|
|||
|
|
|
|||
|
|
<span class="ident">unix_ready</span>.<span class="ident">insert</span>(<span class="ident">UnixReady</span>::<span class="ident">error</span>());
|
|||
|
|
|
|||
|
|
<span class="comment">// `unix_ready` maintains readable interest</span>
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">unix_ready</span>.<span class="ident">is_readable</span>());
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">unix_ready</span>.<span class="ident">is_hup</span>());
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">unix_ready</span>.<span class="ident">is_error</span>());
|
|||
|
|
|
|||
|
|
<span class="comment">// Convert back to `Ready`</span>
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">from</span>(<span class="ident">unix_ready</span>);
|
|||
|
|
|
|||
|
|
<span class="comment">// Readable is maintained</span>
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_readable</span>());</pre>
|
|||
|
|
<p>Registering readable and error interest on a socket</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::{<span class="ident">Ready</span>, <span class="ident">Poll</span>, <span class="ident">PollOpt</span>, <span class="ident">Token</span>};
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">net</span>::<span class="ident">TcpStream</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">UnixReady</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="string">"216.58.193.68:80"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>;
|
|||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">TcpStream</span>::<span class="ident">connect</span>(<span class="kw-2">&</span><span class="ident">addr</span>)<span class="question-mark">?</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">poll</span> <span class="op">=</span> <span class="ident">Poll</span>::<span class="ident">new</span>()<span class="question-mark">?</span>;
|
|||
|
|
|
|||
|
|
<span class="ident">poll</span>.<span class="ident">register</span>(<span class="kw-2">&</span><span class="ident">socket</span>,
|
|||
|
|
<span class="ident">Token</span>(<span class="number">0</span>),
|
|||
|
|
<span class="ident">Ready</span>::<span class="ident">readable</span>() <span class="op">|</span> <span class="ident">UnixReady</span>::<span class="ident">error</span>(),
|
|||
|
|
<span class="ident">PollOpt</span>::<span class="ident">edge</span>())<span class="question-mark">?</span>;</pre>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#115-326' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.aio' class="method"><span id='aio.v' class='invisible'><code>pub fn <a href='#method.aio' class='fnname'>aio</a>() -> <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#134-136' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a <code>Ready</code> representing AIO completion readiness</p>
|
|||
|
|
<p>See <a href="../struct.Poll.html"><code>Poll</code></a> for more documentation on polling.</p>
|
|||
|
|
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">UnixReady</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">UnixReady</span>::<span class="ident">aio</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_aio</span>());</pre>
|
|||
|
|
</div><h4 id='method.error' class="method"><span id='error.v' class='invisible'><code>pub fn <a href='#method.error' class='fnname'>error</a>() -> <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#168-170' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a <code>Ready</code> representing error readiness.</p>
|
|||
|
|
<p><strong>Note that only readable and writable readiness is guaranteed to be
|
|||
|
|
supported on all platforms</strong>. This means that <code>error</code> readiness
|
|||
|
|
should be treated as a hint. For more details, see <a href="../struct.Poll.html#readiness-operations">readiness</a> in the
|
|||
|
|
poll documentation.</p>
|
|||
|
|
<p>See <a href="../struct.Poll.html"><code>Poll</code></a> for more documentation on polling.</p>
|
|||
|
|
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">UnixReady</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">UnixReady</span>::<span class="ident">error</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_error</span>());</pre>
|
|||
|
|
</div><h4 id='method.hup' class="method"><span id='hup.v' class='invisible'><code>pub fn <a href='#method.hup' class='fnname'>hup</a>() -> <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#197-199' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a <code>Ready</code> representing HUP readiness.</p>
|
|||
|
|
<p>A HUP (or hang-up) signifies that a stream socket <strong>peer</strong> closed the
|
|||
|
|
connection, or shut down the writing half of the connection.</p>
|
|||
|
|
<p><strong>Note that only readable and writable readiness is guaranteed to be
|
|||
|
|
supported on all platforms</strong>. This means that <code>hup</code> readiness
|
|||
|
|
should be treated as a hint. For more details, see <a href="../struct.Poll.html#readiness-operations">readiness</a> in the
|
|||
|
|
poll documentation.</p>
|
|||
|
|
<p>See <a href="../struct.Poll.html"><code>Poll</code></a> for more documentation on polling.</p>
|
|||
|
|
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">UnixReady</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">UnixReady</span>::<span class="ident">hup</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_hup</span>());</pre>
|
|||
|
|
</div><h4 id='method.is_aio' class="method"><span id='is_aio.v' class='invisible'><code>pub fn <a href='#method.is_aio' class='fnname'>is_aio</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#240-242' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns true if <code>Ready</code> contains AIO readiness</p>
|
|||
|
|
<p>See <a href="../struct.Poll.html"><code>Poll</code></a> for more documentation on polling.</p>
|
|||
|
|
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">UnixReady</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">UnixReady</span>::<span class="ident">aio</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_aio</span>());</pre>
|
|||
|
|
</div><h4 id='method.is_error' class="method"><span id='is_error.v' class='invisible'><code>pub fn <a href='#method.is_error' class='fnname'>is_error</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#275-277' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns true if the value includes error readiness</p>
|
|||
|
|
<p><strong>Note that only readable and writable readiness is guaranteed to be
|
|||
|
|
supported on all platforms</strong>. This means that <code>error</code> readiness should
|
|||
|
|
be treated as a hint. For more details, see <a href="../struct.Poll.html#readiness-operations">readiness</a> in the poll
|
|||
|
|
documentation.</p>
|
|||
|
|
<p>See <a href="../struct.Poll.html"><code>Poll</code></a> for more documentation on polling.</p>
|
|||
|
|
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">UnixReady</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">UnixReady</span>::<span class="ident">error</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_error</span>());</pre>
|
|||
|
|
</div><h4 id='method.is_hup' class="method"><span id='is_hup.v' class='invisible'><code>pub fn <a href='#method.is_hup' class='fnname'>is_hup</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#304-306' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns true if the value includes HUP readiness</p>
|
|||
|
|
<p>A HUP (or hang-up) signifies that a stream socket <strong>peer</strong> closed the
|
|||
|
|
connection, or shut down the writing half of the connection.</p>
|
|||
|
|
<p><strong>Note that only readable and writable readiness is guaranteed to be
|
|||
|
|
supported on all platforms</strong>. This means that <code>hup</code> readiness
|
|||
|
|
should be treated as a hint. For more details, see <a href="../struct.Poll.html#readiness-operations">readiness</a> in the
|
|||
|
|
poll documentation.</p>
|
|||
|
|
<p>See <a href="../struct.Poll.html"><code>Poll</code></a> for more documentation on polling.</p>
|
|||
|
|
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">unix</span>::<span class="ident">UnixReady</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">UnixReady</span>::<span class="ident">hup</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_hup</span>());</pre>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='deref-methods' class='small-section-header'>
|
|||
|
|
Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>><a href='#deref-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='impl-items'><h4 id='method.is_empty' class="method"><span id='is_empty.v' class='invisible'><code>pub fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#722-724' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns true if <code>Ready</code> is the empty set</p>
|
|||
|
|
<p>See [<code>Poll</code>] for more documentation on polling.</p>
|
|||
|
|
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">empty</span>();
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_empty</span>());</pre>
|
|||
|
|
</div><h4 id='method.is_readable' class="method"><span id='is_readable.v' class='invisible'><code>pub fn <a href='#method.is_readable' class='fnname'>is_readable</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#750-752' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns true if the value includes readable readiness</p>
|
|||
|
|
<p>See <a href="struct.Poll.html"><code>Poll</code></a> for more documentation on polling.</p>
|
|||
|
|
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">readable</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_readable</span>());</pre>
|
|||
|
|
</div><h4 id='method.is_writable' class="method"><span id='is_writable.v' class='invisible'><code>pub fn <a href='#method.is_writable' class='fnname'>is_writable</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#770-772' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns true if the value includes writable readiness</p>
|
|||
|
|
<p>See <a href="struct.Poll.html"><code>Poll</code></a> for more documentation on polling.</p>
|
|||
|
|
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">writable</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ready</span>.<span class="ident">is_writable</span>());</pre>
|
|||
|
|
</div><h4 id='method.insert' class="method"><span id='insert.v' class='invisible'><code>pub fn <a href='#method.insert' class='fnname'>insert</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Self>>(&mut self, other: T)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#805-808' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Adds all readiness represented by <code>other</code> into <code>self</code>.</p>
|
|||
|
|
<p>This is equivalent to <code>*self = *self | other</code>.</p>
|
|||
|
|
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">readiness</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">empty</span>();
|
|||
|
|
<span class="ident">readiness</span>.<span class="ident">insert</span>(<span class="ident">Ready</span>::<span class="ident">readable</span>());
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">readiness</span>.<span class="ident">is_readable</span>());</pre>
|
|||
|
|
</div><h4 id='method.remove' class="method"><span id='remove.v' class='invisible'><code>pub fn <a href='#method.remove' class='fnname'>remove</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Self>>(&mut self, other: T)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#825-828' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Removes all options represented by <code>other</code> from <code>self</code>.</p>
|
|||
|
|
<p>This is equivalent to <code>*self = *self & !other</code>.</p>
|
|||
|
|
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">readiness</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">readable</span>();
|
|||
|
|
<span class="ident">readiness</span>.<span class="ident">remove</span>(<span class="ident">Ready</span>::<span class="ident">readable</span>());
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">readiness</span>.<span class="ident">is_readable</span>());</pre>
|
|||
|
|
</div><h4 id='method.contains' class="method"><span id='contains.v' class='invisible'><code>pub fn <a href='#method.contains' class='fnname'>contains</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Self>>(&self, other: T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#877-880' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns true if <code>self</code> is a superset of <code>other</code>.</p>
|
|||
|
|
<p><code>other</code> may represent more than one readiness operations, in which case
|
|||
|
|
the function only returns true if <code>self</code> contains all readiness
|
|||
|
|
specified in <code>other</code>.</p>
|
|||
|
|
<p>See <a href="struct.Poll.html"><code>Poll</code></a> for more documentation on polling.</p>
|
|||
|
|
<h1 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">readiness</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">readable</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">readiness</span>.<span class="ident">contains</span>(<span class="ident">Ready</span>::<span class="ident">readable</span>()));
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">readiness</span>.<span class="ident">contains</span>(<span class="ident">Ready</span>::<span class="ident">writable</span>()));</pre>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">readiness</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">readable</span>() <span class="op">|</span> <span class="ident">Ready</span>::<span class="ident">writable</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">readiness</span>.<span class="ident">contains</span>(<span class="ident">Ready</span>::<span class="ident">readable</span>()));
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">readiness</span>.<span class="ident">contains</span>(<span class="ident">Ready</span>::<span class="ident">writable</span>()));</pre>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">readiness</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">readable</span>() <span class="op">|</span> <span class="ident">Ready</span>::<span class="ident">writable</span>();
|
|||
|
|
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">Ready</span>::<span class="ident">readable</span>().<span class="ident">contains</span>(<span class="ident">readiness</span>));
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">readiness</span>.<span class="ident">contains</span>(<span class="ident">readiness</span>));</pre>
|
|||
|
|
</div><h4 id='method.as_usize' class="method"><span id='as_usize.v' class='invisible'><code>pub fn <a href='#method.as_usize' class='fnname'>as_usize</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#931-933' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a <code>usize</code> representation of the <code>Ready</code> value.</p>
|
|||
|
|
<p>This <code>usize</code> representation must be treated as opaque. There is no
|
|||
|
|
guaranteed correlation between the returned value and platform defined
|
|||
|
|
constants. Also, there is no guarantee that the <code>usize</code> representation
|
|||
|
|
will remain constant across patch releases of Mio.</p>
|
|||
|
|
<p>This function is mainly provided to allow the caller to store a
|
|||
|
|
readiness value in an <code>AtomicUsize</code>.</p>
|
|||
|
|
<h1 id="examples-13" class="section-header"><a href="#examples-13">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">Ready</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">readable</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready_usize</span> <span class="op">=</span> <span class="ident">ready</span>.<span class="ident">as_usize</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">ready2</span> <span class="op">=</span> <span class="ident">Ready</span>::<span class="ident">from_usize</span>(<span class="ident">ready_usize</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ready</span>, <span class="ident">ready2</span>);</pre>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Copy' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-Copy' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-PartialEq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, __arg_0: &<a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
|||
|
|
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, __arg_0: &<a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
|||
|
|
</div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-Eq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-PartialOrd' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-PartialOrd' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.partial_cmp' class="method"><span id='partial_cmp.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp' class='fnname'>partial_cmp</a>(&self, __arg_0: &<a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</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="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></p>
|
|||
|
|
</div><h4 id='method.lt' class="method"><span id='lt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt' class='fnname'>lt</a>(&self, __arg_0: &<a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></p>
|
|||
|
|
</div><h4 id='method.le' class="method"><span id='le.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le' class='fnname'>le</a>(&self, __arg_0: &<a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></p>
|
|||
|
|
</div><h4 id='method.gt' class="method"><span id='gt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt' class='fnname'>gt</a>(&self, __arg_0: &<a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></p>
|
|||
|
|
</div><h4 id='method.ge' class="method"><span id='ge.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge' class='fnname'>ge</a>(&self, __arg_0: &<a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Ord' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-Ord' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.cmp' class="method"><span id='cmp.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#tymethod.cmp' class='fnname'>cmp</a>(&self, __arg_0: &<a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#92' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method returns an <code>Ordering</code> between <code>self</code> and <code>other</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#tymethod.cmp">Read more</a></p>
|
|||
|
|
</div><h4 id='method.max' class="method"><span id='max.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.max' class='fnname'>max</a>(self, other: Self) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.21.0'>1.21.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#460-463' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Compares and returns the maximum of two values. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.max">Read more</a></p>
|
|||
|
|
</div><h4 id='method.min' class="method"><span id='min.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.min' class='fnname'>min</a>(self, other: Self) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.21.0'>1.21.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#476-479' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Compares and returns the minimum of two values. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.min">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-From%3CReady%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-From%3CReady%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#328-332' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(src: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>) -> <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#329-331' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-From%3CUnixReady%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>> for <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a></code><a href='#impl-From%3CUnixReady%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#334-338' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(src: <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#335-337' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-Deref' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-Deref' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#340-346' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>The resulting type after dereferencing.</p>
|
|||
|
|
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> &<a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#343-345' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Dereferences the value.</p>
|
|||
|
|
</div></div><h3 id='impl-DerefMut' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-DerefMut' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#348-352' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.deref_mut' class="method"><span id='deref_mut.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&mut self) -> &mut <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#349-351' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Mutably dereferences the value.</p>
|
|||
|
|
</div></div><h3 id='impl-BitOr' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitOr.html" title="trait core::ops::bit::BitOr">BitOr</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-BitOr' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#354-361' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='associatedtype.Output' class="type"><span id='Output.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitOr.html#associatedtype.Output' class="type">Output</a> = <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>The resulting type after applying the <code>|</code> operator.</p>
|
|||
|
|
</div><h4 id='method.bitor' class="method"><span id='bitor.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitOr.html#tymethod.bitor' class='fnname'>bitor</a>(self, other: <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#358-360' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the <code>|</code> operation.</p>
|
|||
|
|
</div></div><h3 id='impl-BitXor' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitXor.html" title="trait core::ops::bit::BitXor">BitXor</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-BitXor' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#363-370' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='associatedtype.Output-1' class="type"><span id='Output.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitXor.html#associatedtype.Output' class="type">Output</a> = <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>The resulting type after applying the <code>^</code> operator.</p>
|
|||
|
|
</div><h4 id='method.bitxor' class="method"><span id='bitxor.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitXor.html#tymethod.bitxor' class='fnname'>bitxor</a>(self, other: <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#367-369' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the <code>^</code> operation.</p>
|
|||
|
|
</div></div><h3 id='impl-BitAnd' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitAnd.html" title="trait core::ops::bit::BitAnd">BitAnd</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-BitAnd' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#372-379' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='associatedtype.Output-2' class="type"><span id='Output.t-2' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitAnd.html#associatedtype.Output' class="type">Output</a> = <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>The resulting type after applying the <code>&</code> operator.</p>
|
|||
|
|
</div><h4 id='method.bitand' class="method"><span id='bitand.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/bit/trait.BitAnd.html#tymethod.bitand' class='fnname'>bitand</a>(self, other: <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#376-378' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the <code>&</code> operation.</p>
|
|||
|
|
</div></div><h3 id='impl-Sub' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-Sub' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#381-388' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='associatedtype.Output-3' class="type"><span id='Output.t-3' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/arith/trait.Sub.html#associatedtype.Output' class="type">Output</a> = <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>The resulting type after applying the <code>-</code> operator.</p>
|
|||
|
|
</div><h4 id='method.sub' class="method"><span id='sub.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/arith/trait.Sub.html#tymethod.sub' class='fnname'>sub</a>(self, other: <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a>) -> <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#385-387' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the <code>-</code> operation.</p>
|
|||
|
|
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../mio/unix/struct.UnixReady.html" title="struct mio::unix::UnixReady">UnixReady</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#402-428' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/sys/unix/ready.rs.html#403-427' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../";
|
|||
|
|
window.currentCrate = "mio";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|