mentat/tokio/prelude/future/enum.Either.html
2018-08-22 17:04:13 +00:00

199 lines
No EOL
43 KiB
HTML
Raw Permalink 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 `Either` enum in crate `tokio`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Either">
<title>tokio::prelude::future::Either - 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 enum">
<!--[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'>Enum Either</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.A">A</a><a href="#variant.B">B</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.split">split</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Future">Future</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>prelude</a>::<wbr><a href='index.html'>future</a></p><script>window.sidebarCurrent = {name: 'Either', ty: 'enum', 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'>Enum <a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>prelude</a>::<wbr><a href='index.html'>future</a>::<wbr><a class="enum" href=''>Either</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/futures/future/either.rs.html#6-11' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum Either&lt;A, B&gt; {
A(A),
B(B),
}</pre><div class='docblock'><p>Combines two different futures yielding the same item and error
types into a single type.</p>
</div><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id="variant.A" class="variant small-section-header"><a href="#variant.A" class="anchor field"></a><span id='A.v' class='invisible'><code>A(A)</code></span></span><div class='docblock'><p>First branch of the type</p>
</div><span id="variant.B" class="variant small-section-header"><a href="#variant.B" class="anchor field"></a><span id='B.v' class='invisible'><code>B(B)</code></span></span><div class='docblock'><p>Second branch of the type</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;T, A, B&gt; <a class="enum" href="../../../tokio/prelude/future/enum.Either.html" title="enum tokio::prelude::future::Either">Either</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, A<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, B<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/either.rs.html#13-24' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.split' class="method"><span id='split.v' class='invisible'><code>pub fn <a href='#method.split' class='fnname'>split</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, <a class="enum" href="../../../tokio/prelude/future/enum.Either.html" title="enum tokio::prelude::future::Either">Either</a>&lt;A, B&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/either.rs.html#18-23' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Splits out the homogeneous type from an either of tuples.</p>
<p>This method is typically useful when combined with the <code>Future::select2</code>
combinator.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Future' class='impl'><span class='in-band'><code>impl&lt;A, B&gt; <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a> for <a class="enum" href="../../../tokio/prelude/future/enum.Either.html" title="enum tokio::prelude::future::Either">Either</a>&lt;A, B&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>&lt;Item = &lt;A as <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>&gt;::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>, Error = &lt;A as <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>&gt;::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,&nbsp;</span></code><a href='#impl-Future' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/either.rs.html#26-39' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='../../../tokio/prelude/future/trait.Future.html#associatedtype.Item' class="type">Item</a> = &lt;A as <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>&gt;::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a></code></span></h4>
<div class='docblock'><p>The type of value that this future will resolved with if it is successful. <a href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item">Read more</a></p>
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../../../tokio/prelude/future/trait.Future.html#associatedtype.Error' class="type">Error</a> = &lt;A as <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>&gt;::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a></code></span></h4>
<div class='docblock'><p>The type of error that this future will resolve with if it fails in a normal fashion. <a href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error">Read more</a></p>
</div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#tymethod.poll' class='fnname'>poll</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../../../tokio/prelude/enum.Async.html" title="enum tokio::prelude::Async">Async</a>&lt;&lt;A as <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>&gt;::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>&gt;, &lt;A as <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::future::Future">Future</a>&gt;::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/either.rs.html#33-38' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Query this future to see if its value has become available, registering interest if it is not. <a href="../../../tokio/prelude/future/trait.Future.html#tymethod.poll">Read more</a></p>
</div><h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.wait' class='fnname'>wait</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>, Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#296-300' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Block the current thread until this future is resolved. <a href="../../../tokio/prelude/future/trait.Future.html#method.wait">Read more</a></p>
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.map' class='fnname'>map</a>&lt;F, U&gt;(self, f: F) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Map.html" title="struct tokio::prelude::future::Map">Map</a>&lt;Self, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>) -&gt; U,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#370-375' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Map this future's result to a different type, returning a new future of the resulting type. <a href="../../../tokio/prelude/future/trait.Future.html#method.map">Read more</a></p>
</div><h4 id='method.map_err' class="method"><span id='map_err.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.map_err' class='fnname'>map_err</a>&lt;F, E&gt;(self, f: F) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.MapErr.html" title="struct tokio::prelude::future::MapErr">MapErr</a>&lt;Self, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>) -&gt; E,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#410-415' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Map this future's error to a different error, returning a new future. <a href="../../../tokio/prelude/future/trait.Future.html#method.map_err">Read more</a></p>
</div><h4 id='method.from_err' class="method"><span id='from_err.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.from_err' class='fnname'>from_err</a>&lt;E&gt;(self) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.FromErr.html" title="struct tokio::prelude::future::FromErr">FromErr</a>&lt;Self, E&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#440-444' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Map this future's error to any error implementing <code>From</code> for this future's <code>Error</code>, returning a new future. <a href="../../../tokio/prelude/future/trait.Future.html#method.from_err">Read more</a></p>
</div><h4 id='method.then' class="method"><span id='then.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.then' class='fnname'>then</a>&lt;F, B&gt;(self, f: F) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Then.html" title="struct tokio::prelude::future::Then">Then</a>&lt;Self, B, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>, Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;) -&gt; B,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#484-490' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Chain on a computation for when a future finished, passing the result of the future to the provided closure <code>f</code>. <a href="../../../tokio/prelude/future/trait.Future.html#method.then">Read more</a></p>
</div><h4 id='method.and_then' class="method"><span id='and_then.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.and_then' class='fnname'>and_then</a>&lt;F, B&gt;(self, f: F) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.AndThen.html" title="struct tokio::prelude::future::AndThen">AndThen</a>&lt;Self, B, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>) -&gt; B,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#525-531' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Execute another future after this one has resolved successfully. <a href="../../../tokio/prelude/future/trait.Future.html#method.and_then">Read more</a></p>
</div><h4 id='method.or_else' class="method"><span id='or_else.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.or_else' class='fnname'>or_else</a>&lt;F, B&gt;(self, f: F) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.OrElse.html" title="struct tokio::prelude::future::OrElse">OrElse</a>&lt;Self, B, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Item = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>) -&gt; B,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#566-572' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Execute another future if this one resolves with an error. <a href="../../../tokio/prelude/future/trait.Future.html#method.or_else">Read more</a></p>
</div><h4 id='method.select' class="method"><span id='select.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.select' class='fnname'>select</a>&lt;B&gt;(self, other: B) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Select.html" title="struct tokio::prelude::future::Select">Select</a>&lt;Self, &lt;B as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Item = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>, Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#624-631' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Waits for either one of two futures to complete. <a href="../../../tokio/prelude/future/trait.Future.html#method.select">Read more</a></p>
</div><h4 id='method.select2' class="method"><span id='select2.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.select2' class='fnname'>select2</a>&lt;B&gt;(self, other: B) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Select2.html" title="struct tokio::prelude::future::Select2">Select2</a>&lt;Self, &lt;B as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#670-674' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Waits for either one of two differently-typed futures to complete. <a href="../../../tokio/prelude/future/trait.Future.html#method.select2">Read more</a></p>
</div><h4 id='method.join' class="method"><span id='join.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.join' class='fnname'>join</a>&lt;B&gt;(self, other: B) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Join.html" title="struct tokio::prelude::future::Join">Join</a>&lt;Self, &lt;B as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#715-721' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Joins the result of two futures, waiting for them both to complete. <a href="../../../tokio/prelude/future/trait.Future.html#method.join">Read more</a></p>
</div><h4 id='method.join3' class="method"><span id='join3.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.join3' class='fnname'>join3</a>&lt;B, C&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;b: B, <br>&nbsp;&nbsp;&nbsp;&nbsp;c: C<br>) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Join3.html" title="struct tokio::prelude::future::Join3">Join3</a>&lt;Self, &lt;B as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>, &lt;C as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;C: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#724-730' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
</div><h4 id='method.join4' class="method"><span id='join4.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.join4' class='fnname'>join4</a>&lt;B, C, D&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;b: B, <br>&nbsp;&nbsp;&nbsp;&nbsp;c: C, <br>&nbsp;&nbsp;&nbsp;&nbsp;d: D<br>) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Join4.html" title="struct tokio::prelude::future::Join4">Join4</a>&lt;Self, &lt;B as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>, &lt;C as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>, &lt;D as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;C: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#733-741' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
</div><h4 id='method.join5' class="method"><span id='join5.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.join5' class='fnname'>join5</a>&lt;B, C, D, E&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;b: B, <br>&nbsp;&nbsp;&nbsp;&nbsp;c: C, <br>&nbsp;&nbsp;&nbsp;&nbsp;d: D, <br>&nbsp;&nbsp;&nbsp;&nbsp;e: E<br>) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Join5.html" title="struct tokio::prelude::future::Join5">Join5</a>&lt;Self, &lt;B as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>, &lt;C as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>, &lt;D as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>, &lt;E as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;C: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Error = Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#744-754' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
</div><h4 id='method.into_stream' class="method"><span id='into_stream.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.into_stream' class='fnname'>into_stream</a>(self) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.IntoStream.html" title="struct tokio::prelude::future::IntoStream">IntoStream</a>&lt;Self&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#777-781' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Convert this future into a single element stream. <a href="../../../tokio/prelude/future/trait.Future.html#method.into_stream">Read more</a></p>
</div><h4 id='method.flatten' class="method"><span id='flatten.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.flatten' class='fnname'>flatten</a>(self) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Flatten.html" title="struct tokio::prelude::future::Flatten">Flatten</a>&lt;Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a> as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Error" title="type tokio::prelude::IntoFuture::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#819-829' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Flatten the execution of this future when the successful result of this future is itself another future. <a href="../../../tokio/prelude/future/trait.Future.html#method.flatten">Read more</a></p>
</div><h4 id='method.flatten_stream' class="method"><span id='flatten_stream.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.flatten_stream' class='fnname'>flatten_stream</a>(self) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.FlattenStream.html" title="struct tokio::prelude::future::FlattenStream">FlattenStream</a>&lt;Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>: <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a> as <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>&gt;::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a> == Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Error" title="type tokio::prelude::future::Future::Error">Error</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#859-864' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Flatten the execution of this future when the successful result of this future is a stream. <a href="../../../tokio/prelude/future/trait.Future.html#method.flatten_stream">Read more</a></p>
</div><h4 id='method.fuse' class="method"><span id='fuse.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.fuse' class='fnname'>fuse</a>(self) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Fuse.html" title="struct tokio::prelude::future::Fuse">Fuse</a>&lt;Self&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#899-904' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Fuse a future such that <code>poll</code> will never again be called once it has completed. <a href="../../../tokio/prelude/future/trait.Future.html#method.fuse">Read more</a></p>
</div><h4 id='method.inspect' class="method"><span id='inspect.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.inspect' class='fnname'>inspect</a>&lt;F&gt;(self, f: F) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Inspect.html" title="struct tokio::prelude::future::Inspect">Inspect</a>&lt;Self, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&amp;Self::<a class="type" href="../../../tokio/prelude/future/trait.Future.html#associatedtype.Item" title="type tokio::prelude::future::Future::Item">Item</a>),&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#922-927' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Do something with the item of a future, passing it on. <a href="../../../tokio/prelude/future/trait.Future.html#method.inspect">Read more</a></p>
</div><h4 id='method.catch_unwind' class="method"><span id='catch_unwind.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.catch_unwind' class='fnname'>catch_unwind</a>(self) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.CatchUnwind.html" title="struct tokio::prelude::future::CatchUnwind">CatchUnwind</a>&lt;Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#961-965' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Catches unwinding panics while polling the future. <a href="../../../tokio/prelude/future/trait.Future.html#method.catch_unwind">Read more</a></p>
</div><h4 id='method.shared' class="method"><span id='shared.v' class='invisible'><code>fn <a href='../../../tokio/prelude/future/trait.Future.html#method.shared' class='fnname'>shared</a>(self) -&gt; <a class="struct" href="../../../tokio/prelude/future/struct.Shared.html" title="struct tokio::prelude::future::Shared">Shared</a>&lt;Self&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/mod.rs.html#1010-1014' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Create a cloneable handle to this future where all handles will resolve to the same result. <a href="../../../tokio/prelude/future/trait.Future.html#method.shared">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;A, B&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../../tokio/prelude/future/enum.Either.html" title="enum tokio::prelude::future::Either">Either</a>&lt;A, B&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,&nbsp;</span></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/either.rs.html#5' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/future/either.rs.html#5' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div></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";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>