| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/futures-util-0.3.28/src/async_await/join_mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>join_mod.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../futures_util/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! The `join` macro. |
| |
| </span><span class="macro">macro_rules! </span>document_join_macro { |
| (<span class="macro-nonterminal">$join</span>:item <span class="macro-nonterminal">$try_join</span>:item) => { |
| <span class="doccomment">/// Polls multiple futures simultaneously, returning a tuple |
| /// of all results once complete. |
| /// |
| /// While `join!(a, b)` is similar to `(a.await, b.await)`, |
| /// `join!` polls both futures concurrently and therefore is more efficient. |
| /// |
| /// This macro is only usable inside of async functions, closures, and blocks. |
| /// It is also gated behind the `async-await` feature of this library, which is |
| /// activated by default. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # futures::executor::block_on(async { |
| /// use futures::join; |
| /// |
| /// let a = async { 1 }; |
| /// let b = async { 2 }; |
| /// assert_eq!(join!(a, b), (1, 2)); |
| /// |
| /// // `join!` is variadic, so you can pass any number of futures |
| /// let c = async { 3 }; |
| /// let d = async { 4 }; |
| /// let e = async { 5 }; |
| /// assert_eq!(join!(c, d, e), (3, 4, 5)); |
| /// # }); |
| /// ``` |
| </span><span class="macro-nonterminal">$join |
| |
| </span><span class="doccomment">/// Polls multiple futures simultaneously, resolving to a [`Result`] containing |
| /// either a tuple of the successful outputs or an error. |
| /// |
| /// `try_join!` is similar to [`join!`], but completes immediately if any of |
| /// the futures return an error. |
| /// |
| /// This macro is only usable inside of async functions, closures, and blocks. |
| /// It is also gated behind the `async-await` feature of this library, which is |
| /// activated by default. |
| /// |
| /// # Examples |
| /// |
| /// When used on multiple futures that return `Ok`, `try_join!` will return |
| /// `Ok` of a tuple of the values: |
| /// |
| /// ``` |
| /// # futures::executor::block_on(async { |
| /// use futures::try_join; |
| /// |
| /// let a = async { Ok::<i32, i32>(1) }; |
| /// let b = async { Ok::<i32, i32>(2) }; |
| /// assert_eq!(try_join!(a, b), Ok((1, 2))); |
| /// |
| /// // `try_join!` is variadic, so you can pass any number of futures |
| /// let c = async { Ok::<i32, i32>(3) }; |
| /// let d = async { Ok::<i32, i32>(4) }; |
| /// let e = async { Ok::<i32, i32>(5) }; |
| /// assert_eq!(try_join!(c, d, e), Ok((3, 4, 5))); |
| /// # }); |
| /// ``` |
| /// |
| /// If one of the futures resolves to an error, `try_join!` will return |
| /// that error: |
| /// |
| /// ``` |
| /// # futures::executor::block_on(async { |
| /// use futures::try_join; |
| /// |
| /// let a = async { Ok::<i32, i32>(1) }; |
| /// let b = async { Err::<u64, i32>(2) }; |
| /// |
| /// assert_eq!(try_join!(a, b), Err(2)); |
| /// # }); |
| /// ``` |
| </span><span class="macro-nonterminal">$try_join |
| </span>} |
| } |
| |
| <span class="attribute">#[allow(unreachable_pub)] |
| #[doc(hidden)] |
| </span><span class="kw">pub use </span>futures_macro::join_internal; |
| |
| <span class="attribute">#[allow(unreachable_pub)] |
| #[doc(hidden)] |
| </span><span class="kw">pub use </span>futures_macro::try_join_internal; |
| |
| <span class="macro">document_join_macro! </span>{ |
| <span class="attribute">#[macro_export] |
| </span><span class="macro">macro_rules! </span>join { |
| ($(<span class="macro-nonterminal">$tokens</span>:tt)<span class="kw-2">*</span>) => {{ |
| <span class="kw">use </span><span class="macro-nonterminal">$crate::__private </span><span class="kw">as </span>__futures_crate; |
| <span class="macro-nonterminal">$</span><span class="macro">crate::join_internal! </span>{ |
| $( <span class="macro-nonterminal">$tokens </span>)* |
| } |
| }} |
| } |
| |
| <span class="attribute">#[macro_export] |
| </span><span class="macro">macro_rules! </span>try_join { |
| ($(<span class="macro-nonterminal">$tokens</span>:tt)<span class="kw-2">*</span>) => {{ |
| <span class="kw">use </span><span class="macro-nonterminal">$crate::__private </span><span class="kw">as </span>__futures_crate; |
| <span class="macro-nonterminal">$</span><span class="macro">crate::try_join_internal! </span>{ |
| $( <span class="macro-nonterminal">$tokens </span>)* |
| } |
| }} |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
