clfft 0.3.2

Bindings for clFFT, a FFT library for OpenCL.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
<!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 to the Rust file `C:\Users\Chrilieb\.cargo\registry\src\github.com-1ecc6299db9ec823\futures-0.1.14\src\future\mod.rs`.">
    <meta name="keywords" content="rust, rustlang, rust-lang">

    <title>mod.rs.html -- source</title>

    <link rel="stylesheet" type="text/css" href="../../../normalize.css">
    <link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
    <link rel="stylesheet" type="text/css" href="../../../main.css">
    

    
    
</head>
<body class="rustdoc source">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        
        
    </nav>

    <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"><pre class="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>
<span id="111"> 111</span>
<span id="112"> 112</span>
<span id="113"> 113</span>
<span id="114"> 114</span>
<span id="115"> 115</span>
<span id="116"> 116</span>
<span id="117"> 117</span>
<span id="118"> 118</span>
<span id="119"> 119</span>
<span id="120"> 120</span>
<span id="121"> 121</span>
<span id="122"> 122</span>
<span id="123"> 123</span>
<span id="124"> 124</span>
<span id="125"> 125</span>
<span id="126"> 126</span>
<span id="127"> 127</span>
<span id="128"> 128</span>
<span id="129"> 129</span>
<span id="130"> 130</span>
<span id="131"> 131</span>
<span id="132"> 132</span>
<span id="133"> 133</span>
<span id="134"> 134</span>
<span id="135"> 135</span>
<span id="136"> 136</span>
<span id="137"> 137</span>
<span id="138"> 138</span>
<span id="139"> 139</span>
<span id="140"> 140</span>
<span id="141"> 141</span>
<span id="142"> 142</span>
<span id="143"> 143</span>
<span id="144"> 144</span>
<span id="145"> 145</span>
<span id="146"> 146</span>
<span id="147"> 147</span>
<span id="148"> 148</span>
<span id="149"> 149</span>
<span id="150"> 150</span>
<span id="151"> 151</span>
<span id="152"> 152</span>
<span id="153"> 153</span>
<span id="154"> 154</span>
<span id="155"> 155</span>
<span id="156"> 156</span>
<span id="157"> 157</span>
<span id="158"> 158</span>
<span id="159"> 159</span>
<span id="160"> 160</span>
<span id="161"> 161</span>
<span id="162"> 162</span>
<span id="163"> 163</span>
<span id="164"> 164</span>
<span id="165"> 165</span>
<span id="166"> 166</span>
<span id="167"> 167</span>
<span id="168"> 168</span>
<span id="169"> 169</span>
<span id="170"> 170</span>
<span id="171"> 171</span>
<span id="172"> 172</span>
<span id="173"> 173</span>
<span id="174"> 174</span>
<span id="175"> 175</span>
<span id="176"> 176</span>
<span id="177"> 177</span>
<span id="178"> 178</span>
<span id="179"> 179</span>
<span id="180"> 180</span>
<span id="181"> 181</span>
<span id="182"> 182</span>
<span id="183"> 183</span>
<span id="184"> 184</span>
<span id="185"> 185</span>
<span id="186"> 186</span>
<span id="187"> 187</span>
<span id="188"> 188</span>
<span id="189"> 189</span>
<span id="190"> 190</span>
<span id="191"> 191</span>
<span id="192"> 192</span>
<span id="193"> 193</span>
<span id="194"> 194</span>
<span id="195"> 195</span>
<span id="196"> 196</span>
<span id="197"> 197</span>
<span id="198"> 198</span>
<span id="199"> 199</span>
<span id="200"> 200</span>
<span id="201"> 201</span>
<span id="202"> 202</span>
<span id="203"> 203</span>
<span id="204"> 204</span>
<span id="205"> 205</span>
<span id="206"> 206</span>
<span id="207"> 207</span>
<span id="208"> 208</span>
<span id="209"> 209</span>
<span id="210"> 210</span>
<span id="211"> 211</span>
<span id="212"> 212</span>
<span id="213"> 213</span>
<span id="214"> 214</span>
<span id="215"> 215</span>
<span id="216"> 216</span>
<span id="217"> 217</span>
<span id="218"> 218</span>
<span id="219"> 219</span>
<span id="220"> 220</span>
<span id="221"> 221</span>
<span id="222"> 222</span>
<span id="223"> 223</span>
<span id="224"> 224</span>
<span id="225"> 225</span>
<span id="226"> 226</span>
<span id="227"> 227</span>
<span id="228"> 228</span>
<span id="229"> 229</span>
<span id="230"> 230</span>
<span id="231"> 231</span>
<span id="232"> 232</span>
<span id="233"> 233</span>
<span id="234"> 234</span>
<span id="235"> 235</span>
<span id="236"> 236</span>
<span id="237"> 237</span>
<span id="238"> 238</span>
<span id="239"> 239</span>
<span id="240"> 240</span>
<span id="241"> 241</span>
<span id="242"> 242</span>
<span id="243"> 243</span>
<span id="244"> 244</span>
<span id="245"> 245</span>
<span id="246"> 246</span>
<span id="247"> 247</span>
<span id="248"> 248</span>
<span id="249"> 249</span>
<span id="250"> 250</span>
<span id="251"> 251</span>
<span id="252"> 252</span>
<span id="253"> 253</span>
<span id="254"> 254</span>
<span id="255"> 255</span>
<span id="256"> 256</span>
<span id="257"> 257</span>
<span id="258"> 258</span>
<span id="259"> 259</span>
<span id="260"> 260</span>
<span id="261"> 261</span>
<span id="262"> 262</span>
<span id="263"> 263</span>
<span id="264"> 264</span>
<span id="265"> 265</span>
<span id="266"> 266</span>
<span id="267"> 267</span>
<span id="268"> 268</span>
<span id="269"> 269</span>
<span id="270"> 270</span>
<span id="271"> 271</span>
<span id="272"> 272</span>
<span id="273"> 273</span>
<span id="274"> 274</span>
<span id="275"> 275</span>
<span id="276"> 276</span>
<span id="277"> 277</span>
<span id="278"> 278</span>
<span id="279"> 279</span>
<span id="280"> 280</span>
<span id="281"> 281</span>
<span id="282"> 282</span>
<span id="283"> 283</span>
<span id="284"> 284</span>
<span id="285"> 285</span>
<span id="286"> 286</span>
<span id="287"> 287</span>
<span id="288"> 288</span>
<span id="289"> 289</span>
<span id="290"> 290</span>
<span id="291"> 291</span>
<span id="292"> 292</span>
<span id="293"> 293</span>
<span id="294"> 294</span>
<span id="295"> 295</span>
<span id="296"> 296</span>
<span id="297"> 297</span>
<span id="298"> 298</span>
<span id="299"> 299</span>
<span id="300"> 300</span>
<span id="301"> 301</span>
<span id="302"> 302</span>
<span id="303"> 303</span>
<span id="304"> 304</span>
<span id="305"> 305</span>
<span id="306"> 306</span>
<span id="307"> 307</span>
<span id="308"> 308</span>
<span id="309"> 309</span>
<span id="310"> 310</span>
<span id="311"> 311</span>
<span id="312"> 312</span>
<span id="313"> 313</span>
<span id="314"> 314</span>
<span id="315"> 315</span>
<span id="316"> 316</span>
<span id="317"> 317</span>
<span id="318"> 318</span>
<span id="319"> 319</span>
<span id="320"> 320</span>
<span id="321"> 321</span>
<span id="322"> 322</span>
<span id="323"> 323</span>
<span id="324"> 324</span>
<span id="325"> 325</span>
<span id="326"> 326</span>
<span id="327"> 327</span>
<span id="328"> 328</span>
<span id="329"> 329</span>
<span id="330"> 330</span>
<span id="331"> 331</span>
<span id="332"> 332</span>
<span id="333"> 333</span>
<span id="334"> 334</span>
<span id="335"> 335</span>
<span id="336"> 336</span>
<span id="337"> 337</span>
<span id="338"> 338</span>
<span id="339"> 339</span>
<span id="340"> 340</span>
<span id="341"> 341</span>
<span id="342"> 342</span>
<span id="343"> 343</span>
<span id="344"> 344</span>
<span id="345"> 345</span>
<span id="346"> 346</span>
<span id="347"> 347</span>
<span id="348"> 348</span>
<span id="349"> 349</span>
<span id="350"> 350</span>
<span id="351"> 351</span>
<span id="352"> 352</span>
<span id="353"> 353</span>
<span id="354"> 354</span>
<span id="355"> 355</span>
<span id="356"> 356</span>
<span id="357"> 357</span>
<span id="358"> 358</span>
<span id="359"> 359</span>
<span id="360"> 360</span>
<span id="361"> 361</span>
<span id="362"> 362</span>
<span id="363"> 363</span>
<span id="364"> 364</span>
<span id="365"> 365</span>
<span id="366"> 366</span>
<span id="367"> 367</span>
<span id="368"> 368</span>
<span id="369"> 369</span>
<span id="370"> 370</span>
<span id="371"> 371</span>
<span id="372"> 372</span>
<span id="373"> 373</span>
<span id="374"> 374</span>
<span id="375"> 375</span>
<span id="376"> 376</span>
<span id="377"> 377</span>
<span id="378"> 378</span>
<span id="379"> 379</span>
<span id="380"> 380</span>
<span id="381"> 381</span>
<span id="382"> 382</span>
<span id="383"> 383</span>
<span id="384"> 384</span>
<span id="385"> 385</span>
<span id="386"> 386</span>
<span id="387"> 387</span>
<span id="388"> 388</span>
<span id="389"> 389</span>
<span id="390"> 390</span>
<span id="391"> 391</span>
<span id="392"> 392</span>
<span id="393"> 393</span>
<span id="394"> 394</span>
<span id="395"> 395</span>
<span id="396"> 396</span>
<span id="397"> 397</span>
<span id="398"> 398</span>
<span id="399"> 399</span>
<span id="400"> 400</span>
<span id="401"> 401</span>
<span id="402"> 402</span>
<span id="403"> 403</span>
<span id="404"> 404</span>
<span id="405"> 405</span>
<span id="406"> 406</span>
<span id="407"> 407</span>
<span id="408"> 408</span>
<span id="409"> 409</span>
<span id="410"> 410</span>
<span id="411"> 411</span>
<span id="412"> 412</span>
<span id="413"> 413</span>
<span id="414"> 414</span>
<span id="415"> 415</span>
<span id="416"> 416</span>
<span id="417"> 417</span>
<span id="418"> 418</span>
<span id="419"> 419</span>
<span id="420"> 420</span>
<span id="421"> 421</span>
<span id="422"> 422</span>
<span id="423"> 423</span>
<span id="424"> 424</span>
<span id="425"> 425</span>
<span id="426"> 426</span>
<span id="427"> 427</span>
<span id="428"> 428</span>
<span id="429"> 429</span>
<span id="430"> 430</span>
<span id="431"> 431</span>
<span id="432"> 432</span>
<span id="433"> 433</span>
<span id="434"> 434</span>
<span id="435"> 435</span>
<span id="436"> 436</span>
<span id="437"> 437</span>
<span id="438"> 438</span>
<span id="439"> 439</span>
<span id="440"> 440</span>
<span id="441"> 441</span>
<span id="442"> 442</span>
<span id="443"> 443</span>
<span id="444"> 444</span>
<span id="445"> 445</span>
<span id="446"> 446</span>
<span id="447"> 447</span>
<span id="448"> 448</span>
<span id="449"> 449</span>
<span id="450"> 450</span>
<span id="451"> 451</span>
<span id="452"> 452</span>
<span id="453"> 453</span>
<span id="454"> 454</span>
<span id="455"> 455</span>
<span id="456"> 456</span>
<span id="457"> 457</span>
<span id="458"> 458</span>
<span id="459"> 459</span>
<span id="460"> 460</span>
<span id="461"> 461</span>
<span id="462"> 462</span>
<span id="463"> 463</span>
<span id="464"> 464</span>
<span id="465"> 465</span>
<span id="466"> 466</span>
<span id="467"> 467</span>
<span id="468"> 468</span>
<span id="469"> 469</span>
<span id="470"> 470</span>
<span id="471"> 471</span>
<span id="472"> 472</span>
<span id="473"> 473</span>
<span id="474"> 474</span>
<span id="475"> 475</span>
<span id="476"> 476</span>
<span id="477"> 477</span>
<span id="478"> 478</span>
<span id="479"> 479</span>
<span id="480"> 480</span>
<span id="481"> 481</span>
<span id="482"> 482</span>
<span id="483"> 483</span>
<span id="484"> 484</span>
<span id="485"> 485</span>
<span id="486"> 486</span>
<span id="487"> 487</span>
<span id="488"> 488</span>
<span id="489"> 489</span>
<span id="490"> 490</span>
<span id="491"> 491</span>
<span id="492"> 492</span>
<span id="493"> 493</span>
<span id="494"> 494</span>
<span id="495"> 495</span>
<span id="496"> 496</span>
<span id="497"> 497</span>
<span id="498"> 498</span>
<span id="499"> 499</span>
<span id="500"> 500</span>
<span id="501"> 501</span>
<span id="502"> 502</span>
<span id="503"> 503</span>
<span id="504"> 504</span>
<span id="505"> 505</span>
<span id="506"> 506</span>
<span id="507"> 507</span>
<span id="508"> 508</span>
<span id="509"> 509</span>
<span id="510"> 510</span>
<span id="511"> 511</span>
<span id="512"> 512</span>
<span id="513"> 513</span>
<span id="514"> 514</span>
<span id="515"> 515</span>
<span id="516"> 516</span>
<span id="517"> 517</span>
<span id="518"> 518</span>
<span id="519"> 519</span>
<span id="520"> 520</span>
<span id="521"> 521</span>
<span id="522"> 522</span>
<span id="523"> 523</span>
<span id="524"> 524</span>
<span id="525"> 525</span>
<span id="526"> 526</span>
<span id="527"> 527</span>
<span id="528"> 528</span>
<span id="529"> 529</span>
<span id="530"> 530</span>
<span id="531"> 531</span>
<span id="532"> 532</span>
<span id="533"> 533</span>
<span id="534"> 534</span>
<span id="535"> 535</span>
<span id="536"> 536</span>
<span id="537"> 537</span>
<span id="538"> 538</span>
<span id="539"> 539</span>
<span id="540"> 540</span>
<span id="541"> 541</span>
<span id="542"> 542</span>
<span id="543"> 543</span>
<span id="544"> 544</span>
<span id="545"> 545</span>
<span id="546"> 546</span>
<span id="547"> 547</span>
<span id="548"> 548</span>
<span id="549"> 549</span>
<span id="550"> 550</span>
<span id="551"> 551</span>
<span id="552"> 552</span>
<span id="553"> 553</span>
<span id="554"> 554</span>
<span id="555"> 555</span>
<span id="556"> 556</span>
<span id="557"> 557</span>
<span id="558"> 558</span>
<span id="559"> 559</span>
<span id="560"> 560</span>
<span id="561"> 561</span>
<span id="562"> 562</span>
<span id="563"> 563</span>
<span id="564"> 564</span>
<span id="565"> 565</span>
<span id="566"> 566</span>
<span id="567"> 567</span>
<span id="568"> 568</span>
<span id="569"> 569</span>
<span id="570"> 570</span>
<span id="571"> 571</span>
<span id="572"> 572</span>
<span id="573"> 573</span>
<span id="574"> 574</span>
<span id="575"> 575</span>
<span id="576"> 576</span>
<span id="577"> 577</span>
<span id="578"> 578</span>
<span id="579"> 579</span>
<span id="580"> 580</span>
<span id="581"> 581</span>
<span id="582"> 582</span>
<span id="583"> 583</span>
<span id="584"> 584</span>
<span id="585"> 585</span>
<span id="586"> 586</span>
<span id="587"> 587</span>
<span id="588"> 588</span>
<span id="589"> 589</span>
<span id="590"> 590</span>
<span id="591"> 591</span>
<span id="592"> 592</span>
<span id="593"> 593</span>
<span id="594"> 594</span>
<span id="595"> 595</span>
<span id="596"> 596</span>
<span id="597"> 597</span>
<span id="598"> 598</span>
<span id="599"> 599</span>
<span id="600"> 600</span>
<span id="601"> 601</span>
<span id="602"> 602</span>
<span id="603"> 603</span>
<span id="604"> 604</span>
<span id="605"> 605</span>
<span id="606"> 606</span>
<span id="607"> 607</span>
<span id="608"> 608</span>
<span id="609"> 609</span>
<span id="610"> 610</span>
<span id="611"> 611</span>
<span id="612"> 612</span>
<span id="613"> 613</span>
<span id="614"> 614</span>
<span id="615"> 615</span>
<span id="616"> 616</span>
<span id="617"> 617</span>
<span id="618"> 618</span>
<span id="619"> 619</span>
<span id="620"> 620</span>
<span id="621"> 621</span>
<span id="622"> 622</span>
<span id="623"> 623</span>
<span id="624"> 624</span>
<span id="625"> 625</span>
<span id="626"> 626</span>
<span id="627"> 627</span>
<span id="628"> 628</span>
<span id="629"> 629</span>
<span id="630"> 630</span>
<span id="631"> 631</span>
<span id="632"> 632</span>
<span id="633"> 633</span>
<span id="634"> 634</span>
<span id="635"> 635</span>
<span id="636"> 636</span>
<span id="637"> 637</span>
<span id="638"> 638</span>
<span id="639"> 639</span>
<span id="640"> 640</span>
<span id="641"> 641</span>
<span id="642"> 642</span>
<span id="643"> 643</span>
<span id="644"> 644</span>
<span id="645"> 645</span>
<span id="646"> 646</span>
<span id="647"> 647</span>
<span id="648"> 648</span>
<span id="649"> 649</span>
<span id="650"> 650</span>
<span id="651"> 651</span>
<span id="652"> 652</span>
<span id="653"> 653</span>
<span id="654"> 654</span>
<span id="655"> 655</span>
<span id="656"> 656</span>
<span id="657"> 657</span>
<span id="658"> 658</span>
<span id="659"> 659</span>
<span id="660"> 660</span>
<span id="661"> 661</span>
<span id="662"> 662</span>
<span id="663"> 663</span>
<span id="664"> 664</span>
<span id="665"> 665</span>
<span id="666"> 666</span>
<span id="667"> 667</span>
<span id="668"> 668</span>
<span id="669"> 669</span>
<span id="670"> 670</span>
<span id="671"> 671</span>
<span id="672"> 672</span>
<span id="673"> 673</span>
<span id="674"> 674</span>
<span id="675"> 675</span>
<span id="676"> 676</span>
<span id="677"> 677</span>
<span id="678"> 678</span>
<span id="679"> 679</span>
<span id="680"> 680</span>
<span id="681"> 681</span>
<span id="682"> 682</span>
<span id="683"> 683</span>
<span id="684"> 684</span>
<span id="685"> 685</span>
<span id="686"> 686</span>
<span id="687"> 687</span>
<span id="688"> 688</span>
<span id="689"> 689</span>
<span id="690"> 690</span>
<span id="691"> 691</span>
<span id="692"> 692</span>
<span id="693"> 693</span>
<span id="694"> 694</span>
<span id="695"> 695</span>
<span id="696"> 696</span>
<span id="697"> 697</span>
<span id="698"> 698</span>
<span id="699"> 699</span>
<span id="700"> 700</span>
<span id="701"> 701</span>
<span id="702"> 702</span>
<span id="703"> 703</span>
<span id="704"> 704</span>
<span id="705"> 705</span>
<span id="706"> 706</span>
<span id="707"> 707</span>
<span id="708"> 708</span>
<span id="709"> 709</span>
<span id="710"> 710</span>
<span id="711"> 711</span>
<span id="712"> 712</span>
<span id="713"> 713</span>
<span id="714"> 714</span>
<span id="715"> 715</span>
<span id="716"> 716</span>
<span id="717"> 717</span>
<span id="718"> 718</span>
<span id="719"> 719</span>
<span id="720"> 720</span>
<span id="721"> 721</span>
<span id="722"> 722</span>
<span id="723"> 723</span>
<span id="724"> 724</span>
<span id="725"> 725</span>
<span id="726"> 726</span>
<span id="727"> 727</span>
<span id="728"> 728</span>
<span id="729"> 729</span>
<span id="730"> 730</span>
<span id="731"> 731</span>
<span id="732"> 732</span>
<span id="733"> 733</span>
<span id="734"> 734</span>
<span id="735"> 735</span>
<span id="736"> 736</span>
<span id="737"> 737</span>
<span id="738"> 738</span>
<span id="739"> 739</span>
<span id="740"> 740</span>
<span id="741"> 741</span>
<span id="742"> 742</span>
<span id="743"> 743</span>
<span id="744"> 744</span>
<span id="745"> 745</span>
<span id="746"> 746</span>
<span id="747"> 747</span>
<span id="748"> 748</span>
<span id="749"> 749</span>
<span id="750"> 750</span>
<span id="751"> 751</span>
<span id="752"> 752</span>
<span id="753"> 753</span>
<span id="754"> 754</span>
<span id="755"> 755</span>
<span id="756"> 756</span>
<span id="757"> 757</span>
<span id="758"> 758</span>
<span id="759"> 759</span>
<span id="760"> 760</span>
<span id="761"> 761</span>
<span id="762"> 762</span>
<span id="763"> 763</span>
<span id="764"> 764</span>
<span id="765"> 765</span>
<span id="766"> 766</span>
<span id="767"> 767</span>
<span id="768"> 768</span>
<span id="769"> 769</span>
<span id="770"> 770</span>
<span id="771"> 771</span>
<span id="772"> 772</span>
<span id="773"> 773</span>
<span id="774"> 774</span>
<span id="775"> 775</span>
<span id="776"> 776</span>
<span id="777"> 777</span>
<span id="778"> 778</span>
<span id="779"> 779</span>
<span id="780"> 780</span>
<span id="781"> 781</span>
<span id="782"> 782</span>
<span id="783"> 783</span>
<span id="784"> 784</span>
<span id="785"> 785</span>
<span id="786"> 786</span>
<span id="787"> 787</span>
<span id="788"> 788</span>
<span id="789"> 789</span>
<span id="790"> 790</span>
<span id="791"> 791</span>
<span id="792"> 792</span>
<span id="793"> 793</span>
<span id="794"> 794</span>
<span id="795"> 795</span>
<span id="796"> 796</span>
<span id="797"> 797</span>
<span id="798"> 798</span>
<span id="799"> 799</span>
<span id="800"> 800</span>
<span id="801"> 801</span>
<span id="802"> 802</span>
<span id="803"> 803</span>
<span id="804"> 804</span>
<span id="805"> 805</span>
<span id="806"> 806</span>
<span id="807"> 807</span>
<span id="808"> 808</span>
<span id="809"> 809</span>
<span id="810"> 810</span>
<span id="811"> 811</span>
<span id="812"> 812</span>
<span id="813"> 813</span>
<span id="814"> 814</span>
<span id="815"> 815</span>
<span id="816"> 816</span>
<span id="817"> 817</span>
<span id="818"> 818</span>
<span id="819"> 819</span>
<span id="820"> 820</span>
<span id="821"> 821</span>
<span id="822"> 822</span>
<span id="823"> 823</span>
<span id="824"> 824</span>
<span id="825"> 825</span>
<span id="826"> 826</span>
<span id="827"> 827</span>
<span id="828"> 828</span>
<span id="829"> 829</span>
<span id="830"> 830</span>
<span id="831"> 831</span>
<span id="832"> 832</span>
<span id="833"> 833</span>
<span id="834"> 834</span>
<span id="835"> 835</span>
<span id="836"> 836</span>
<span id="837"> 837</span>
<span id="838"> 838</span>
<span id="839"> 839</span>
<span id="840"> 840</span>
<span id="841"> 841</span>
<span id="842"> 842</span>
<span id="843"> 843</span>
<span id="844"> 844</span>
<span id="845"> 845</span>
<span id="846"> 846</span>
<span id="847"> 847</span>
<span id="848"> 848</span>
<span id="849"> 849</span>
<span id="850"> 850</span>
<span id="851"> 851</span>
<span id="852"> 852</span>
<span id="853"> 853</span>
<span id="854"> 854</span>
<span id="855"> 855</span>
<span id="856"> 856</span>
<span id="857"> 857</span>
<span id="858"> 858</span>
<span id="859"> 859</span>
<span id="860"> 860</span>
<span id="861"> 861</span>
<span id="862"> 862</span>
<span id="863"> 863</span>
<span id="864"> 864</span>
<span id="865"> 865</span>
<span id="866"> 866</span>
<span id="867"> 867</span>
<span id="868"> 868</span>
<span id="869"> 869</span>
<span id="870"> 870</span>
<span id="871"> 871</span>
<span id="872"> 872</span>
<span id="873"> 873</span>
<span id="874"> 874</span>
<span id="875"> 875</span>
<span id="876"> 876</span>
<span id="877"> 877</span>
<span id="878"> 878</span>
<span id="879"> 879</span>
<span id="880"> 880</span>
<span id="881"> 881</span>
<span id="882"> 882</span>
<span id="883"> 883</span>
<span id="884"> 884</span>
<span id="885"> 885</span>
<span id="886"> 886</span>
<span id="887"> 887</span>
<span id="888"> 888</span>
<span id="889"> 889</span>
<span id="890"> 890</span>
<span id="891"> 891</span>
<span id="892"> 892</span>
<span id="893"> 893</span>
<span id="894"> 894</span>
<span id="895"> 895</span>
<span id="896"> 896</span>
<span id="897"> 897</span>
<span id="898"> 898</span>
<span id="899"> 899</span>
<span id="900"> 900</span>
<span id="901"> 901</span>
<span id="902"> 902</span>
<span id="903"> 903</span>
<span id="904"> 904</span>
<span id="905"> 905</span>
<span id="906"> 906</span>
<span id="907"> 907</span>
<span id="908"> 908</span>
<span id="909"> 909</span>
<span id="910"> 910</span>
<span id="911"> 911</span>
<span id="912"> 912</span>
<span id="913"> 913</span>
<span id="914"> 914</span>
<span id="915"> 915</span>
<span id="916"> 916</span>
<span id="917"> 917</span>
<span id="918"> 918</span>
<span id="919"> 919</span>
<span id="920"> 920</span>
<span id="921"> 921</span>
<span id="922"> 922</span>
<span id="923"> 923</span>
<span id="924"> 924</span>
<span id="925"> 925</span>
<span id="926"> 926</span>
<span id="927"> 927</span>
<span id="928"> 928</span>
<span id="929"> 929</span>
<span id="930"> 930</span>
<span id="931"> 931</span>
<span id="932"> 932</span>
<span id="933"> 933</span>
<span id="934"> 934</span>
<span id="935"> 935</span>
<span id="936"> 936</span>
<span id="937"> 937</span>
<span id="938"> 938</span>
<span id="939"> 939</span>
<span id="940"> 940</span>
<span id="941"> 941</span>
<span id="942"> 942</span>
<span id="943"> 943</span>
<span id="944"> 944</span>
<span id="945"> 945</span>
<span id="946"> 946</span>
<span id="947"> 947</span>
<span id="948"> 948</span>
<span id="949"> 949</span>
<span id="950"> 950</span>
<span id="951"> 951</span>
<span id="952"> 952</span>
<span id="953"> 953</span>
<span id="954"> 954</span>
<span id="955"> 955</span>
<span id="956"> 956</span>
<span id="957"> 957</span>
<span id="958"> 958</span>
<span id="959"> 959</span>
<span id="960"> 960</span>
<span id="961"> 961</span>
<span id="962"> 962</span>
<span id="963"> 963</span>
<span id="964"> 964</span>
<span id="965"> 965</span>
<span id="966"> 966</span>
<span id="967"> 967</span>
<span id="968"> 968</span>
<span id="969"> 969</span>
<span id="970"> 970</span>
<span id="971"> 971</span>
<span id="972"> 972</span>
<span id="973"> 973</span>
<span id="974"> 974</span>
<span id="975"> 975</span>
<span id="976"> 976</span>
<span id="977"> 977</span>
<span id="978"> 978</span>
<span id="979"> 979</span>
<span id="980"> 980</span>
<span id="981"> 981</span>
<span id="982"> 982</span>
<span id="983"> 983</span>
<span id="984"> 984</span>
<span id="985"> 985</span>
<span id="986"> 986</span>
<span id="987"> 987</span>
<span id="988"> 988</span>
<span id="989"> 989</span>
<span id="990"> 990</span>
<span id="991"> 991</span>
<span id="992"> 992</span>
<span id="993"> 993</span>
<span id="994"> 994</span>
<span id="995"> 995</span>
<span id="996"> 996</span>
<span id="997"> 997</span>
<span id="998"> 998</span>
<span id="999"> 999</span>
<span id="1000">1000</span>
<span id="1001">1001</span>
<span id="1002">1002</span>
<span id="1003">1003</span>
<span id="1004">1004</span>
<span id="1005">1005</span>
<span id="1006">1006</span>
<span id="1007">1007</span>
<span id="1008">1008</span>
<span id="1009">1009</span>
<span id="1010">1010</span>
<span id="1011">1011</span>
<span id="1012">1012</span>
<span id="1013">1013</span>
<span id="1014">1014</span>
<span id="1015">1015</span>
<span id="1016">1016</span>
<span id="1017">1017</span>
<span id="1018">1018</span>
<span id="1019">1019</span>
<span id="1020">1020</span>
<span id="1021">1021</span>
<span id="1022">1022</span>
<span id="1023">1023</span>
<span id="1024">1024</span>
<span id="1025">1025</span>
<span id="1026">1026</span>
<span id="1027">1027</span>
<span id="1028">1028</span>
<span id="1029">1029</span>
<span id="1030">1030</span>
<span id="1031">1031</span>
<span id="1032">1032</span>
<span id="1033">1033</span>
<span id="1034">1034</span>
<span id="1035">1035</span>
<span id="1036">1036</span>
<span id="1037">1037</span>
<span id="1038">1038</span>
<span id="1039">1039</span>
<span id="1040">1040</span>
<span id="1041">1041</span>
<span id="1042">1042</span>
<span id="1043">1043</span>
<span id="1044">1044</span>
<span id="1045">1045</span>
<span id="1046">1046</span>
</pre><pre class="rust ">
<span class="doccomment">//! Futures</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This module contains the `Future` trait and a number of adaptors for this</span>
<span class="doccomment">//! trait. See the crate docs, and the docs for `Future`, for full detail.</span>

