262 lines
No EOL
12 KiB
HTML
262 lines
No EOL
12 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 `prelude` mod in crate `tokio`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, prelude">
|
||
|
||
<title>tokio::prelude - 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">☰</div>
|
||
|
||
<p class='location'>Module prelude</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>tokio</a></p><script>window.sidebarCurrent = {name: 'prelude', 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</a>::<wbr><a class="mod" href=''>prelude</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/tokio/lib.rs.html#196-235' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>A "prelude" for users of the <code>tokio</code> crate.</p>
|
||
<p>This prelude is similar to the standard library's prelude in that you'll
|
||
almost always want to import its entire contents, but unlike the standard
|
||
library's prelude you'll have to do so manually:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;</pre>
|
||
<p>The prelude may grow over time as additional items see ubiquitous use.</p>
|
||
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="future/index.html"
|
||
title='mod tokio::prelude::future'>future</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Futures</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="stream/index.html"
|
||
title='mod tokio::prelude::stream'>stream</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Asynchronous streams</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="task/index.html"
|
||
title='mod tokio::prelude::task'>task</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Tasks used to drive a future computation</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.Async.html"
|
||
title='enum tokio::prelude::Async'>Async</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Return type of future, indicating whether a value is ready or not.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.AsyncSink.html"
|
||
title='enum tokio::prelude::AsyncSink'>AsyncSink</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The result of an asynchronous attempt to send a value to a sink.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.AsyncRead.html"
|
||
title='trait tokio::prelude::AsyncRead'>AsyncRead</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Read bytes asynchronously.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.AsyncWrite.html"
|
||
title='trait tokio::prelude::AsyncWrite'>AsyncWrite</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Writes bytes asynchronously.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Future.html"
|
||
title='trait tokio::prelude::Future'>Future</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Trait for types which are a placeholder of a value that may become
|
||
available at some later point in time.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.FutureExt.html"
|
||
title='trait tokio::prelude::FutureExt'>FutureExt</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An extension trait for <code>Future</code> that provides a variety of convenient
|
||
combinator functions.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.IntoFuture.html"
|
||
title='trait tokio::prelude::IntoFuture'>IntoFuture</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Class of types which can be converted into a future.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Read.html"
|
||
title='trait tokio::prelude::Read'>Read</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The <code>Read</code> trait allows for reading bytes from a source.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Sink.html"
|
||
title='trait tokio::prelude::Sink'>Sink</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A <code>Sink</code> is a value into which other values can be sent, asynchronously.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Stream.html"
|
||
title='trait tokio::prelude::Stream'>Stream</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A stream of values, not all of which may have been produced yet.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Write.html"
|
||
title='trait tokio::prelude::Write'>Write</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A trait for objects which are byte-oriented sinks.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="type" href="type.Poll.html"
|
||
title='type tokio::prelude::Poll'>Poll</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Return type of the <code>Future::poll</code> method, indicates whether a future's value
|
||
is ready or not.</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>⏎</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";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |