mentat/mio/index.html
2018-08-22 17:04:13 +00:00

289 lines
No EOL
15 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `mio` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, mio">
<title>mio - 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 mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Crate mio</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'mio', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>mio</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/mio/lib.rs.html#1-298' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A fast, low-level IO library for Rust focusing on non-blocking APIs, event
notification, and other useful utilities for building high performance IO
apps.</p>
<h1 id="goals" class="section-header"><a href="#goals">Goals</a></h1>
<ul>
<li>Fast - minimal overhead over the equivalent OS facilities (epoll, kqueue, etc...)</li>
<li>Zero allocations</li>
<li>A scalable readiness-based API, similar to epoll on Linux</li>
<li>Design to allow for stack allocated buffers when possible (avoid double buffering).</li>
<li>Provide utilities such as a timers, a notification channel, buffer abstractions, and a slab.</li>
</ul>
<h1 id="platforms" class="section-header"><a href="#platforms">Platforms</a></h1>
<p>Currently supported platforms:</p>
<ul>
<li>Linux</li>
<li>OS X</li>
<li>Windows</li>
<li>FreeBSD</li>
<li>NetBSD</li>
<li>Android</li>
<li>iOS</li>
</ul>
<p>mio can handle interfacing with each of the event notification systems of the aforementioned platforms. The details of
their implementation are further discussed in <a href="struct.Poll.html"><code>Poll</code></a>.</p>
<h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1>
<p>Using mio starts by creating a <a href="struct.Poll.html"><code>Poll</code></a>, which reads events from the OS and
put them into <a href="struct.Events.html"><code>Events</code></a>. You can handle IO events from the OS with it.</p>
<p>For more detail, see <a href="struct.Poll.html"><code>Poll</code></a>.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">mio</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">net</span>::{<span class="ident">TcpListener</span>, <span class="ident">TcpStream</span>};
<span class="comment">// Setup some tokens to allow us to identify which event is</span>
<span class="comment">// for which socket.</span>
<span class="kw">const</span> <span class="ident">SERVER</span>: <span class="ident">Token</span> <span class="op">=</span> <span class="ident">Token</span>(<span class="number">0</span>);
<span class="kw">const</span> <span class="ident">CLIENT</span>: <span class="ident">Token</span> <span class="op">=</span> <span class="ident">Token</span>(<span class="number">1</span>);
<span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="string">&quot;127.0.0.1:13265&quot;</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
<span class="comment">// Setup the server socket</span>
<span class="kw">let</span> <span class="ident">server</span> <span class="op">=</span> <span class="ident">TcpListener</span>::<span class="ident">bind</span>(<span class="kw-2">&amp;</span><span class="ident">addr</span>).<span class="ident">unwrap</span>();
<span class="comment">// Create a poll instance</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="ident">unwrap</span>();
<span class="comment">// Start listening for incoming connections</span>
<span class="ident">poll</span>.<span class="ident">register</span>(<span class="kw-2">&amp;</span><span class="ident">server</span>, <span class="ident">SERVER</span>, <span class="ident">Ready</span>::<span class="ident">readable</span>(),
<span class="ident">PollOpt</span>::<span class="ident">edge</span>()).<span class="ident">unwrap</span>();
<span class="comment">// Setup the client socket</span>
<span class="kw">let</span> <span class="ident">sock</span> <span class="op">=</span> <span class="ident">TcpStream</span>::<span class="ident">connect</span>(<span class="kw-2">&amp;</span><span class="ident">addr</span>).<span class="ident">unwrap</span>();
<span class="comment">// Register the socket</span>
<span class="ident">poll</span>.<span class="ident">register</span>(<span class="kw-2">&amp;</span><span class="ident">sock</span>, <span class="ident">CLIENT</span>, <span class="ident">Ready</span>::<span class="ident">readable</span>(),
<span class="ident">PollOpt</span>::<span class="ident">edge</span>()).<span class="ident">unwrap</span>();
<span class="comment">// Create storage for events</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">events</span> <span class="op">=</span> <span class="ident">Events</span>::<span class="ident">with_capacity</span>(<span class="number">1024</span>);
<span class="kw">loop</span> {
<span class="ident">poll</span>.<span class="ident">poll</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">events</span>, <span class="prelude-val">None</span>).<span class="ident">unwrap</span>();
<span class="kw">for</span> <span class="ident">event</span> <span class="kw">in</span> <span class="ident">events</span>.<span class="ident">iter</span>() {
<span class="kw">match</span> <span class="ident">event</span>.<span class="ident">token</span>() {
<span class="ident">SERVER</span> <span class="op">=&gt;</span> {
<span class="comment">// Accept and drop the socket immediately, this will close</span>
<span class="comment">// the socket and notify the client of the EOF.</span>
<span class="kw">let</span> _ <span class="op">=</span> <span class="ident">server</span>.<span class="ident">accept</span>();
}
<span class="ident">CLIENT</span> <span class="op">=&gt;</span> {
<span class="comment">// The server just shuts down the socket, let&#39;s just exit</span>
<span class="comment">// from our event loop.</span>
<span class="kw">return</span>;
}
_ <span class="op">=&gt;</span> <span class="macro">unreachable</span><span class="macro">!</span>(),
}
}
}
</pre>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="event/index.html"
title='mod mio::event'>event</a></td>
<td class='docblock-short'>
<p>Readiness event types and utilities.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="net/index.html"
title='mod mio::net'>net</a></td>
<td class='docblock-short'>
<p>Networking primitives</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="unix/index.html"
title='mod mio::unix'>unix</a></td>
<td class='docblock-short'>
<p>Unix only extensions</p>
</td>
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Events.html"
title='struct mio::Events'>Events</a></td>
<td class='docblock-short'>
<p>A collection of readiness events.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Poll.html"
title='struct mio::Poll'>Poll</a></td>
<td class='docblock-short'>
<p>Polls for readiness events on all registered values.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.PollOpt.html"
title='struct mio::PollOpt'>PollOpt</a></td>
<td class='docblock-short'>
<p>Options supplied when registering an <code>Evented</code> handle with <code>Poll</code></p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Ready.html"
title='struct mio::Ready'>Ready</a></td>
<td class='docblock-short'>
<p>A set of readiness event kinds</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Registration.html"
title='struct mio::Registration'>Registration</a></td>
<td class='docblock-short'>
<p>Handle to a user space <code>Poll</code> registration.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SetReadiness.html"
title='struct mio::SetReadiness'>SetReadiness</a></td>
<td class='docblock-short'>
<p>Updates the readiness state of the associated <code>Registration</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Token.html"
title='struct mio::Token'>Token</a></td>
<td class='docblock-short'>
<p>Associates readiness notifications with <a href="event/trait.Evented.html"><code>Evented</code></a> handles.</p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><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>&#9166;</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>