<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">fmt</span>;
<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">result</span>;

<span class="comment">// Primitive futures</span>
<span class="kw">mod</span> <span class="ident">empty</span>;
<span class="kw">mod</span> <span class="ident">lazy</span>;
<span class="kw">mod</span> <span class="ident">poll_fn</span>;
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">&quot;result.rs&quot;</span>]</span>
<span class="kw">mod</span> <span class="ident">result_</span>;
<span class="kw">mod</span> <span class="ident">loop_fn</span>;
<span class="kw">mod</span> <span class="ident">option</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">empty</span>::{<span class="ident">empty</span>, <span class="ident">Empty</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">lazy</span>::{<span class="ident">lazy</span>, <span class="ident">Lazy</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">poll_fn</span>::{<span class="ident">poll_fn</span>, <span class="ident">PollFn</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">result_</span>::{<span class="ident">result</span>, <span class="ident">ok</span>, <span class="ident">err</span>, <span class="ident">FutureResult</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">loop_fn</span>::{<span class="ident">loop_fn</span>, <span class="ident">Loop</span>, <span class="ident">LoopFn</span>};

<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;0.1.4&quot;</span>, <span class="ident">note</span> <span class="op">=</span> <span class="string">&quot;use `ok` instead&quot;</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;with-deprecated&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::{<span class="ident">ok</span> <span class="kw">as</span> <span class="ident">finished</span>, <span class="prelude-val">Ok</span> <span class="kw">as</span> <span class="ident">Finished</span>};
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;0.1.4&quot;</span>, <span class="ident">note</span> <span class="op">=</span> <span class="string">&quot;use `err` instead&quot;</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;with-deprecated&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::{<span class="ident">err</span> <span class="kw">as</span> <span class="ident">failed</span>, <span class="prelude-val">Err</span> <span class="kw">as</span> <span class="ident">Failed</span>};
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;0.1.4&quot;</span>, <span class="ident">note</span> <span class="op">=</span> <span class="string">&quot;use `result` instead&quot;</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;with-deprecated&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::{<span class="ident">result</span> <span class="kw">as</span> <span class="ident">done</span>, <span class="ident">FutureResult</span> <span class="kw">as</span> <span class="ident">Done</span>};
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;0.1.7&quot;</span>, <span class="ident">note</span> <span class="op">=</span> <span class="string">&quot;use `FutureResult` instead&quot;</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;with-deprecated&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::{<span class="ident">FutureResult</span> <span class="kw">as</span> <span class="prelude-val">Ok</span>};
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;0.1.7&quot;</span>, <span class="ident">note</span> <span class="op">=</span> <span class="string">&quot;use `FutureResult` instead&quot;</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;with-deprecated&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::{<span class="ident">FutureResult</span> <span class="kw">as</span> <span class="prelude-val">Err</span>};

<span class="comment">// combinators</span>
<span class="kw">mod</span> <span class="ident">and_then</span>;
<span class="kw">mod</span> <span class="ident">flatten</span>;
<span class="kw">mod</span> <span class="ident">flatten_stream</span>;
<span class="kw">mod</span> <span class="ident">fuse</span>;
<span class="kw">mod</span> <span class="ident">into_stream</span>;
<span class="kw">mod</span> <span class="ident">join</span>;
<span class="kw">mod</span> <span class="ident">map</span>;
<span class="kw">mod</span> <span class="ident">map_err</span>;
<span class="kw">mod</span> <span class="ident">from_err</span>;
<span class="kw">mod</span> <span class="ident">or_else</span>;
<span class="kw">mod</span> <span class="ident">select</span>;
<span class="kw">mod</span> <span class="ident">select2</span>;
<span class="kw">mod</span> <span class="ident">then</span>;
<span class="kw">mod</span> <span class="ident">either</span>;

<span class="comment">// impl details</span>
<span class="kw">mod</span> <span class="ident">chain</span>;

<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">and_then</span>::<span class="ident">AndThen</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">flatten</span>::<span class="ident">Flatten</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">flatten_stream</span>::<span class="ident">FlattenStream</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">fuse</span>::<span class="ident">Fuse</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">into_stream</span>::<span class="ident">IntoStream</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">join</span>::{<span class="ident">Join</span>, <span class="ident">Join3</span>, <span class="ident">Join4</span>, <span class="ident">Join5</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">map</span>::<span class="ident">Map</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">map_err</span>::<span class="ident">MapErr</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">from_err</span>::<span class="ident">FromErr</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">or_else</span>::<span class="ident">OrElse</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">select</span>::{<span class="ident">Select</span>, <span class="ident">SelectNext</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">select2</span>::<span class="ident">Select2</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">then</span>::<span class="ident">Then</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">either</span>::<span class="ident">Either</span>;

<span class="macro">if_std</span><span class="macro">!</span> {
    <span class="kw">mod</span> <span class="ident">catch_unwind</span>;
    <span class="kw">mod</span> <span class="ident">join_all</span>;
    <span class="kw">mod</span> <span class="ident">select_all</span>;
    <span class="kw">mod</span> <span class="ident">select_ok</span>;
    <span class="kw">mod</span> <span class="ident">shared</span>;
    <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">catch_unwind</span>::<span class="ident">CatchUnwind</span>;
    <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">join_all</span>::{<span class="ident">join_all</span>, <span class="ident">JoinAll</span>};
    <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">select_all</span>::{<span class="ident">SelectAll</span>, <span class="ident">SelectAllNext</span>, <span class="ident">select_all</span>};
    <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">select_ok</span>::{<span class="ident">SelectOk</span>, <span class="ident">select_ok</span>};
    <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">shared</span>::{<span class="ident">Shared</span>, <span class="ident">SharedItem</span>, <span class="ident">SharedError</span>};

    <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
    <span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;0.1.4&quot;</span>, <span class="ident">note</span> <span class="op">=</span> <span class="string">&quot;use join_all instead&quot;</span>)]</span>
    <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;with-deprecated&quot;</span>)]</span>
    <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">join_all</span>::<span class="ident">join_all</span> <span class="kw">as</span> <span class="ident">collect</span>;
    <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
    <span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">since</span> <span class="op">=</span> <span class="string">&quot;0.1.4&quot;</span>, <span class="ident">note</span> <span class="op">=</span> <span class="string">&quot;use JoinAll instead&quot;</span>)]</span>
    <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;with-deprecated&quot;</span>)]</span>
    <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">join_all</span>::<span class="ident">JoinAll</span> <span class="kw">as</span> <span class="ident">Collect</span>;

    <span class="doccomment">/// A type alias for `Box&lt;Future + Send&gt;`</span>
    <span class="kw">pub</span> <span class="kw">type</span> <span class="ident">BoxFuture</span><span class="op">&lt;</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">&gt;</span> <span class="op">=</span> ::<span class="ident">std</span>::<span class="ident">boxed</span>::<span class="ident">Box</span><span class="op">&lt;</span><span class="ident">Future</span><span class="op">&lt;</span><span class="ident">Item</span> <span class="op">=</span> <span class="ident">T</span>, <span class="ident">Error</span> <span class="op">=</span> <span class="ident">E</span><span class="op">&gt;</span> <span class="op">+</span> <span class="ident">Send</span><span class="op">&gt;</span>;

    <span class="kw">impl</span><span class="op">&lt;</span><span class="ident">F</span>: <span class="question-mark">?</span><span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Future</span><span class="op">&gt;</span> <span class="ident">Future</span> <span class="kw">for</span> ::<span class="ident">std</span>::<span class="ident">boxed</span>::<span class="ident">Box</span><span class="op">&lt;</span><span class="ident">F</span><span class="op">&gt;</span> {
        <span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">F</span>::<span class="ident">Item</span>;
        <span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">F</span>::<span class="ident">Error</span>;

        <span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Poll</span><span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
            (<span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span>).<span class="ident">poll</span>()
        }
    }
}

