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

191 lines
No EOL
8.1 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 `reactor` mod in crate `tokio_core`.">
<meta name="keywords" content="rust, rustlang, rust-lang, reactor">
<title>tokio_core::reactor - 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'>Module reactor</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'><a href='../index.html'>tokio_core</a></p><script>window.sidebarCurrent = {name: 'reactor', ty: 'mod', 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'>Module <a href='../index.html'>tokio_core</a>::<wbr><a class="mod" href=''>reactor</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/tokio_core/reactor/mod.rs.html#1-708' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>The core reactor driving all I/O</p>
<p>This module contains the <code>Core</code> type which is the reactor for all I/O
happening in <code>tokio-core</code>. This reactor (or event loop) is used to run
futures, schedule tasks, issue I/O requests, etc.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Core.html"
title='struct tokio_core::reactor::Core'>Core</a></td>
<td class='docblock-short'>
<p>An event loop.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.CoreId.html"
title='struct tokio_core::reactor::CoreId'>CoreId</a></td>
<td class='docblock-short'>
<p>An unique ID for a Core</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Handle.html"
title='struct tokio_core::reactor::Handle'>Handle</a></td>
<td class='docblock-short'>
<p>A non-sendable handle to an event loop, useful for manufacturing instances
of <code>LoopData</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Interval.html"
title='struct tokio_core::reactor::Interval'>Interval</a></td>
<td class='docblock-short'>
<p>A stream representing notifications at fixed interval</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.PollEvented.html"
title='struct tokio_core::reactor::PollEvented'>PollEvented</a></td>
<td class='docblock-short'>
<p>A concrete implementation of a stream of readiness notifications for I/O
objects that originates from an event loop.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Remote.html"
title='struct tokio_core::reactor::Remote'>Remote</a></td>
<td class='docblock-short'>
<p>Handle to an event loop, used to construct I/O objects, send messages, and
otherwise interact indirectly with the event loop itself.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Timeout.html"
title='struct tokio_core::reactor::Timeout'>Timeout</a></td>
<td class='docblock-short'>
<p>A future representing the notification that a timeout has occurred.</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 = "tokio_core";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>