| <!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="A “prelude” for crates using the `futures` crate."><meta name="keywords" content="rust, rustlang, rust-lang, prelude"><title>futures::prelude - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../futures/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../futures/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module prelude</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">futures</a>::<wbr><a class="mod" href="#">prelude</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/futures/lib.rs.html#224">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A “prelude” for crates using the <code>futures</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> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::prelude::<span class="kw-2">*</span>;</code></pre></div> |
| <p>The prelude may grow over time as additional items see ubiquitous use.</p> |
| </div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport._"><code>pub use crate::future::<a class="trait" href="../future/trait.FutureExt.html" title="trait futures::future::FutureExt">FutureExt</a> as _;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport._-1"><code>pub use crate::future::<a class="trait" href="../future/trait.TryFutureExt.html" title="trait futures::future::TryFutureExt">TryFutureExt</a> as _;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport._-2"><code>pub use crate::sink::<a class="trait" href="../sink/trait.SinkExt.html" title="trait futures::sink::SinkExt">SinkExt</a> as _;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport._-3"><code>pub use crate::stream::<a class="trait" href="../stream/trait.StreamExt.html" title="trait futures::stream::StreamExt">StreamExt</a> as _;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport._-4"><code>pub use crate::stream::<a class="trait" href="../stream/trait.TryStreamExt.html" title="trait futures::stream::TryStreamExt">TryStreamExt</a> as _;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport._-5"><code>pub use crate::io::<a class="trait" href="../io/trait.AsyncBufReadExt.html" title="trait futures::io::AsyncBufReadExt">AsyncBufReadExt</a> as _;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport._-6"><code>pub use crate::io::<a class="trait" href="../io/trait.AsyncReadExt.html" title="trait futures::io::AsyncReadExt">AsyncReadExt</a> as _;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport._-7"><code>pub use crate::io::<a class="trait" href="../io/trait.AsyncSeekExt.html" title="trait futures::io::AsyncSeekExt">AsyncSeekExt</a> as _;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport._-8"><code>pub use crate::io::<a class="trait" href="../io/trait.AsyncWriteExt.html" title="trait futures::io::AsyncWriteExt">AsyncWriteExt</a> as _;</code></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="future/index.html" title="futures::prelude::future mod">future</a></div><div class="item-right docblock-short">Asynchronous values.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="sink/index.html" title="futures::prelude::sink mod">sink</a></div><div class="item-right docblock-short">Asynchronous sinks.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="stream/index.html" title="futures::prelude::stream mod">stream</a></div><div class="item-right docblock-short">Asynchronous streams.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.AsyncBufRead.html" title="futures::prelude::AsyncBufRead trait">AsyncBufRead</a></div><div class="item-right docblock-short">Read bytes asynchronously.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.AsyncRead.html" title="futures::prelude::AsyncRead trait">AsyncRead</a></div><div class="item-right docblock-short">Read bytes asynchronously.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.AsyncSeek.html" title="futures::prelude::AsyncSeek trait">AsyncSeek</a></div><div class="item-right docblock-short">Seek bytes asynchronously.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.AsyncWrite.html" title="futures::prelude::AsyncWrite trait">AsyncWrite</a></div><div class="item-right docblock-short">Write bytes asynchronously.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Future.html" title="futures::prelude::Future trait">Future</a></div><div class="item-right docblock-short">A future represents an asynchronous computation obtained by use of <a href="../../std/keyword.async.html"><code>async</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Sink.html" title="futures::prelude::Sink trait">Sink</a></div><div class="item-right docblock-short">A <code>Sink</code> is a value into which other values can be sent, asynchronously.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Stream.html" title="futures::prelude::Stream trait">Stream</a></div><div class="item-right docblock-short">A stream of values produced asynchronously.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TryFuture.html" title="futures::prelude::TryFuture trait">TryFuture</a></div><div class="item-right docblock-short">A convenience for futures that return <code>Result</code> values that includes |
| a variety of adapters tailored to such futures.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TryStream.html" title="futures::prelude::TryStream trait">TryStream</a></div><div class="item-right docblock-short">A convenience for streams that return <code>Result</code> values that includes |
| a variety of adapters tailored to such futures.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