<span class="kw">use</span> {<span class="ident">Poll</span>, <span class="ident">stream</span>};

<span class="doccomment">/// Trait for types which are a placeholder of a value that may become</span>
<span class="doccomment">/// available at some later point in time.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// In addition to the documentation here you can also find more information</span>
<span class="doccomment">/// about futures [online] at [https://tokio.rs](https://tokio.rs)</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [online]: https://tokio.rs/docs/getting-started/futures/</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Futures are used to provide a sentinel through which a value can be</span>
<span class="doccomment">/// referenced. They crucially allow chaining and composing operations through</span>
<span class="doccomment">/// consumption which allows expressing entire trees of computation as one</span>
<span class="doccomment">/// sentinel value.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The ergonomics and implementation of the `Future` trait are very similar to</span>
<span class="doccomment">/// the `Iterator` trait in that there is just one methods you need</span>
<span class="doccomment">/// to implement, but you get a whole lot of others for free as a result.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # The `poll` method</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The core method of future, `poll`, is used to attempt to generate the value</span>
<span class="doccomment">/// of a `Future`. This method *does not block* but is allowed to inform the</span>
<span class="doccomment">/// caller that the value is not ready yet. Implementations of `poll` may</span>
<span class="doccomment">/// themselves do work to generate the value, but it&#39;s guaranteed that this will</span>
<span class="doccomment">/// never block the calling thread.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A key aspect of this method is that if the value is not yet available the</span>
<span class="doccomment">/// current task is scheduled to receive a notification when it&#39;s later ready to</span>
<span class="doccomment">/// be made available. This follows what&#39;s typically known as a &quot;readiness&quot; or</span>
<span class="doccomment">/// &quot;pull&quot; model where values are pulled out of futures on demand, and</span>
<span class="doccomment">/// otherwise a task is notified when a value might be ready to get pulled out.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The `poll` method is not intended to be called in general, but rather is</span>
<span class="doccomment">/// typically called in the context of a &quot;task&quot; which drives a future to</span>
<span class="doccomment">/// completion. For more information on this see the `task` module.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// More information about the details of `poll` and the nitty-gritty of tasks</span>
<span class="doccomment">/// can be [found online at tokio.rs][poll-dox].</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [poll-dox]: https://tokio.rs/docs/going-deeper-futures/futures-model/</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Combinators</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Like iterators, futures provide a large number of combinators to work with</span>
<span class="doccomment">/// futures to express computations in a much more natural method than</span>
<span class="doccomment">/// scheduling a number of callbacks. For example the `map` method can change</span>
<span class="doccomment">/// a `Future&lt;Item=T&gt;` to a `Future&lt;Item=U&gt;` or an `and_then` combinator could</span>
<span class="doccomment">/// create a future after the first one is done and only be resolved when the</span>
<span class="doccomment">/// second is done.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Combinators act very similarly to the methods on the `Iterator` trait itself</span>
<span class="doccomment">/// or those on `Option` and `Result`. Like with iterators, the combinators are</span>
<span class="doccomment">/// zero-cost and don&#39;t impose any extra layers of indirection you wouldn&#39;t</span>
<span class="doccomment">/// otherwise have to write down.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// More information about combinators can be found [on tokio.rs].</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [on tokio.rs]: https://tokio.rs/docs/going-deeper-futures/futures-mechanics/</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Future</span> {
    <span class="doccomment">/// The type of value that this future will resolved with if it is</span>
    <span class="doccomment">/// successful.</span>
    <span class="kw">type</span> <span class="ident">Item</span>;

    <span class="doccomment">/// The type of error that this future will resolve with if it fails in a</span>
    <span class="doccomment">/// normal fashion.</span>
    <span class="kw">type</span> <span class="ident">Error</span>;

    <span class="doccomment">/// Query this future to see if its value has become available, registering</span>
    <span class="doccomment">/// interest if it is not.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function will check the internal state of the future and assess</span>
    <span class="doccomment">/// whether the value is ready to be produced. Implementors of this function</span>
    <span class="doccomment">/// should ensure that a call to this **never blocks** as event loops may</span>
    <span class="doccomment">/// not work properly otherwise.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// When a future is not ready yet, the `Async::NotReady` value will be</span>
    <span class="doccomment">/// returned. In this situation the future will *also* register interest of</span>
    <span class="doccomment">/// the current task in the value being produced. This is done by calling</span>
    <span class="doccomment">/// `task::park` to retrieve a handle to the current `Task`. When the future</span>
    <span class="doccomment">/// is then ready to make progress (e.g. it should be `poll`ed again) the</span>
    <span class="doccomment">/// `unpark` method is called on the `Task`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// More information about the details of `poll` and the nitty-gritty of</span>
    <span class="doccomment">/// tasks can be [found online at tokio.rs][poll-dox].</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// [poll-dox]: https://tokio.rs/docs/going-deeper-futures/futures-model/</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Runtime characteristics</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function, `poll`, is the primary method for &#39;making progress&#39;</span>
    <span class="doccomment">/// within a tree of futures. For example this method will be called</span>
    <span class="doccomment">/// repeatedly as the internal state machine makes its various transitions.</span>
    <span class="doccomment">/// Executors are responsible for ensuring that this function is called in</span>
    <span class="doccomment">/// the right location (e.g. always on an I/O thread or not). Unless it is</span>
    <span class="doccomment">/// otherwise arranged to be so, it should be ensured that **implementations</span>
    <span class="doccomment">/// of this function finish very quickly**.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Returning quickly prevents unnecessarily clogging up threads and/or</span>
    <span class="doccomment">/// event loops while a `poll` function call, for example, takes up compute</span>
    <span class="doccomment">/// resources to perform some expensive computation. If it is known ahead</span>
    <span class="doccomment">/// of time that a call to `poll` may end up taking awhile, the work should</span>
    <span class="doccomment">/// be offloaded to a thread pool (or something similar) to ensure that</span>
    <span class="doccomment">/// `poll` can return quickly.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that the `poll` function is not called repeatedly in a loop for</span>
    <span class="doccomment">/// futures typically, but only whenever the future itself is ready. If</span>
    <span class="doccomment">/// you&#39;re familiar with the `poll(2)` or `select(2)` syscalls on Unix</span>
    <span class="doccomment">/// it&#39;s worth noting that futures typically do *not* suffer the same</span>
    <span class="doccomment">/// problems of &quot;all wakeups must poll all events&quot;. Futures have enough</span>
    <span class="doccomment">/// support for only polling futures which cause a wakeup.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Return value</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function returns `Async::NotReady` if the future is not ready yet,</span>
    <span class="doccomment">/// `Err` if the future is finished but resolved to an error, or</span>
    <span class="doccomment">/// `Async::Ready` with the result of this future if it&#39;s finished</span>
    <span class="doccomment">/// successfully. Once a future has finished it is considered a contract</span>
    <span class="doccomment">/// error to continue polling the future.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// If `NotReady` is returned, then the future will internally register</span>
    <span class="doccomment">/// interest in the value being produced for the current task (through</span>
    <span class="doccomment">/// `task::park`). In other words, the current task will receive a</span>
    <span class="doccomment">/// notification (through the `unpark` method) once the value is ready to be</span>
    <span class="doccomment">/// produced or the future can make progress.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Panics</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Once a future has completed (returned `Ready` or `Err` from `poll`),</span>
    <span class="doccomment">/// then any future calls to `poll` may panic, block forever, or otherwise</span>
    <span class="doccomment">/// cause wrong behavior. The `Future` trait itself provides no guarantees</span>
    <span class="doccomment">/// about the behavior of `poll` after a future has completed.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Callers who may call `poll` too many times may want to consider using</span>
    <span class="doccomment">/// the `fuse` adaptor which defines the behavior of `poll`, but comes with</span>
    <span class="doccomment">/// a little bit of extra cost.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Additionally, calls to `poll` must always be made from within the</span>
    <span class="doccomment">/// context of a task. If a current task is not set then this method will</span>
    <span class="doccomment">/// likely panic.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Errors</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This future may have failed to finish the computation, in which case</span>
    <span class="doccomment">/// the `Err` variant will be returned with an appropriate payload of an</span>
    <span class="doccomment">/// error.</span>
    <span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Poll</span><span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>;

    <span class="doccomment">/// Block the current thread until this future is resolved.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This method will consume ownership of this future, driving it to</span>
    <span class="doccomment">/// completion via `poll` and blocking the current thread while it&#39;s waiting</span>
    <span class="doccomment">/// for the value to become available. Once the future is resolved the</span>
    <span class="doccomment">/// result of this future is returned.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// &gt; **Note:** This method is not appropriate to call on event loops or</span>
    <span class="doccomment">/// &gt;           similar I/O situations because it will prevent the event</span>
    <span class="doccomment">/// &gt;           loop from making progress (this blocks the thread). This</span>
    <span class="doccomment">/// &gt;           method should only be called when it&#39;s guaranteed that the</span>
    <span class="doccomment">/// &gt;           blocking work associated with this future will be completed</span>
    <span class="doccomment">/// &gt;           by another thread.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
    <span class="doccomment">/// library is activated, and it is activated by default.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Panics</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function does not attempt to catch panics. If the `poll` function</span>
    <span class="doccomment">/// of this future panics, panics will be propagated to the caller.</span>
    <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;use_std&quot;</span>)]</span>
    <span class="kw">fn</span> <span class="ident">wait</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">result</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
    {
        ::<span class="ident">executor</span>::<span class="ident">spawn</span>(<span class="self">self</span>).<span class="ident">wait_future</span>()
    }

    <span class="doccomment">/// Convenience function for turning this future into a trait object which</span>
    <span class="doccomment">/// is also `Send`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This simply avoids the need to write `Box::new` and can often help with</span>
    <span class="doccomment">/// type inference as well by always returning a trait object. Note that</span>
    <span class="doccomment">/// this method requires the `Send` bound and returns a `BoxFuture`, which</span>
    <span class="doccomment">/// also encodes this. If you&#39;d like to create a `Box&lt;Future&gt;` without the</span>
    <span class="doccomment">/// `Send` bound, then the `Box::new` function can be used instead.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
    <span class="doccomment">/// library is activated, and it is activated by default.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let a: BoxFuture&lt;i32, i32&gt; = result(Ok(1)).boxed();</span>
    <span class="doccomment">/// ```</span>
    <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;use_std&quot;</span>)]</span>
    <span class="kw">fn</span> <span class="ident">boxed</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">BoxFuture</span><span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="lifetime">&#39;static</span>
    {
        ::<span class="ident">std</span>::<span class="ident">boxed</span>::<span class="ident">Box</span>::<span class="ident">new</span>(<span class="self">self</span>)
    }

    <span class="doccomment">/// Map this future&#39;s result to a different type, returning a new future of</span>
    <span class="doccomment">/// the resulting type.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function is similar to the `Option::map` or `Iterator::map` where</span>
    <span class="doccomment">/// it will change the type of the underlying future. This is useful to</span>
    <span class="doccomment">/// chain along a computation once a future has been resolved.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// The closure provided will only be called if this future is resolved</span>
    <span class="doccomment">/// successfully. If this future returns an error, panics, or is dropped,</span>
    <span class="doccomment">/// then the closure provided will never be invoked.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes the receiving future and returns a</span>
    <span class="doccomment">/// wrapped version of it, similar to the existing `map` methods in the</span>
    <span class="doccomment">/// standard library.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future_of_1 = ok::&lt;u32, u32&gt;(1);</span>
    <span class="doccomment">/// let future_of_4 = future_of_1.map(|x| x + 3);</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">map</span><span class="op">&lt;</span><span class="ident">F</span>, <span class="ident">U</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-&gt;</span> <span class="ident">Map</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">F</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="self">Self</span>::<span class="ident">Item</span>) <span class="op">-&gt;</span> <span class="ident">U</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="ident">assert_future</span>::<span class="op">&lt;</span><span class="ident">U</span>, <span class="self">Self</span>::<span class="ident">Error</span>, _<span class="op">&gt;</span>(<span class="ident">map</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>))
    }

    <span class="doccomment">/// Map this future&#39;s error to a different error, returning a new future.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function is similar to the `Result::map_err` where it will change</span>
    <span class="doccomment">/// the error type of the underlying future. This is useful for example to</span>
    <span class="doccomment">/// ensure that futures have the same error type when used with combinators</span>
    <span class="doccomment">/// like `select` and `join`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// The closure provided will only be called if this future is resolved</span>
    <span class="doccomment">/// with an error. If this future returns a success, panics, or is</span>
    <span class="doccomment">/// dropped, then the closure provided will never be invoked.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes the receiving future and returns a</span>
    <span class="doccomment">/// wrapped version of it.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future_of_err_1 = err::&lt;u32, u32&gt;(1);</span>
    <span class="doccomment">/// let future_of_err_4 = future_of_err_1.map_err(|x| x + 3);</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">map_err</span><span class="op">&lt;</span><span class="ident">F</span>, <span class="ident">E</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-&gt;</span> <span class="ident">MapErr</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">F</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="self">Self</span>::<span class="ident">Error</span>) <span class="op">-&gt;</span> <span class="ident">E</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="ident">assert_future</span>::<span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="ident">E</span>, _<span class="op">&gt;</span>(<span class="ident">map_err</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>))
    }



    <span class="doccomment">/// Map this future&#39;s error to any error implementing `From` for</span>
    <span class="doccomment">/// this future&#39;s `Error`, returning a new future.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function does for futures what `try!` does for `Result`,</span>
    <span class="doccomment">/// by letting the compiler infer the type of the resulting error.</span>
    <span class="doccomment">/// Just as `map_err` above, this is useful for example to ensure</span>
    <span class="doccomment">/// that futures have the same error type when used with</span>
    <span class="doccomment">/// combinators like `select` and `join`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes the receiving future and returns a</span>
    <span class="doccomment">/// wrapped version of it.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future_with_err_u8 = err::&lt;(), u8&gt;(1);</span>
    <span class="doccomment">/// let future_with_err_u32 = future_with_err_u8.from_err::&lt;u32&gt;();</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">from_err</span><span class="op">&lt;</span><span class="ident">E</span>:<span class="ident">From</span><span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;&gt;</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">FromErr</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">E</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="ident">assert_future</span>::<span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="ident">E</span>, _<span class="op">&gt;</span>(<span class="ident">from_err</span>::<span class="ident">new</span>(<span class="self">self</span>))
    }

    <span class="doccomment">/// Chain on a computation for when a future finished, passing the result of</span>
    <span class="doccomment">/// the future to the provided closure `f`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function can be used to ensure a computation runs regardless of</span>
    <span class="doccomment">/// the conclusion of the future. The closure provided will be yielded a</span>
    <span class="doccomment">/// `Result` once the future is complete.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// The returned value of the closure must implement the `IntoFuture` trait</span>
    <span class="doccomment">/// and can represent some more work to be done before the composed future</span>
    <span class="doccomment">/// is finished. Note that the `Result` type implements the `IntoFuture`</span>
    <span class="doccomment">/// trait so it is possible to simply alter the `Result` yielded to the</span>
    <span class="doccomment">/// closure and return it.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// If this future is dropped or panics then the closure `f` will not be</span>
    <span class="doccomment">/// run.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes the receiving future and returns a</span>
    <span class="doccomment">/// wrapped version of it.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future_of_1 = ok::&lt;u32, u32&gt;(1);</span>
    <span class="doccomment">/// let future_of_4 = future_of_1.then(|x| {</span>
    <span class="doccomment">///     x.map(|y| y + 3)</span>
    <span class="doccomment">/// });</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future_of_err_1 = err::&lt;u32, u32&gt;(1);</span>
    <span class="doccomment">/// let future_of_4 = future_of_err_1.then(|x| {</span>
    <span class="doccomment">///     match x {</span>
    <span class="doccomment">///         Ok(_) =&gt; panic!(&quot;expected an error&quot;),</span>
    <span class="doccomment">///         Err(y) =&gt; ok::&lt;u32, u32&gt;(y + 3),</span>
    <span class="doccomment">///     }</span>
    <span class="doccomment">/// });</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">then</span><span class="op">&lt;</span><span class="ident">F</span>, <span class="ident">B</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-&gt;</span> <span class="ident">Then</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>, <span class="ident">F</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="ident">result</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>) <span class="op">-&gt;</span> <span class="ident">B</span>,
              <span class="ident">B</span>: <span class="ident">IntoFuture</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="ident">assert_future</span>::<span class="op">&lt;</span><span class="ident">B</span>::<span class="ident">Item</span>, <span class="ident">B</span>::<span class="ident">Error</span>, _<span class="op">&gt;</span>(<span class="ident">then</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>))
    }

    <span class="doccomment">/// Execute another future after this one has resolved successfully.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function can be used to chain two futures together and ensure that</span>
    <span class="doccomment">/// the final future isn&#39;t resolved until both have finished. The closure</span>
    <span class="doccomment">/// provided is yielded the successful result of this future and returns</span>
    <span class="doccomment">/// another value which can be converted into a future.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that because `Result` implements the `IntoFuture` trait this method</span>
    <span class="doccomment">/// can also be useful for chaining fallible and serial computations onto</span>
    <span class="doccomment">/// the end of one future.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// If this future is dropped, panics, or completes with an error then the</span>
    <span class="doccomment">/// provided closure `f` is never called.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes the receiving future and returns a</span>
    <span class="doccomment">/// wrapped version of it.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future_of_1 = ok::&lt;u32, u32&gt;(1);</span>
    <span class="doccomment">/// let future_of_4 = future_of_1.and_then(|x| {</span>
    <span class="doccomment">///     Ok(x + 3)</span>
    <span class="doccomment">/// });</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future_of_err_1 = err::&lt;u32, u32&gt;(1);</span>
    <span class="doccomment">/// future_of_err_1.and_then(|_| -&gt; FutureResult&lt;u32, u32&gt; {</span>
    <span class="doccomment">///     panic!(&quot;should not be called in case of an error&quot;);</span>
    <span class="doccomment">/// });</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">and_then</span><span class="op">&lt;</span><span class="ident">F</span>, <span class="ident">B</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-&gt;</span> <span class="ident">AndThen</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>, <span class="ident">F</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="self">Self</span>::<span class="ident">Item</span>) <span class="op">-&gt;</span> <span class="ident">B</span>,
              <span class="ident">B</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="ident">assert_future</span>::<span class="op">&lt;</span><span class="ident">B</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span>, _<span class="op">&gt;</span>(<span class="ident">and_then</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>))
    }

    <span class="doccomment">/// Execute another future if this one resolves with an error.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Return a future that passes along this future&#39;s value if it succeeds,</span>
    <span class="doccomment">/// and otherwise passes the error to the closure `f` and waits for the</span>
    <span class="doccomment">/// future it returns. The closure may also simply return a value that can</span>
    <span class="doccomment">/// be converted into a future.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that because `Result` implements the `IntoFuture` trait this method</span>
    <span class="doccomment">/// can also be useful for chaining together fallback computations, where</span>
    <span class="doccomment">/// when one fails, the next is attempted.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// If this future is dropped, panics, or completes successfully then the</span>
    <span class="doccomment">/// provided closure `f` is never called.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes the receiving future and returns a</span>
    <span class="doccomment">/// wrapped version of it.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future_of_err_1 = err::&lt;u32, u32&gt;(1);</span>
    <span class="doccomment">/// let future_of_4 = future_of_err_1.or_else(|x| -&gt; Result&lt;u32, u32&gt; {</span>
    <span class="doccomment">///     Ok(x + 3)</span>
    <span class="doccomment">/// });</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future_of_1 = ok::&lt;u32, u32&gt;(1);</span>
    <span class="doccomment">/// future_of_1.or_else(|_| -&gt; FutureResult&lt;u32, u32&gt; {</span>
    <span class="doccomment">///     panic!(&quot;should not be called in case of success&quot;);</span>
    <span class="doccomment">/// });</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">or_else</span><span class="op">&lt;</span><span class="ident">F</span>, <span class="ident">B</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-&gt;</span> <span class="ident">OrElse</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>, <span class="ident">F</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="self">Self</span>::<span class="ident">Error</span>) <span class="op">-&gt;</span> <span class="ident">B</span>,
              <span class="ident">B</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Item</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Item</span><span class="op">&gt;</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="ident">assert_future</span>::<span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="ident">B</span>::<span class="ident">Error</span>, _<span class="op">&gt;</span>(<span class="ident">or_else</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>))
    }

    <span class="doccomment">/// Waits for either one of two futures to complete.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function will return a new future which awaits for either this or</span>
    <span class="doccomment">/// the `other` future to complete. The returned future will finish with</span>
    <span class="doccomment">/// both the value resolved and a future representing the completion of the</span>
    <span class="doccomment">/// other work. Both futures must have the same item and error type.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes the receiving futures and returns a</span>
    <span class="doccomment">/// wrapped version of them.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// // A poor-man&#39;s join implemented on top of select</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// fn join&lt;A&gt;(a: A, b: A) -&gt; BoxFuture&lt;(u32, u32), u32&gt;</span>
    <span class="doccomment">///     where A: Future&lt;Item = u32, Error = u32&gt; + Send + &#39;static,</span>
    <span class="doccomment">/// {</span>
    <span class="doccomment">///     a.select(b).then(|res| {</span>
    <span class="doccomment">///         match res {</span>
    <span class="doccomment">///             Ok((a, b)) =&gt; b.map(move |b| (a, b)).boxed(),</span>
    <span class="doccomment">///             Err((a, _)) =&gt; err(a).boxed(),</span>
    <span class="doccomment">///         }</span>
    <span class="doccomment">///     }).boxed()</span>
    <span class="doccomment">/// }</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">select</span><span class="op">&lt;</span><span class="ident">B</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">other</span>: <span class="ident">B</span>) <span class="op">-&gt;</span> <span class="ident">Select</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>::<span class="ident">Future</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">B</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Item</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">select</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">other</span>.<span class="ident">into_future</span>());
        <span class="ident">assert_future</span>::<span class="op">&lt;</span>(<span class="self">Self</span>::<span class="ident">Item</span>, <span class="ident">SelectNext</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>::<span class="ident">Future</span><span class="op">&gt;</span>),
                        (<span class="self">Self</span>::<span class="ident">Error</span>, <span class="ident">SelectNext</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>::<span class="ident">Future</span><span class="op">&gt;</span>), _<span class="op">&gt;</span>(<span class="ident">f</span>)
    }

    <span class="doccomment">/// Waits for either one of two differently-typed futures to complete.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function will return a new future which awaits for either this or</span>
    <span class="doccomment">/// the `other` future to complete. The returned future will finish with</span>
    <span class="doccomment">/// both the value resolved and a future representing the completion of the</span>
    <span class="doccomment">/// other work.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes the receiving futures and returns a</span>
    <span class="doccomment">/// wrapped version of them.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Also note that if both this and the second future have the same</span>
    <span class="doccomment">/// success/error type you can use the `Either::split` method to</span>
    <span class="doccomment">/// conveniently extract out the value at the end.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// // A poor-man&#39;s join implemented on top of select2</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// fn join&lt;A, B, E&gt;(a: A, b: B) -&gt; BoxFuture&lt;(A::Item, B::Item), E&gt;</span>
    <span class="doccomment">///     where A: Future&lt;Error = E&gt; + Send + &#39;static,</span>
    <span class="doccomment">///           B: Future&lt;Error = E&gt; + Send + &#39;static,</span>
    <span class="doccomment">///           A::Item: Send, B::Item: Send, E: Send + &#39;static,</span>
    <span class="doccomment">/// {</span>
    <span class="doccomment">///     a.select2(b).then(|res| {</span>
    <span class="doccomment">///         match res {</span>
    <span class="doccomment">///             Ok(Either::A((x, b))) =&gt; b.map(move |y| (x, y)).boxed(),</span>
    <span class="doccomment">///             Ok(Either::B((y, a))) =&gt; a.map(move |x| (x, y)).boxed(),</span>
    <span class="doccomment">///             Err(Either::A((e, _))) =&gt; err(e).boxed(),</span>
    <span class="doccomment">///             Err(Either::B((e, _))) =&gt; err(e).boxed(),</span>
    <span class="doccomment">///         }</span>
    <span class="doccomment">///     }).boxed()</span>
    <span class="doccomment">/// }</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">select2</span><span class="op">&lt;</span><span class="ident">B</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">other</span>: <span class="ident">B</span>) <span class="op">-&gt;</span> <span class="ident">Select2</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>::<span class="ident">Future</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">B</span>: <span class="ident">IntoFuture</span>, <span class="self">Self</span>: <span class="ident">Sized</span>
    {
        <span class="ident">select2</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">other</span>.<span class="ident">into_future</span>())
    }

    <span class="doccomment">/// Joins the result of two futures, waiting for them both to complete.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function will return a new future which awaits both this and the</span>
    <span class="doccomment">/// `other` future to complete. The returned future will finish with a tuple</span>
    <span class="doccomment">/// of both results.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Both futures must have the same error type, and if either finishes with</span>
    <span class="doccomment">/// an error then the other will be dropped and that error will be</span>
    <span class="doccomment">/// returned.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes the receiving future and returns a</span>
    <span class="doccomment">/// wrapped version of it.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let a = ok::&lt;u32, u32&gt;(1);</span>
    <span class="doccomment">/// let b = ok::&lt;u32, u32&gt;(2);</span>
    <span class="doccomment">/// let pair = a.join(b);</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// pair.map(|(a, b)| {</span>
    <span class="doccomment">///     assert_eq!(a, 1);</span>
    <span class="doccomment">///     assert_eq!(b, 2);</span>
    <span class="doccomment">/// });</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">join</span><span class="op">&lt;</span><span class="ident">B</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">other</span>: <span class="ident">B</span>) <span class="op">-&gt;</span> <span class="ident">Join</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>::<span class="ident">Future</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">B</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">join</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">other</span>.<span class="ident">into_future</span>());
        <span class="ident">assert_future</span>::<span class="op">&lt;</span>(<span class="self">Self</span>::<span class="ident">Item</span>, <span class="ident">B</span>::<span class="ident">Item</span>), <span class="self">Self</span>::<span class="ident">Error</span>, _<span class="op">&gt;</span>(<span class="ident">f</span>)
    }

    <span class="doccomment">/// Same as `join`, but with more futures.</span>
    <span class="kw">fn</span> <span class="ident">join3</span><span class="op">&lt;</span><span class="ident">B</span>, <span class="ident">C</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">b</span>: <span class="ident">B</span>, <span class="ident">c</span>: <span class="ident">C</span>) <span class="op">-&gt;</span> <span class="ident">Join3</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>::<span class="ident">Future</span>, <span class="ident">C</span>::<span class="ident">Future</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">B</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="ident">C</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="ident">join</span>::<span class="ident">new3</span>(<span class="self">self</span>, <span class="ident">b</span>.<span class="ident">into_future</span>(), <span class="ident">c</span>.<span class="ident">into_future</span>())
    }

    <span class="doccomment">/// Same as `join`, but with more futures.</span>
    <span class="kw">fn</span> <span class="ident">join4</span><span class="op">&lt;</span><span class="ident">B</span>, <span class="ident">C</span>, <span class="ident">D</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">b</span>: <span class="ident">B</span>, <span class="ident">c</span>: <span class="ident">C</span>, <span class="ident">d</span>: <span class="ident">D</span>)
                      <span class="op">-&gt;</span> <span class="ident">Join4</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>::<span class="ident">Future</span>, <span class="ident">C</span>::<span class="ident">Future</span>, <span class="ident">D</span>::<span class="ident">Future</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">B</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="ident">C</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="ident">D</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="ident">join</span>::<span class="ident">new4</span>(<span class="self">self</span>, <span class="ident">b</span>.<span class="ident">into_future</span>(), <span class="ident">c</span>.<span class="ident">into_future</span>(), <span class="ident">d</span>.<span class="ident">into_future</span>())
    }

    <span class="doccomment">/// Same as `join`, but with more futures.</span>
    <span class="kw">fn</span> <span class="ident">join5</span><span class="op">&lt;</span><span class="ident">B</span>, <span class="ident">C</span>, <span class="ident">D</span>, <span class="ident">E</span><span class="op">&gt;</span>(<span class="self">self</span>, <span class="ident">b</span>: <span class="ident">B</span>, <span class="ident">c</span>: <span class="ident">C</span>, <span class="ident">d</span>: <span class="ident">D</span>, <span class="ident">e</span>: <span class="ident">E</span>)
                         <span class="op">-&gt;</span> <span class="ident">Join5</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">B</span>::<span class="ident">Future</span>, <span class="ident">C</span>::<span class="ident">Future</span>, <span class="ident">D</span>::<span class="ident">Future</span>, <span class="ident">E</span>::<span class="ident">Future</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="ident">B</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="ident">C</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="ident">D</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="ident">E</span>: <span class="ident">IntoFuture</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>,
    {
        <span class="ident">join</span>::<span class="ident">new5</span>(<span class="self">self</span>, <span class="ident">b</span>.<span class="ident">into_future</span>(), <span class="ident">c</span>.<span class="ident">into_future</span>(), <span class="ident">d</span>.<span class="ident">into_future</span>(),
                   <span class="ident">e</span>.<span class="ident">into_future</span>())
    }

    <span class="doccomment">/// Convert this future into a single element stream.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// The returned stream contains single success if this future resolves to</span>
    <span class="doccomment">/// success or single error if this future resolves into error.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::{Stream, Async};</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future = ok::&lt;_, bool&gt;(17);</span>
    <span class="doccomment">/// let mut stream = future.into_stream();</span>
    <span class="doccomment">/// assert_eq!(Ok(Async::Ready(Some(17))), stream.poll());</span>
    <span class="doccomment">/// assert_eq!(Ok(Async::Ready(None)), stream.poll());</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future = err::&lt;bool, _&gt;(19);</span>
    <span class="doccomment">/// let mut stream = future.into_stream();</span>
    <span class="doccomment">/// assert_eq!(Err(19), stream.poll());</span>
    <span class="doccomment">/// assert_eq!(Ok(Async::Ready(None)), stream.poll());</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">into_stream</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">IntoStream</span><span class="op">&lt;</span><span class="self">Self</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
    {
        <span class="ident">into_stream</span>::<span class="ident">new</span>(<span class="self">self</span>)
    }

    <span class="doccomment">/// Flatten the execution of this future when the successful result of this</span>
    <span class="doccomment">/// future is itself another future.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This can be useful when combining futures together to flatten the</span>
    <span class="doccomment">/// computation out the the final result. This method can only be called</span>
    <span class="doccomment">/// when the successful result of this future itself implements the</span>
    <span class="doccomment">/// `IntoFuture` trait and the error can be created from this future&#39;s error</span>
    <span class="doccomment">/// type.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This method is roughly equivalent to `self.and_then(|x| x)`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes the receiving future and returns a</span>
    <span class="doccomment">/// wrapped version of it.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future_of_a_future = ok::&lt;_, u32&gt;(ok::&lt;u32, u32&gt;(1));</span>
    <span class="doccomment">/// let future_of_1 = future_of_a_future.flatten();</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">flatten</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Flatten</span><span class="op">&lt;</span><span class="self">Self</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="self">Self</span>::<span class="ident">Item</span>: <span class="ident">IntoFuture</span>,
        <span class="op">&lt;&lt;</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">Future</span><span class="op">&gt;</span>::<span class="ident">Item</span> <span class="kw">as</span> <span class="ident">IntoFuture</span><span class="op">&gt;</span>::<span class="ident">Error</span>:
            <span class="ident">From</span><span class="op">&lt;&lt;</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">Future</span><span class="op">&gt;</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
        <span class="self">Self</span>: <span class="ident">Sized</span>
    {
        <span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">flatten</span>::<span class="ident">new</span>(<span class="self">self</span>);
        <span class="ident">assert_future</span>::<span class="op">&lt;&lt;</span><span class="op">&lt;</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">Future</span><span class="op">&gt;</span>::<span class="ident">Item</span> <span class="kw">as</span> <span class="ident">IntoFuture</span><span class="op">&gt;</span>::<span class="ident">Item</span>,
                        <span class="op">&lt;&lt;</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">Future</span><span class="op">&gt;</span>::<span class="ident">Item</span> <span class="kw">as</span> <span class="ident">IntoFuture</span><span class="op">&gt;</span>::<span class="ident">Error</span>,
                        _<span class="op">&gt;</span>(<span class="ident">f</span>)
    }

    <span class="doccomment">/// Flatten the execution of this future when the successful result of this</span>
    <span class="doccomment">/// future is a stream.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This can be useful when stream initialization is deferred, and it is</span>
    <span class="doccomment">/// convenient to work with that stream as if stream was available at the</span>
    <span class="doccomment">/// call site.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this function consumes this future and returns a wrapped</span>
    <span class="doccomment">/// version of it.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::stream::{self, Stream};</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let stream_items = vec![Ok(17), Err(true), Ok(19)];</span>
    <span class="doccomment">/// let future_of_a_stream = ok::&lt;_, bool&gt;(stream::iter(stream_items));</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let stream = future_of_a_stream.flatten_stream();</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let mut iter = stream.wait();</span>
    <span class="doccomment">/// assert_eq!(Ok(17), iter.next().unwrap());</span>
    <span class="doccomment">/// assert_eq!(Err(true), iter.next().unwrap());</span>
    <span class="doccomment">/// assert_eq!(Ok(19), iter.next().unwrap());</span>
    <span class="doccomment">/// assert_eq!(None, iter.next());</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">flatten_stream</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">FlattenStream</span><span class="op">&lt;</span><span class="self">Self</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="op">&lt;</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">Future</span><span class="op">&gt;</span>::<span class="ident">Item</span>: <span class="ident">stream</span>::<span class="ident">Stream</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>,
              <span class="self">Self</span>: <span class="ident">Sized</span>
    {
        <span class="ident">flatten_stream</span>::<span class="ident">new</span>(<span class="self">self</span>)
    }

    <span class="doccomment">/// Fuse a future such that `poll` will never again be called once it has</span>
    <span class="doccomment">/// completed.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Currently once a future has returned `Ready` or `Err` from</span>
    <span class="doccomment">/// `poll` any further calls could exhibit bad behavior such as blocking</span>
    <span class="doccomment">/// forever, panicking, never returning, etc. If it is known that `poll`</span>
    <span class="doccomment">/// may be called too often then this method can be used to ensure that it</span>
    <span class="doccomment">/// has defined semantics.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Once a future has been `fuse`d and it returns a completion from `poll`,</span>
    <span class="doccomment">/// then it will forever return `NotReady` from `poll` again (never</span>
    <span class="doccomment">/// resolve).  This, unlike the trait&#39;s `poll` method, is guaranteed.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This combinator will drop this future as soon as it&#39;s been completed to</span>
    <span class="doccomment">/// ensure resources are reclaimed as soon as possible.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```rust</span>
    <span class="doccomment">/// use futures::Async;</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let mut future = ok::&lt;i32, u32&gt;(2);</span>
    <span class="doccomment">/// assert_eq!(future.poll(), Ok(Async::Ready(2)));</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// // Normally, a call such as this would panic:</span>
    <span class="doccomment">/// //future.poll();</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// // This, however, is guaranteed to not panic</span>
    <span class="doccomment">/// let mut future = ok::&lt;i32, u32&gt;(2).fuse();</span>
    <span class="doccomment">/// assert_eq!(future.poll(), Ok(Async::Ready(2)));</span>
    <span class="doccomment">/// assert_eq!(future.poll(), Ok(Async::NotReady));</span>
    <span class="doccomment">/// ```</span>
    <span class="kw">fn</span> <span class="ident">fuse</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Fuse</span><span class="op">&lt;</span><span class="self">Self</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
    {
        <span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">fuse</span>::<span class="ident">new</span>(<span class="self">self</span>);
        <span class="ident">assert_future</span>::<span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span>, _<span class="op">&gt;</span>(<span class="ident">f</span>)
    }

    <span class="doccomment">/// Catches unwinding panics while polling the future.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// In general, panics within a future can propagate all the way out to the</span>
    <span class="doccomment">/// task level. This combinator makes it possible to halt unwinding within</span>
    <span class="doccomment">/// the future itself. It&#39;s most commonly used within task executors. It&#39;s</span>
    <span class="doccomment">/// not recommended to use this for error handling.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Note that this method requires the `UnwindSafe` bound from the standard</span>
    <span class="doccomment">/// library. This isn&#39;t always applied automatically, and the standard</span>
    <span class="doccomment">/// library provides an `AssertUnwindSafe` wrapper type to apply it</span>
    <span class="doccomment">/// after-the fact. To assist using this method, the `Future` trait is also</span>
    <span class="doccomment">/// implemented for `AssertUnwindSafe&lt;F&gt;` where `F` implements `Future`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
    <span class="doccomment">/// library is activated, and it is activated by default.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```rust</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let mut future = ok::&lt;i32, u32&gt;(2);</span>
    <span class="doccomment">/// assert!(future.catch_unwind().wait().is_ok());</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let mut future = lazy(|| -&gt; FutureResult&lt;i32, u32&gt; {</span>
    <span class="doccomment">///     panic!();</span>
    <span class="doccomment">///     ok::&lt;i32, u32&gt;(2)</span>
    <span class="doccomment">/// });</span>
    <span class="doccomment">/// assert!(future.catch_unwind().wait().is_err());</span>
    <span class="doccomment">/// ```</span>
    <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;use_std&quot;</span>)]</span>
    <span class="kw">fn</span> <span class="ident">catch_unwind</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">CatchUnwind</span><span class="op">&lt;</span><span class="self">Self</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span> <span class="op">+</span> ::<span class="ident">std</span>::<span class="ident">panic</span>::<span class="ident">UnwindSafe</span>
    {
        <span class="ident">catch_unwind</span>::<span class="ident">new</span>(<span class="self">self</span>)
    }

    <span class="doccomment">/// Create a cloneable handle to this future where all handles will resolve</span>
    <span class="doccomment">/// to the same result.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// The shared() method provides a mean to convert any future into a</span>
    <span class="doccomment">/// cloneable future. It enables a future to be polled by multiple threads.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// The returned `Shared` future resolves successfully with</span>
    <span class="doccomment">/// `SharedItem&lt;Self::Item&gt;` or erroneously with `SharedError&lt;Self::Error&gt;`.</span>
    <span class="doccomment">/// Both `SharedItem` and `SharedError` implements `Deref` to allow shared</span>
    <span class="doccomment">/// access to the underlying result. Ownership of `Self::Item` and</span>
    <span class="doccomment">/// `Self::Error` cannot currently be reclaimed.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
    <span class="doccomment">/// library is activated, and it is activated by default.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Examples</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future = ok::&lt;_, bool&gt;(6);</span>
    <span class="doccomment">/// let shared1 = future.shared();</span>
    <span class="doccomment">/// let shared2 = shared1.clone();</span>
    <span class="doccomment">/// assert_eq!(6, *shared1.wait().unwrap());</span>
    <span class="doccomment">/// assert_eq!(6, *shared2.wait().unwrap());</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ```</span>
    <span class="doccomment">/// use std::thread;</span>
    <span class="doccomment">/// use futures::future::*;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// let future = ok::&lt;_, bool&gt;(6);</span>
    <span class="doccomment">/// let shared1 = future.shared();</span>
    <span class="doccomment">/// let shared2 = shared1.clone();</span>
    <span class="doccomment">/// let join_handle = thread::spawn(move || {</span>
    <span class="doccomment">///     assert_eq!(6, *shared2.wait().unwrap());</span>
    <span class="doccomment">/// });</span>
    <span class="doccomment">/// assert_eq!(6, *shared1.wait().unwrap());</span>
    <span class="doccomment">/// join_handle.join().unwrap();</span>
    <span class="doccomment">/// ```</span>
    <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;use_std&quot;</span>)]</span>
    <span class="kw">fn</span> <span class="ident">shared</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Shared</span><span class="op">&lt;</span><span class="self">Self</span><span class="op">&gt;</span>
        <span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
    {
        <span class="ident">shared</span>::<span class="ident">new</span>(<span class="self">self</span>)
    }
}

