288 lines
34 KiB
HTML
288 lines
34 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 `Evented` trait in crate `mio`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Evented">
|
|||
|
|
|
|||
|
|
<title>mio::event::Evented - 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 trait">
|
|||
|
|
<!--[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'>Trait Evented</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.register">register</a><a href="#tymethod.reregister">reregister</a><a href="#tymethod.deregister">deregister</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Evented">Box<Evented></a><a href="#impl-Evented">Box<T></a><a href="#impl-Evented">Arc<T></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>mio</a>::<wbr><a href='index.html'>event</a></p><script>window.sidebarCurrent = {name: 'Evented', ty: 'trait', 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'>Trait <a href='../index.html'>mio</a>::<wbr><a href='index.html'>event</a>::<wbr><a class="trait" href=''>Evented</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/event_imp.rs.html#123-155' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait Evented {
|
|||
|
|
fn <a href='#tymethod.register' class='fnname'>register</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</a><br> ) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.reregister' class='fnname'>reregister</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</a><br> ) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.deregister' class='fnname'>deregister</a>(&self, poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>;
|
|||
|
|
}</pre><div class='docblock'><p>A value that may be registered with <code>Poll</code></p>
|
|||
|
|
<p>Values that implement <code>Evented</code> can be registered with <code>Poll</code>. Users of Mio
|
|||
|
|
should not use the <code>Evented</code> trait functions directly. Instead, the
|
|||
|
|
equivalent functions on <code>Poll</code> should be used.</p>
|
|||
|
|
<p>See <a href="../struct.Poll.html"><code>Poll</code></a> for more details.</p>
|
|||
|
|
<h1 id="implementing-evented" class="section-header"><a href="#implementing-evented">Implementing <code>Evented</code></a></h1>
|
|||
|
|
<p>There are two types of <code>Evented</code> values.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p><strong>System</strong> handles, which are backed by sockets or other system handles.
|
|||
|
|
These <code>Evented</code> handles will be monitored by the system selector. In this
|
|||
|
|
case, an implementation of <code>Evented</code> delegates to a lower level handle.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><strong>User</strong> handles, which are driven entirely in user space using
|
|||
|
|
<a href="../struct.Registration.html"><code>Registration</code></a> and <a href="../struct.SetReadiness.html"><code>SetReadiness</code></a>. In this case, the implementer takes
|
|||
|
|
responsibility for driving the readiness state changes.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|||
|
|
<p>Implementing <code>Evented</code> on a struct containing 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">event</span>::<span class="ident">Evented</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">std</span>::<span class="ident">io</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">MyEvented</span> {
|
|||
|
|
<span class="ident">socket</span>: <span class="ident">TcpStream</span>,
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">impl</span> <span class="ident">Evented</span> <span class="kw">for</span> <span class="ident">MyEvented</span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">register</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">poll</span>: <span class="kw-2">&</span><span class="ident">Poll</span>, <span class="ident">token</span>: <span class="ident">Token</span>, <span class="ident">interest</span>: <span class="ident">Ready</span>, <span class="ident">opts</span>: <span class="ident">PollOpt</span>)
|
|||
|
|
<span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span>
|
|||
|
|
{
|
|||
|
|
<span class="comment">// Delegate the `register` call to `socket`</span>
|
|||
|
|
<span class="self">self</span>.<span class="ident">socket</span>.<span class="ident">register</span>(<span class="ident">poll</span>, <span class="ident">token</span>, <span class="ident">interest</span>, <span class="ident">opts</span>)
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">reregister</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">poll</span>: <span class="kw-2">&</span><span class="ident">Poll</span>, <span class="ident">token</span>: <span class="ident">Token</span>, <span class="ident">interest</span>: <span class="ident">Ready</span>, <span class="ident">opts</span>: <span class="ident">PollOpt</span>)
|
|||
|
|
<span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span>
|
|||
|
|
{
|
|||
|
|
<span class="comment">// Delegate the `reregister` call to `socket`</span>
|
|||
|
|
<span class="self">self</span>.<span class="ident">socket</span>.<span class="ident">reregister</span>(<span class="ident">poll</span>, <span class="ident">token</span>, <span class="ident">interest</span>, <span class="ident">opts</span>)
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">deregister</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">poll</span>: <span class="kw-2">&</span><span class="ident">Poll</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
|||
|
|
<span class="comment">// Delegate the `deregister` call to `socket`</span>
|
|||
|
|
<span class="self">self</span>.<span class="ident">socket</span>.<span class="ident">deregister</span>(<span class="ident">poll</span>)
|
|||
|
|
}
|
|||
|
|
}</pre>
|
|||
|
|
<p>Implement <code>Evented</code> using <a href="../struct.Registration.html"><code>Registration</code></a> and <a href="../struct.SetReadiness.html"><code>SetReadiness</code></a>.</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">Registration</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">event</span>::<span class="ident">Evented</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="ident">Instant</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Deadline</span> {
|
|||
|
|
<span class="ident">when</span>: <span class="ident">Instant</span>,
|
|||
|
|
<span class="ident">registration</span>: <span class="ident">Registration</span>,
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">impl</span> <span class="ident">Deadline</span> {
|
|||
|
|
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">when</span>: <span class="ident">Instant</span>) <span class="op">-></span> <span class="ident">Deadline</span> {
|
|||
|
|
<span class="kw">let</span> (<span class="ident">registration</span>, <span class="ident">set_readiness</span>) <span class="op">=</span> <span class="ident">Registration</span>::<span class="ident">new2</span>();
|
|||
|
|
|
|||
|
|
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> {
|
|||
|
|
<span class="kw">let</span> <span class="ident">now</span> <span class="op">=</span> <span class="ident">Instant</span>::<span class="ident">now</span>();
|
|||
|
|
|
|||
|
|
<span class="kw">if</span> <span class="ident">now</span> <span class="op"><</span> <span class="ident">when</span> {
|
|||
|
|
<span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">when</span> <span class="op">-</span> <span class="ident">now</span>);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="ident">set_readiness</span>.<span class="ident">set_readiness</span>(<span class="ident">Ready</span>::<span class="ident">readable</span>());
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
<span class="ident">Deadline</span> {
|
|||
|
|
<span class="ident">when</span>: <span class="ident">when</span>,
|
|||
|
|
<span class="ident">registration</span>: <span class="ident">registration</span>,
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_elapsed</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">bool</span> {
|
|||
|
|
<span class="ident">Instant</span>::<span class="ident">now</span>() <span class="op">>=</span> <span class="self">self</span>.<span class="ident">when</span>
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">impl</span> <span class="ident">Evented</span> <span class="kw">for</span> <span class="ident">Deadline</span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">register</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">poll</span>: <span class="kw-2">&</span><span class="ident">Poll</span>, <span class="ident">token</span>: <span class="ident">Token</span>, <span class="ident">interest</span>: <span class="ident">Ready</span>, <span class="ident">opts</span>: <span class="ident">PollOpt</span>)
|
|||
|
|
<span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span>
|
|||
|
|
{
|
|||
|
|
<span class="self">self</span>.<span class="ident">registration</span>.<span class="ident">register</span>(<span class="ident">poll</span>, <span class="ident">token</span>, <span class="ident">interest</span>, <span class="ident">opts</span>)
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">reregister</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">poll</span>: <span class="kw-2">&</span><span class="ident">Poll</span>, <span class="ident">token</span>: <span class="ident">Token</span>, <span class="ident">interest</span>: <span class="ident">Ready</span>, <span class="ident">opts</span>: <span class="ident">PollOpt</span>)
|
|||
|
|
<span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span>
|
|||
|
|
{
|
|||
|
|
<span class="self">self</span>.<span class="ident">registration</span>.<span class="ident">reregister</span>(<span class="ident">poll</span>, <span class="ident">token</span>, <span class="ident">interest</span>, <span class="ident">opts</span>)
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">deregister</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">poll</span>: <span class="kw-2">&</span><span class="ident">Poll</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
|||
|
|
<span class="self">self</span>.<span class="ident">registration</span>.<span class="ident">deregister</span>(<span class="ident">poll</span>)
|
|||
|
|
}
|
|||
|
|
}</pre>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.register' class='method'><span id='register.v' class='invisible'><code>fn <a href='#tymethod.register' class='fnname'>register</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</a><br>) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></h3><div class='docblock'><p>Register <code>self</code> with the given <code>Poll</code> instance.</p>
|
|||
|
|
<p>This function should not be called directly. Use <a href="../struct.Poll.html#method.register"><code>Poll::register</code></a>
|
|||
|
|
instead. Implementors should handle registration by either delegating
|
|||
|
|
the call to another <code>Evented</code> type or creating a <a href="../struct.Registration.html"><code>Registration</code></a>.</p>
|
|||
|
|
</div><h3 id='tymethod.reregister' class='method'><span id='reregister.v' class='invisible'><code>fn <a href='#tymethod.reregister' class='fnname'>reregister</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</a><br>) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></h3><div class='docblock'><p>Re-register <code>self</code> with the given <code>Poll</code> instance.</p>
|
|||
|
|
<p>This function should not be called directly. Use <a href="../struct.Poll.html#method.reregister"><code>Poll::reregister</code></a>
|
|||
|
|
instead. Implementors should handle re-registration by either delegating
|
|||
|
|
the call to another <code>Evented</code> type or calling
|
|||
|
|
<a href="../struct.SetReadiness.html#method.set_readiness"><code>SetReadiness::set_readiness</code></a>.</p>
|
|||
|
|
</div><h3 id='tymethod.deregister' class='method'><span id='deregister.v' class='invisible'><code>fn <a href='#tymethod.deregister' class='fnname'>deregister</a>(&self, poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></h3><div class='docblock'><p>Deregister <code>self</code> from the given <code>Poll</code> instance</p>
|
|||
|
|
<p>This function should not be called directly. Use <a href="../struct.Poll.html#method.deregister"><code>Poll::deregister</code></a>
|
|||
|
|
instead. Implementors should handle deregistration by either delegating
|
|||
|
|
the call to another <code>Evented</code> type or by dropping the <a href="../struct.Registration.html"><code>Registration</code></a>
|
|||
|
|
associated with <code>self</code>.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='foreign-impls' class='small-section-header'>
|
|||
|
|
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Evented' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../mio/event/trait.Evented.html" title="trait mio::event::Evented">Evented</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="../../mio/event/trait.Evented.html" title="trait mio::event::Evented">Evented</a>></code><a href='#impl-Evented' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#157-169' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<span class='docblock autohide'><div class='impl-items'><h4 id='method.register' class="method"><span id='register.v-1' class='invisible'><code>fn <a href='#method.register' class='fnname'>register</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</a><br>) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#158-160' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.reregister' class="method"><span id='reregister.v-1' class='invisible'><code>fn <a href='#method.reregister' class='fnname'>reregister</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</a><br>) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#162-164' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.deregister' class="method"><span id='deregister.v-1' class='invisible'><code>fn <a href='#method.deregister' class='fnname'>deregister</a>(&self, poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#166-168' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
</div></span><h3 id='impl-Evented-1' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../../mio/event/trait.Evented.html" title="trait mio::event::Evented">Evented</a>> <a class="trait" href="../../mio/event/trait.Evented.html" title="trait mio::event::Evented">Evented</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T></code><a href='#impl-Evented-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#171-183' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<span class='docblock autohide'><div class='impl-items'><h4 id='method.register-1' class="method"><span id='register.v-2' class='invisible'><code>fn <a href='#method.register' class='fnname'>register</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</a><br>) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#172-174' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.reregister-1' class="method"><span id='reregister.v-2' class='invisible'><code>fn <a href='#method.reregister' class='fnname'>reregister</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</a><br>) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#176-178' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.deregister-1' class="method"><span id='deregister.v-2' class='invisible'><code>fn <a href='#method.deregister' class='fnname'>deregister</a>(&self, poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#180-182' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
</div></span><h3 id='impl-Evented-2' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../../mio/event/trait.Evented.html" title="trait mio::event::Evented">Evented</a>> <a class="trait" href="../../mio/event/trait.Evented.html" title="trait mio::event::Evented">Evented</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/arc/struct.Arc.html" title="struct alloc::arc::Arc">Arc</a><T></code><a href='#impl-Evented-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#185-197' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<span class='docblock autohide'><div class='impl-items'><h4 id='method.register-2' class="method"><span id='register.v-3' class='invisible'><code>fn <a href='#method.register' class='fnname'>register</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</a><br>) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#186-188' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.reregister-2' class="method"><span id='reregister.v-3' class='invisible'><code>fn <a href='#method.reregister' class='fnname'>reregister</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</a><br>) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#190-192' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.deregister-2' class="method"><span id='deregister.v-3' class='invisible'><code>fn <a href='#method.deregister' class='fnname'>deregister</a>(&self, poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mio/event_imp.rs.html#194-196' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
</div></span>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/mio/poll.rs.html#1665-1677' title='goto source code'>[src]</a></div><code>impl Evented for <a class="struct" href="../../mio/struct.Registration.html" title="struct mio::Registration">Registration</a></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/mio/sys/unix/eventedfd.rs.html#94-106' title='goto source code'>[src]</a></div><code>impl<'a> Evented for <a class="struct" href="../../mio/unix/struct.EventedFd.html" title="struct mio::unix::EventedFd">EventedFd</a><'a></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/mio/net/tcp.rs.html#439-454' title='goto source code'>[src]</a></div><code>impl Evented for <a class="struct" href="../../mio/net/struct.TcpStream.html" title="struct mio::net::TcpStream">TcpStream</a></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/mio/net/tcp.rs.html#657-672' title='goto source code'>[src]</a></div><code>impl Evented for <a class="struct" href="../../mio/net/struct.TcpListener.html" title="struct mio::net::TcpListener">TcpListener</a></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/mio/net/udp.rs.html#547-560' title='goto source code'>[src]</a></div><code>impl Evented for <a class="struct" href="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code></li>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../../implementors/mio/event/trait.Evented.js">
|
|||
|
|
</script></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>
|