| <!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="Mio is a fast, low-level I/O library for Rust focusing on non-blocking APIs and event notification for building high performance I/O apps with as little overhead as possible over the OS abstractions."><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg"> |
| <link rel="alternate icon" type="image/png" href="../favicon-16x16.png"> |
| <link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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" role="button">☰</div><a href='../mio/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate mio</p><div class="block version"><p>Version 0.8.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all mio's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="mio" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> |
| <a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></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">−</span>]</a></span><a class="srclink" href="../src/mio/lib.rs.html#1-264" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Mio is a fast, low-level I/O library for Rust focusing on non-blocking APIs |
| and event notification for building high performance I/O apps with as little |
| overhead as possible over the OS abstractions.</p> |
| <h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1> |
| <p>Using Mio starts by creating a <a href="../mio/struct.Poll.html"><code>Poll</code></a>, which reads events from the OS and |
| puts them into <a href="../mio/event/struct.Events.html"><code>Events</code></a>. You can handle I/O events from the OS with it.</p> |
| <p>For more detail, see <a href="../mio/struct.Poll.html"><code>Poll</code></a>.</p> |
| <h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2> |
| <p>Examples can found in the <code>examples</code> directory of the source code, or <a href="https://github.com/tokio-rs/mio/tree/master/examples">on |
| GitHub</a>.</p> |
| <h2 id="guide" class="section-header"><a href="#guide">Guide</a></h2> |
| <p>A getting started guide is available in the <a href="../mio/guide/index.html" title="guide"><code>guide</code></a> module.</p> |
| <h2 id="available-features" class="section-header"><a href="#available-features">Available features</a></h2> |
| <p>The available features are described in the <a href="../mio/features/index.html" title="features"><code>features</code></a> module.</p> |
| </div><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2> |
| <table><tr><td><code>pub use event::<a class="struct" href="../mio/event/struct.Events.html" title="struct mio::event::Events">Events</a>;</code></td></tr></table><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="mio::event mod">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="features/index.html" title="mio::features mod">features</a></td><td class="docblock-short"><p>Mio’s optional features.</p> |
| </td></tr><tr class="module-item"><td><a class="mod" href="guide/index.html" title="mio::guide mod">guide</a></td><td class="docblock-short"><p>Getting started guide.</p> |
| </td></tr><tr class="module-item"><td><a class="mod" href="net/index.html" title="mio::net mod">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="mio::unix mod">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.Interest.html" title="mio::Interest struct">Interest</a></td><td class="docblock-short"><p>Interest used in registering.</p> |
| </td></tr><tr class="module-item"><td><a class="struct" href="struct.Poll.html" title="mio::Poll struct">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.Registry.html" title="mio::Registry struct">Registry</a></td><td class="docblock-short"><p>Registers I/O resources.</p> |
| </td></tr><tr class="module-item"><td><a class="struct" href="struct.Token.html" title="mio::Token struct">Token</a></td><td class="docblock-short"><p>Associates readiness events with <a href="./event/trait.Source.html"><code>event::Source</code></a>s.</p> |
| </td></tr><tr class="module-item"><td><a class="struct" href="struct.Waker.html" title="mio::Waker struct">Waker</a></td><td class="docblock-short"><p>Waker allows cross-thread waking of <a href="struct.Poll.html"><code>Poll</code></a>.</p> |
| </td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="mio" data-search-js="../search-index.js"></div> |
| <script src="../main.js"></script></body></html> |