<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span>, <span class="ident">F</span>: <span class="question-mark">?</span><span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Future</span><span class="op">&gt;</span> <span class="ident">Future</span> <span class="kw">for</span> <span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="kw-2">mut</span> <span class="ident">F</span> {
    <span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">F</span>::<span class="ident">Item</span>;
    <span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">F</span>::<span class="ident">Error</span>;

    <span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Poll</span><span class="op">&lt;</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
        (<span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span>).<span class="ident">poll</span>()
    }
}

<span class="comment">// Just a helper function to ensure the futures we&#39;re returning all have the</span>
<span class="comment">// right implementations.</span>
<span class="kw">fn</span> <span class="ident">assert_future</span><span class="op">&lt;</span><span class="ident">A</span>, <span class="ident">B</span>, <span class="ident">F</span><span class="op">&gt;</span>(<span class="ident">t</span>: <span class="ident">F</span>) <span class="op">-&gt;</span> <span class="ident">F</span>
    <span class="kw">where</span> <span class="ident">F</span>: <span class="ident">Future</span><span class="op">&lt;</span><span class="ident">Item</span><span class="op">=</span><span class="ident">A</span>, <span class="ident">Error</span><span class="op">=</span><span class="ident">B</span><span class="op">&gt;</span>,
{
    <span class="ident">t</span>
}

