fn.iter.html 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `iter` fn in crate `futures`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, iter">
  9. <title>futures::stream::iter - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
  14. <script src="../../storage.js"></script>
  15. </head>
  16. <body class="rustdoc fn">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'><a href='../index.html'>futures</a>::<wbr><a href='index.html'>stream</a></p><script>window.sidebarCurrent = {name: 'iter', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Function <a href='../index.html'>futures</a>::<wbr><a href='index.html'>stream</a>::<wbr><a class="fn" href=''>iter</a></span><span class='out-of-band'><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='../../src/futures/stream/iter.rs.html#30-34' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust fn'>pub fn iter&lt;J, T, E&gt;(i: J) -&gt; <a class="struct" href="../../futures/stream/struct.Iter.html" title="struct futures::stream::Iter">Iter</a>&lt;J::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::IntoIterator::IntoIter">IntoIter</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;J: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>&lt;Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt;&gt;,&nbsp;</span></pre><div class='stability'><div class='stab deprecated'>Deprecated<p>: implementation moved to <code>iter_ok</code> and <code>iter_result</code></p>
  51. </div></div><div class='docblock'><p>Converts an <code>Iterator</code> over <code>Result</code>s into a <code>Stream</code> which is always ready
  52. to yield the next value.</p>
  53. <p>Iterators in Rust don't express the ability to block, so this adapter simply
  54. always calls <code>iter.next()</code> and returns that.</p>
  55. <pre class="rust rust-example-rendered">
  56. <span class="kw">use</span> <span class="ident">futures</span>::<span class="kw-2">*</span>;
  57. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">stream</span> <span class="op">=</span> <span class="ident">stream</span>::<span class="ident">iter</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="prelude-val">Ok</span>(<span class="number">17</span>), <span class="prelude-val">Err</span>(<span class="bool-val">false</span>), <span class="prelude-val">Ok</span>(<span class="number">19</span>)]);
  58. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="prelude-val">Some</span>(<span class="number">17</span>))), <span class="ident">stream</span>.<span class="ident">poll</span>());
  59. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Err</span>(<span class="bool-val">false</span>), <span class="ident">stream</span>.<span class="ident">poll</span>());
  60. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="prelude-val">Some</span>(<span class="number">19</span>))), <span class="ident">stream</span>.<span class="ident">poll</span>());
  61. <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="prelude-val">None</span>)), <span class="ident">stream</span>.<span class="ident">poll</span>());</pre>
  62. </div></section>
  63. <section id='search' class="content hidden"></section>
  64. <section class="footer"></section>
  65. <aside id="help" class="hidden">
  66. <div>
  67. <h1 class="hidden">Help</h1>
  68. <div class="shortcuts">
  69. <h2>Keyboard Shortcuts</h2>
  70. <dl>
  71. <dt><kbd>?</kbd></dt>
  72. <dd>Show this help dialog</dd>
  73. <dt><kbd>S</kbd></dt>
  74. <dd>Focus the search field</dd>
  75. <dt><kbd>↑</kbd></dt>
  76. <dd>Move up in search results</dd>
  77. <dt><kbd>↓</kbd></dt>
  78. <dd>Move down in search results</dd>
  79. <dt><kbd>↹</kbd></dt>
  80. <dd>Switch tab</dd>
  81. <dt><kbd>&#9166;</kbd></dt>
  82. <dd>Go to active search result</dd>
  83. <dt><kbd>+</kbd></dt>
  84. <dd>Expand all sections</dd>
  85. <dt><kbd>-</kbd></dt>
  86. <dd>Collapse all sections</dd>
  87. </dl>
  88. </div>
  89. <div class="infos">
  90. <h2>Search Tricks</h2>
  91. <p>
  92. Prefix searches with a type followed by a colon (e.g.
  93. <code>fn:</code>) to restrict the search to a given type.
  94. </p>
  95. <p>
  96. Accepted types are: <code>fn</code>, <code>mod</code>,
  97. <code>struct</code>, <code>enum</code>,
  98. <code>trait</code>, <code>type</code>, <code>macro</code>,
  99. and <code>const</code>.
  100. </p>
  101. <p>
  102. Search functions by type signature (e.g.
  103. <code>vec -> usize</code> or <code>* -> vec</code>)
  104. </p>
  105. </div>
  106. </div>
  107. </aside>
  108. <script>
  109. window.rootPath = "../../";
  110. window.currentCrate = "futures";
  111. </script>
  112. <script src="../../main.js"></script>
  113. <script defer src="../../search-index.js"></script>
  114. </body>
  115. </html>