trait.FutureFrom.html 7.2 KB

12345678910111213141516171819202122232425262728
  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 `FutureFrom` trait in crate `futures`."><meta name="keywords" content="rust, rustlang, rust-lang, FutureFrom"><title>futures::future::FutureFrom - 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 trait"><!--[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'>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></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'>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'><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/future/mod.rs.html#1075-1084' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><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> {
  2. 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;;
  3. type <a href='#associatedtype.Error' class="type">Error</a>;
  4. 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>;
  5. }</pre></div><div class='docblock'><p>Asynchronous conversion from a type <code>T</code>.</p>
  6. <p>This trait is analogous to <code>std::convert::From</code>, adapted to asynchronous
  7. computation.</p>
  8. </div>
  9. <h2 id='associated-types' class='small-section-header'>
  10. Associated Types<a href='#associated-types' class='anchor'></a>
  11. </h2>
  12. <div class='methods'>
  13. <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>
  14. </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>
  15. </div></div>
  16. <h2 id='required-methods' class='small-section-header'>
  17. Required Methods<a href='#required-methods' class='anchor'></a>
  18. </h2>
  19. <div class='methods'>
  20. <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>
  21. </div></div>
  22. <h2 id='implementors' class='small-section-header'>
  23. Implementors<a href='#implementors' class='anchor'></a>
  24. </h2>
  25. <ul class='item-list' id='implementors-list'>
  26. </ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
  27. src="../../implementors/futures/future/trait.FutureFrom.js">
  28. </script></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>