<span class="doccomment">/// Class of types which can be converted into a future.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This trait is very similar to the `IntoIterator` trait and is intended to be</span>
<span class="doccomment">/// used in a very similar fashion.</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">IntoFuture</span> {
    <span class="doccomment">/// The future that this type can be converted into.</span>
    <span class="kw">type</span> <span class="ident">Future</span>: <span class="ident">Future</span><span class="op">&lt;</span><span class="ident">Item</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>;

    <span class="doccomment">/// The item that the future may resolve with.</span>
    <span class="kw">type</span> <span class="ident">Item</span>;
    <span class="doccomment">/// The error that the future may resolve with.</span>
    <span class="kw">type</span> <span class="ident">Error</span>;

    <span class="doccomment">/// Consumes this object and produces a future.</span>
    <span class="kw">fn</span> <span class="ident">into_future</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="self">Self</span>::<span class="ident">Future</span>;
}

<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">F</span>: <span class="ident">Future</span><span class="op">&gt;</span> <span class="ident">IntoFuture</span> <span class="kw">for</span> <span class="ident">F</span> {
    <span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">F</span>;
    <span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">F</span>::<span class="ident">Item</span>;
    <span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">F</span>::<span class="ident">Error</span>;

    <span class="kw">fn</span> <span class="ident">into_future</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">F</span> {
        <span class="self">self</span>
    }
}

