trait.FutureFrom.html 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  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 `FutureFrom` trait in crate `futures`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, FutureFrom">
  9. <title>futures::future::FutureFrom - 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 trait">
  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'>Trait FutureFrom</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Future">Future</a><a href="#associatedtype.Error">Error</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.future_from">future_from</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>futures</a>::<wbr><a href='index.html'>future</a></p><script>window.sidebarCurrent = {name: 'FutureFrom', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
  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'>Trait <a href='../index.html'>futures</a>::<wbr><a href='index.html'>future</a>::<wbr><a class="trait" href=''>FutureFrom</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/future/mod.rs.html#1075-1084' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust trait'>pub trait FutureFrom&lt;T&gt;: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
  51. type <a href='#associatedtype.Future' class="type">Future</a>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;Item = Self, Error = Self::<a class="type" href="../../futures/future/trait.FutureFrom.html#associatedtype.Error" title="type futures::future::FutureFrom::Error">Error</a>&gt;;
  52. type <a href='#associatedtype.Error' class="type">Error</a>;
  53. fn <a href='#tymethod.future_from' class='fnname'>future_from</a>(_: T) -&gt; Self::<a class="type" href="../../futures/future/trait.FutureFrom.html#associatedtype.Future" title="type futures::future::FutureFrom::Future">Future</a>;
  54. }</pre><div class='docblock'><p>Asynchronous conversion from a type <code>T</code>.</p>
  55. <p>This trait is analogous to <code>std::convert::From</code>, adapted to asynchronous
  56. computation.</p>
  57. </div>
  58. <h2 id='associated-types' class='small-section-header'>
  59. Associated Types<a href='#associated-types' class='anchor'></a>
  60. </h2>
  61. <div class='methods'>
  62. <h3 id='associatedtype.Future' class='method'><span id='Future.t' class='invisible'><code>type <a href='#associatedtype.Future' class="type">Future</a>: <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;Item = Self, Error = Self::<a class="type" href="../../futures/future/trait.FutureFrom.html#associatedtype.Error" title="type futures::future::FutureFrom::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>The future for the conversion.</p>
  63. </div><h3 id='associatedtype.Error' class='method'><span id='Error.t' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a></code></span></h3><div class='docblock'><p>Possible errors during conversion.</p>
  64. </div></div>
  65. <h2 id='required-methods' class='small-section-header'>
  66. Required Methods<a href='#required-methods' class='anchor'></a>
  67. </h2>
  68. <div class='methods'>
  69. <h3 id='tymethod.future_from' class='method'><span id='future_from.v' class='invisible'><code>fn <a href='#tymethod.future_from' class='fnname'>future_from</a>(_: T) -&gt; Self::<a class="type" href="../../futures/future/trait.FutureFrom.html#associatedtype.Future" title="type futures::future::FutureFrom::Future">Future</a></code></span></h3><div class='docblock'><p>Consume the given value, beginning the conversion.</p>
  70. </div></div>
  71. <h2 id='implementors' class='small-section-header'>
  72. Implementors<a href='#implementors' class='anchor'></a>
  73. </h2>
  74. <ul class='item-list' id='implementors-list'>
  75. </ul><script type="text/javascript" async
  76. src="../../implementors/futures/future/trait.FutureFrom.js">
  77. </script></section>
  78. <section id='search' class="content hidden"></section>
  79. <section class="footer"></section>
  80. <aside id="help" class="hidden">
  81. <div>
  82. <h1 class="hidden">Help</h1>
  83. <div class="shortcuts">
  84. <h2>Keyboard Shortcuts</h2>
  85. <dl>
  86. <dt><kbd>?</kbd></dt>
  87. <dd>Show this help dialog</dd>
  88. <dt><kbd>S</kbd></dt>
  89. <dd>Focus the search field</dd>
  90. <dt><kbd>↑</kbd></dt>
  91. <dd>Move up in search results</dd>
  92. <dt><kbd>↓</kbd></dt>
  93. <dd>Move down in search results</dd>
  94. <dt><kbd>↹</kbd></dt>
  95. <dd>Switch tab</dd>
  96. <dt><kbd>&#9166;</kbd></dt>
  97. <dd>Go to active search result</dd>
  98. <dt><kbd>+</kbd></dt>
  99. <dd>Expand all sections</dd>
  100. <dt><kbd>-</kbd></dt>
  101. <dd>Collapse all sections</dd>
  102. </dl>
  103. </div>
  104. <div class="infos">
  105. <h2>Search Tricks</h2>
  106. <p>
  107. Prefix searches with a type followed by a colon (e.g.
  108. <code>fn:</code>) to restrict the search to a given type.
  109. </p>
  110. <p>
  111. Accepted types are: <code>fn</code>, <code>mod</code>,
  112. <code>struct</code>, <code>enum</code>,
  113. <code>trait</code>, <code>type</code>, <code>macro</code>,
  114. and <code>const</code>.
  115. </p>
  116. <p>
  117. Search functions by type signature (e.g.
  118. <code>vec -> usize</code> or <code>* -> vec</code>)
  119. </p>
  120. </div>
  121. </div>
  122. </aside>
  123. <script>
  124. window.rootPath = "../../";
  125. window.currentCrate = "futures";
  126. </script>
  127. <script src="../../main.js"></script>
  128. <script defer src="../../search-index.js"></script>
  129. </body>
  130. </html>