index.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512
  1. <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `stream` mod in crate `futures`."><meta name="keywords" content="rust, rustlang, rust-lang, stream"><title>futures::stream - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><p class='location'>Module stream</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>futures</a></p><script>window.sidebarCurrent = {name: 'stream', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>futures</a>::<wbr><a class="mod" href=''>stream</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/futures/stream/mod.rs.html#1-1145' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Asynchronous streams</p>
  2. <p>This module contains the <code>Stream</code> trait and a number of adaptors for this
  3. trait. This trait is very similar to the <code>Iterator</code> trait in the standard
  4. library except that it expresses the concept of blocking as well. A stream
  5. here is a sequential sequence of values which may take some amount of time
  6. in between to produce.</p>
  7. <p>A stream may request that it is blocked between values while the next value
  8. is calculated, and provides a way to get notified once the next value is
  9. ready as well.</p>
  10. <p>You can find more information/tutorials about streams <a href="https://tokio.rs/docs/getting-started/streams-and-sinks/">online at
  11. https://tokio.rs</a></p>
  12. </div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
  13. <table><tr><td><code>pub use self::futures_unordered::<a class="struct" href="../../futures/stream/futures_unordered/struct.FuturesUnordered.html" title="struct futures::stream::futures_unordered::FuturesUnordered">FuturesUnordered</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
  14. <table>
  15. <tr class=' module-item'>
  16. <td><a class="mod" href="futures_unordered/index.html"
  17. title='mod futures::stream::futures_unordered'>futures_unordered</a></td>
  18. <td class='docblock-short'>
  19. <p>An unbounded set of futures.</p>
  20. </td>
  21. </tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
  22. <table>
  23. <tr class=' module-item'>
  24. <td><a class="struct" href="struct.AndThen.html"
  25. title='struct futures::stream::AndThen'>AndThen</a></td>
  26. <td class='docblock-short'>
  27. <p>A stream combinator which chains a computation onto values produced by a
  28. stream.</p>
  29. </td>
  30. </tr>
  31. <tr class=' module-item'>
  32. <td><a class="struct" href="struct.BufferUnordered.html"
  33. title='struct futures::stream::BufferUnordered'>BufferUnordered</a></td>
  34. <td class='docblock-short'>
  35. <p>An adaptor for a stream of futures to execute the futures concurrently, if
  36. possible, delivering results as they become available.</p>
  37. </td>
  38. </tr>
  39. <tr class=' module-item'>
  40. <td><a class="struct" href="struct.Buffered.html"
  41. title='struct futures::stream::Buffered'>Buffered</a></td>
  42. <td class='docblock-short'>
  43. <p>An adaptor for a stream of futures to execute the futures concurrently, if
  44. possible.</p>
  45. </td>
  46. </tr>
  47. <tr class=' module-item'>
  48. <td><a class="struct" href="struct.CatchUnwind.html"
  49. title='struct futures::stream::CatchUnwind'>CatchUnwind</a></td>
  50. <td class='docblock-short'>
  51. <p>Stream for the <code>catch_unwind</code> combinator.</p>
  52. </td>
  53. </tr>
  54. <tr class=' module-item'>
  55. <td><a class="struct" href="struct.Chain.html"
  56. title='struct futures::stream::Chain'>Chain</a></td>
  57. <td class='docblock-short'>
  58. <p>An adapter for chaining the output of two streams.</p>
  59. </td>
  60. </tr>
  61. <tr class=' module-item'>
  62. <td><a class="struct" href="struct.Chunks.html"
  63. title='struct futures::stream::Chunks'>Chunks</a></td>
  64. <td class='docblock-short'>
  65. <p>An adaptor that chunks up elements in a vector.</p>
  66. </td>
  67. </tr>
  68. <tr class=' module-item'>
  69. <td><a class="struct" href="struct.Collect.html"
  70. title='struct futures::stream::Collect'>Collect</a></td>
  71. <td class='docblock-short'>
  72. <p>A future which collects all of the values of a stream into a vector.</p>
  73. </td>
  74. </tr>
  75. <tr class=' module-item'>
  76. <td><a class="struct" href="struct.Concat.html"
  77. title='struct futures::stream::Concat'>Concat</a></td>
  78. <td class='docblock-short'>
  79. [<div class='stab deprecated'>Deprecated</div>] <p>A stream combinator to concatenate the results of a stream into the first
  80. yielded item.</p>
  81. </td>
  82. </tr>
  83. <tr class=' module-item'>
  84. <td><a class="struct" href="struct.Concat2.html"
  85. title='struct futures::stream::Concat2'>Concat2</a></td>
  86. <td class='docblock-short'>
  87. <p>A stream combinator to concatenate the results of a stream into the first
  88. yielded item.</p>
  89. </td>
  90. </tr>
  91. <tr class=' module-item'>
  92. <td><a class="struct" href="struct.Empty.html"
  93. title='struct futures::stream::Empty'>Empty</a></td>
  94. <td class='docblock-short'>
  95. <p>A stream which contains no elements.</p>
  96. </td>
  97. </tr>
  98. <tr class=' module-item'>
  99. <td><a class="struct" href="struct.Filter.html"
  100. title='struct futures::stream::Filter'>Filter</a></td>
  101. <td class='docblock-short'>
  102. <p>A stream combinator used to filter the results of a stream and only yield
  103. some values.</p>
  104. </td>
  105. </tr>
  106. <tr class=' module-item'>
  107. <td><a class="struct" href="struct.FilterMap.html"
  108. title='struct futures::stream::FilterMap'>FilterMap</a></td>
  109. <td class='docblock-short'>
  110. <p>A combinator used to filter the results of a stream and simultaneously map
  111. them to a different type.</p>
  112. </td>
  113. </tr>
  114. <tr class=' module-item'>
  115. <td><a class="struct" href="struct.Flatten.html"
  116. title='struct futures::stream::Flatten'>Flatten</a></td>
  117. <td class='docblock-short'>
  118. <p>A combinator used to flatten a stream-of-streams into one long stream of
  119. elements.</p>
  120. </td>
  121. </tr>
  122. <tr class=' module-item'>
  123. <td><a class="struct" href="struct.Fold.html"
  124. title='struct futures::stream::Fold'>Fold</a></td>
  125. <td class='docblock-short'>
  126. <p>A future used to collect all the results of a stream into one generic type.</p>
  127. </td>
  128. </tr>
  129. <tr class=' module-item'>
  130. <td><a class="struct" href="struct.ForEach.html"
  131. title='struct futures::stream::ForEach'>ForEach</a></td>
  132. <td class='docblock-short'>
  133. <p>A stream combinator which executes a unit closure over each item on a
  134. stream.</p>
  135. </td>
  136. </tr>
  137. <tr class=' module-item'>
  138. <td><a class="struct" href="struct.Forward.html"
  139. title='struct futures::stream::Forward'>Forward</a></td>
  140. <td class='docblock-short'>
  141. <p>Future for the <code>Stream::forward</code> combinator, which sends a stream of values
  142. to a sink and then waits until the sink has fully flushed those values.</p>
  143. </td>
  144. </tr>
  145. <tr class=' module-item'>
  146. <td><a class="struct" href="struct.FromErr.html"
  147. title='struct futures::stream::FromErr'>FromErr</a></td>
  148. <td class='docblock-short'>
  149. <p>A stream combinator to change the error type of a stream.</p>
  150. </td>
  151. </tr>
  152. <tr class=' module-item'>
  153. <td><a class="struct" href="struct.Fuse.html"
  154. title='struct futures::stream::Fuse'>Fuse</a></td>
  155. <td class='docblock-short'>
  156. <p>A stream which &quot;fuse&quot;s a stream once it's terminated.</p>
  157. </td>
  158. </tr>
  159. <tr class=' module-item'>
  160. <td><a class="struct" href="struct.FuturesOrdered.html"
  161. title='struct futures::stream::FuturesOrdered'>FuturesOrdered</a></td>
  162. <td class='docblock-short'>
  163. <p>An unbounded queue of futures.</p>
  164. </td>
  165. </tr>
  166. <tr class=' module-item'>
  167. <td><a class="struct" href="struct.Inspect.html"
  168. title='struct futures::stream::Inspect'>Inspect</a></td>
  169. <td class='docblock-short'>
  170. <p>Do something with the items of a stream, passing it on.</p>
  171. </td>
  172. </tr>
  173. <tr class=' module-item'>
  174. <td><a class="struct" href="struct.InspectErr.html"
  175. title='struct futures::stream::InspectErr'>InspectErr</a></td>
  176. <td class='docblock-short'>
  177. <p>Do something with the error of a stream, passing it on.</p>
  178. </td>
  179. </tr>
  180. <tr class=' module-item'>
  181. <td><a class="struct" href="struct.Iter.html"
  182. title='struct futures::stream::Iter'>Iter</a></td>
  183. <td class='docblock-short'>
  184. [<div class='stab deprecated'>Deprecated</div>] <p>A stream which is just a shim over an underlying instance of <code>Iterator</code>.</p>
  185. </td>
  186. </tr>
  187. <tr class=' module-item'>
  188. <td><a class="struct" href="struct.IterOk.html"
  189. title='struct futures::stream::IterOk'>IterOk</a></td>
  190. <td class='docblock-short'>
  191. <p>A stream which is just a shim over an underlying instance of <code>Iterator</code>.</p>
  192. </td>
  193. </tr>
  194. <tr class=' module-item'>
  195. <td><a class="struct" href="struct.IterResult.html"
  196. title='struct futures::stream::IterResult'>IterResult</a></td>
  197. <td class='docblock-short'>
  198. <p>A stream which is just a shim over an underlying instance of <code>Iterator</code>.</p>
  199. </td>
  200. </tr>
  201. <tr class=' module-item'>
  202. <td><a class="struct" href="struct.IterStream.html"
  203. title='struct futures::stream::IterStream'>IterStream</a></td>
  204. <td class='docblock-short'>
  205. [<div class='stab deprecated'>Deprecated</div>] <p>A stream which is just a shim over an underlying instance of <code>Iterator</code>.</p>
  206. </td>
  207. </tr>
  208. <tr class=' module-item'>
  209. <td><a class="struct" href="struct.Map.html"
  210. title='struct futures::stream::Map'>Map</a></td>
  211. <td class='docblock-short'>
  212. <p>A stream combinator which will change the type of a stream from one
  213. type to another.</p>
  214. </td>
  215. </tr>
  216. <tr class=' module-item'>
  217. <td><a class="struct" href="struct.MapErr.html"
  218. title='struct futures::stream::MapErr'>MapErr</a></td>
  219. <td class='docblock-short'>
  220. <p>A stream combinator which will change the error type of a stream from one
  221. type to another.</p>
  222. </td>
  223. </tr>
  224. <tr class=' module-item'>
  225. <td><a class="struct" href="struct.Merge.html"
  226. title='struct futures::stream::Merge'>Merge</a></td>
  227. <td class='docblock-short'>
  228. [<div class='stab deprecated'>Deprecated</div>] <p>An adapter for merging the output of two streams.</p>
  229. </td>
  230. </tr>
  231. <tr class=' module-item'>
  232. <td><a class="struct" href="struct.Once.html"
  233. title='struct futures::stream::Once'>Once</a></td>
  234. <td class='docblock-short'>
  235. <p>A stream which emits single element and then EOF.</p>
  236. </td>
  237. </tr>
  238. <tr class=' module-item'>
  239. <td><a class="struct" href="struct.OrElse.html"
  240. title='struct futures::stream::OrElse'>OrElse</a></td>
  241. <td class='docblock-short'>
  242. <p>A stream combinator which chains a computation onto errors produced by a
  243. stream.</p>
  244. </td>
  245. </tr>
  246. <tr class=' module-item'>
  247. <td><a class="struct" href="struct.Peekable.html"
  248. title='struct futures::stream::Peekable'>Peekable</a></td>
  249. <td class='docblock-short'>
  250. <p>A <code>Stream</code> that implements a <code>peek</code> method.</p>
  251. </td>
  252. </tr>
  253. <tr class=' module-item'>
  254. <td><a class="struct" href="struct.PollFn.html"
  255. title='struct futures::stream::PollFn'>PollFn</a></td>
  256. <td class='docblock-short'>
  257. <p>A stream which adapts a function returning <code>Poll</code>.</p>
  258. </td>
  259. </tr>
  260. <tr class=' module-item'>
  261. <td><a class="struct" href="struct.Repeat.html"
  262. title='struct futures::stream::Repeat'>Repeat</a></td>
  263. <td class='docblock-short'>
  264. <p>Stream that produces the same element repeatedly.</p>
  265. </td>
  266. </tr>
  267. <tr class=' module-item'>
  268. <td><a class="struct" href="struct.ReuniteError.html"
  269. title='struct futures::stream::ReuniteError'>ReuniteError</a></td>
  270. <td class='docblock-short'>
  271. <p>Error indicating a <code>SplitSink&lt;S&gt;</code> and <code>SplitStream&lt;S&gt;</code> were not two halves
  272. of a <code>Stream + Split</code>, and thus could not be <code>reunite</code>d.</p>
  273. </td>
  274. </tr>
  275. <tr class=' module-item'>
  276. <td><a class="struct" href="struct.Select.html"
  277. title='struct futures::stream::Select'>Select</a></td>
  278. <td class='docblock-short'>
  279. <p>An adapter for merging the output of two streams.</p>
  280. </td>
  281. </tr>
  282. <tr class=' module-item'>
  283. <td><a class="struct" href="struct.Skip.html"
  284. title='struct futures::stream::Skip'>Skip</a></td>
  285. <td class='docblock-short'>
  286. <p>A stream combinator which skips a number of elements before continuing.</p>
  287. </td>
  288. </tr>
  289. <tr class=' module-item'>
  290. <td><a class="struct" href="struct.SkipWhile.html"
  291. title='struct futures::stream::SkipWhile'>SkipWhile</a></td>
  292. <td class='docblock-short'>
  293. <p>A stream combinator which skips elements of a stream while a predicate
  294. holds.</p>
  295. </td>
  296. </tr>
  297. <tr class=' module-item'>
  298. <td><a class="struct" href="struct.SplitSink.html"
  299. title='struct futures::stream::SplitSink'>SplitSink</a></td>
  300. <td class='docblock-short'>
  301. <p>A <code>Sink</code> part of the split pair</p>
  302. </td>
  303. </tr>
  304. <tr class=' module-item'>
  305. <td><a class="struct" href="struct.SplitStream.html"
  306. title='struct futures::stream::SplitStream'>SplitStream</a></td>
  307. <td class='docblock-short'>
  308. <p>A <code>Stream</code> part of the split pair</p>
  309. </td>
  310. </tr>
  311. <tr class=' module-item'>
  312. <td><a class="struct" href="struct.StreamFuture.html"
  313. title='struct futures::stream::StreamFuture'>StreamFuture</a></td>
  314. <td class='docblock-short'>
  315. <p>A combinator used to temporarily convert a stream into a future.</p>
  316. </td>
  317. </tr>
  318. <tr class=' module-item'>
  319. <td><a class="struct" href="struct.Take.html"
  320. title='struct futures::stream::Take'>Take</a></td>
  321. <td class='docblock-short'>
  322. <p>A stream combinator which returns a maximum number of elements.</p>
  323. </td>
  324. </tr>
  325. <tr class=' module-item'>
  326. <td><a class="struct" href="struct.TakeWhile.html"
  327. title='struct futures::stream::TakeWhile'>TakeWhile</a></td>
  328. <td class='docblock-short'>
  329. <p>A stream combinator which takes elements from a stream while a predicate
  330. holds.</p>
  331. </td>
  332. </tr>
  333. <tr class=' module-item'>
  334. <td><a class="struct" href="struct.Then.html"
  335. title='struct futures::stream::Then'>Then</a></td>
  336. <td class='docblock-short'>
  337. <p>A stream combinator which chains a computation onto each item produced by a
  338. stream.</p>
  339. </td>
  340. </tr>
  341. <tr class=' module-item'>
  342. <td><a class="struct" href="struct.Unfold.html"
  343. title='struct futures::stream::Unfold'>Unfold</a></td>
  344. <td class='docblock-short'>
  345. <p>A stream which creates futures, polls them and return their result</p>
  346. </td>
  347. </tr>
  348. <tr class=' module-item'>
  349. <td><a class="struct" href="struct.Wait.html"
  350. title='struct futures::stream::Wait'>Wait</a></td>
  351. <td class='docblock-short'>
  352. <p>A stream combinator which converts an asynchronous stream to a <strong>blocking
  353. iterator</strong>.</p>
  354. </td>
  355. </tr>
  356. <tr class=' module-item'>
  357. <td><a class="struct" href="struct.Zip.html"
  358. title='struct futures::stream::Zip'>Zip</a></td>
  359. <td class='docblock-short'>
  360. <p>An adapter for merging the output of two streams.</p>
  361. </td>
  362. </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
  363. <table>
  364. <tr class=' module-item'>
  365. <td><a class="enum" href="enum.MergedItem.html"
  366. title='enum futures::stream::MergedItem'>MergedItem</a></td>
  367. <td class='docblock-short'>
  368. [<div class='stab deprecated'>Deprecated</div>] <p>An item returned from a merge stream, which represents an item from one or
  369. both of the underlying streams.</p>
  370. </td>
  371. </tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
  372. <table>
  373. <tr class=' module-item'>
  374. <td><a class="trait" href="trait.Stream.html"
  375. title='trait futures::stream::Stream'>Stream</a></td>
  376. <td class='docblock-short'>
  377. <p>A stream of values, not all of which may have been produced yet.</p>
  378. </td>
  379. </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
  380. <table>
  381. <tr class=' module-item'>
  382. <td><a class="fn" href="fn.empty.html"
  383. title='fn futures::stream::empty'>empty</a></td>
  384. <td class='docblock-short'>
  385. <p>Creates a stream which contains no elements.</p>
  386. </td>
  387. </tr>
  388. <tr class=' module-item'>
  389. <td><a class="fn" href="fn.futures_ordered.html"
  390. title='fn futures::stream::futures_ordered'>futures_ordered</a></td>
  391. <td class='docblock-short'>
  392. <p>Converts a list of futures into a <code>Stream</code> of results from the futures.</p>
  393. </td>
  394. </tr>
  395. <tr class=' module-item'>
  396. <td><a class="fn" href="fn.futures_unordered.html"
  397. title='fn futures::stream::futures_unordered'>futures_unordered</a></td>
  398. <td class='docblock-short'>
  399. <p>Converts a list of futures into a <code>Stream</code> of results from the futures.</p>
  400. </td>
  401. </tr>
  402. <tr class=' module-item'>
  403. <td><a class="fn" href="fn.iter.html"
  404. title='fn futures::stream::iter'>iter</a></td>
  405. <td class='docblock-short'>
  406. [<div class='stab deprecated'>Deprecated</div>] <p>Converts an <code>Iterator</code> over <code>Result</code>s into a <code>Stream</code> which is always ready
  407. to yield the next value.</p>
  408. </td>
  409. </tr>
  410. <tr class=' module-item'>
  411. <td><a class="fn" href="fn.iter_ok.html"
  412. title='fn futures::stream::iter_ok'>iter_ok</a></td>
  413. <td class='docblock-short'>
  414. <p>Converts an <code>Iterator</code> into a <code>Stream</code> which is always ready
  415. to yield the next value.</p>
  416. </td>
  417. </tr>
  418. <tr class=' module-item'>
  419. <td><a class="fn" href="fn.iter_result.html"
  420. title='fn futures::stream::iter_result'>iter_result</a></td>
  421. <td class='docblock-short'>
  422. <p>Converts an <code>Iterator</code> over <code>Result</code>s into a <code>Stream</code> which is always ready
  423. to yield the next value.</p>
  424. </td>
  425. </tr>
  426. <tr class=' module-item'>
  427. <td><a class="fn" href="fn.once.html"
  428. title='fn futures::stream::once'>once</a></td>
  429. <td class='docblock-short'>
  430. <p>Creates a stream of single element</p>
  431. </td>
  432. </tr>
  433. <tr class=' module-item'>
  434. <td><a class="fn" href="fn.poll_fn.html"
  435. title='fn futures::stream::poll_fn'>poll_fn</a></td>
  436. <td class='docblock-short'>
  437. <p>Creates a new stream wrapping around a function returning <code>Poll</code>.</p>
  438. </td>
  439. </tr>
  440. <tr class=' module-item'>
  441. <td><a class="fn" href="fn.repeat.html"
  442. title='fn futures::stream::repeat'>repeat</a></td>
  443. <td class='docblock-short'>
  444. <p>Create a stream which produces the same item repeatedly.</p>
  445. </td>
  446. </tr>
  447. <tr class=' module-item'>
  448. <td><a class="fn" href="fn.unfold.html"
  449. title='fn futures::stream::unfold'>unfold</a></td>
  450. <td class='docblock-short'>
  451. <p>Creates a <code>Stream</code> from a seed and a closure returning a <code>Future</code>.</p>
  452. </td>
  453. </tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "futures";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>