<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">&gt;</span> <span class="ident">IntoFuture</span> <span class="kw">for</span> <span class="ident">result</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">&gt;</span> {
    <span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">FutureResult</span><span class="op">&lt;</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">&gt;</span>;
    <span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">T</span>;
    <span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">E</span>;

    <span class="kw">fn</span> <span class="ident">into_future</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">FutureResult</span><span class="op">&lt;</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">&gt;</span> {
        <span class="ident">result</span>(<span class="self">self</span>)
    }
}

<span class="doccomment">/// Asynchronous conversion from a type `T`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This trait is analogous to `std::convert::From`, adapted to asynchronous</span>
<span class="doccomment">/// computation.</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">FutureFrom</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>: <span class="ident">Sized</span> {
    <span class="doccomment">/// The future for the conversion.</span>
    <span class="kw">type</span> <span class="ident">Future</span>: <span class="ident">Future</span><span class="op">&lt;</span><span class="ident">Item</span><span class="op">=</span><span class="self">Self</span>, <span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">&gt;</span>;

    <span class="doccomment">/// Possible errors during conversion.</span>
    <span class="kw">type</span> <span class="ident">Error</span>;

    <span class="doccomment">/// Consume the given value, beginning the conversion.</span>
    <span class="kw">fn</span> <span class="ident">future_from</span>(<span class="ident">T</span>) <span class="op">-&gt;</span> <span class="self">Self</span>::<span class="ident">Future</span>;
}

<span class="doccomment">/// A trait for types which can spawn fresh futures.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This trait is typically implemented for &quot;executors&quot;, or those types which</span>
<span class="doccomment">/// can execute futures to completion. Futures passed to `Spawn::spawn`</span>
<span class="doccomment">/// typically get turned into a *task* and are then driven to completion.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On spawn, the executor takes ownership of the future and becomes responsible</span>
<span class="doccomment">/// to call `Future::poll()` whenever a readiness notification is raised.</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Executor</span><span class="op">&lt;</span><span class="ident">F</span>: <span class="ident">Future</span><span class="op">&lt;</span><span class="ident">Item</span> <span class="op">=</span> (), <span class="ident">Error</span> <span class="op">=</span> ()<span class="op">&gt;&gt;</span> {
    <span class="doccomment">/// Spawns a future to run on this `Executor`, typically in the</span>
    <span class="doccomment">/// &quot;background&quot;.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This function will return immediately, and schedule the future `future`</span>
    <span class="doccomment">/// to run on `self`. The details of scheduling and execution are left to</span>
    <span class="doccomment">/// the implementations of `Executor`, but this is typically a primary point</span>
    <span class="doccomment">/// for injecting concurrency in a futures-based system. Futures spawned</span>
    <span class="doccomment">/// through this `execute` function tend to run concurrently while they&#39;re</span>
    <span class="doccomment">/// waiting on events.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Errors</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Implementors of this trait are allowed to reject accepting this future</span>
    <span class="doccomment">/// as well. This can happen for various reason such as:</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// * The executor is shut down</span>
    <span class="doccomment">/// * The executor has run out of capacity to execute futures</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// The decision is left to the caller how to work with this form of error.</span>
    <span class="doccomment">/// The error returned transfers ownership of the future back to the caller.</span>
    <span class="kw">fn</span> <span class="ident">execute</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">future</span>: <span class="ident">F</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>(), <span class="ident">ExecuteError</span><span class="op">&lt;</span><span class="ident">F</span><span class="op">&gt;&gt;</span>;
}

<span class="doccomment">/// Errors returned from the `Spawn::spawn` function.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ExecuteError</span><span class="op">&lt;</span><span class="ident">F</span><span class="op">&gt;</span> {
    <span class="ident">future</span>: <span class="ident">F</span>,
    <span class="ident">kind</span>: <span class="ident">ExecuteErrorKind</span>,
}

<span class="doccomment">/// Kinds of errors that can be returned from the `Execute::spawn` function.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Executors which may not always be able to accept a future may return one of</span>
<span class="doccomment">/// these errors, indicating why it was unable to spawn a future.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">PartialEq</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ExecuteErrorKind</span> {
    <span class="doccomment">/// This executor has shut down and will no longer accept new futures to</span>
    <span class="doccomment">/// spawn.</span>
    <span class="ident">Shutdown</span>,

    <span class="doccomment">/// This executor has no more capacity to run more futures. Other futures</span>
    <span class="doccomment">/// need to finish before this executor can accept another.</span>
    <span class="ident">NoCapacity</span>,

    <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
    <span class="ident">__Nonexhaustive</span>,
}

<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">F</span><span class="op">&gt;</span> <span class="ident">ExecuteError</span><span class="op">&lt;</span><span class="ident">F</span><span class="op">&gt;</span> {
    <span class="doccomment">/// Create a new `ExecuteError`</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">kind</span>: <span class="ident">ExecuteErrorKind</span>, <span class="ident">future</span>: <span class="ident">F</span>) <span class="op">-&gt;</span> <span class="ident">ExecuteError</span><span class="op">&lt;</span><span class="ident">F</span><span class="op">&gt;</span> {
        <span class="ident">ExecuteError</span> {
            <span class="ident">future</span>: <span class="ident">future</span>,
            <span class="ident">kind</span>: <span class="ident">kind</span>,
        }
    }

    <span class="doccomment">/// Returns the associated reason for the error</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">kind</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">ExecuteErrorKind</span> {
        <span class="self">self</span>.<span class="ident">kind</span>
    }

    <span class="doccomment">/// Consumes self and returns the original future that was spawned.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_future</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">F</span> {
        <span class="self">self</span>.<span class="ident">future</span>
    }
}

<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">F</span><span class="op">&gt;</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">ExecuteError</span><span class="op">&lt;</span><span class="ident">F</span><span class="op">&gt;</span> {
    <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-&gt;</span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
        <span class="kw">match</span> <span class="self">self</span>.<span class="ident">kind</span> {
            <span class="ident">ExecuteErrorKind</span>::<span class="ident">Shutdown</span> <span class="op">=&gt;</span> <span class="string">&quot;executor has shut down&quot;</span>.<span class="ident">fmt</span>(<span class="ident">f</span>),
            <span class="ident">ExecuteErrorKind</span>::<span class="ident">NoCapacity</span> <span class="op">=&gt;</span> <span class="string">&quot;executor has no more capacity&quot;</span>.<span class="ident">fmt</span>(<span class="ident">f</span>),
            <span class="ident">ExecuteErrorKind</span>::<span class="ident">__Nonexhaustive</span> <span class="op">=&gt;</span> <span class="macro">panic</span><span class="macro">!</span>(),
        }
    }
}
</pre>
</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>?</dt>
                    <dd>Show this help dialog</dd>
                    <dt>S</dt>
                    <dd>Focus the search field</dd>
                    <dt>&larrb;</dt>
                    <dd>Move up in search results</dd>
                    <dt>&rarrb;</dt>
                    <dd>Move down in search results</dd>
                    <dt>&#9166;</dt>
                    <dd>Go to active search result</dd>
                    <dt>+</dt>
                    <dd>Collapse/expand 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 = "futures";
    </script>
    <script src="../../../jquery.js"></script>
    <script src="../../../main.js"></script>
    <script defer src="../../../search-index.js"></script>
</body>
</html>