| <!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="Extension trait for `Spawn`."><meta name="keywords" content="rust, rustlang, rust-lang, SpawnExt"><title>SpawnExt in futures_util::task - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">SpawnExt</a></h2><div class="sidebar-elems"><section><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.spawn">spawn</a></li><li><a href="#method.spawn_with_handle">spawn_with_handle</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In futures_util::task</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../index.html">futures_util</a>::<wbr><a href="index.html">task</a>::<wbr><a class="trait" href="#">SpawnExt</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/futures_util/task/spawn.rs.html#20-100">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait SpawnExt: <a class="trait" href="trait.Spawn.html" title="trait futures_util::task::Spawn">Spawn</a> { |
| fn <a href="#method.spawn" class="fnname">spawn</a><Fut>(&self, future: Fut) -> Result<(), <a class="struct" href="struct.SpawnError.html" title="struct futures_util::task::SpawnError">SpawnError</a>><br> <span class="where">where<br> Fut: Future<Output = ()> + Send + 'static</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.spawn_with_handle" class="fnname">spawn_with_handle</a><Fut>(<br> &self,<br> future: Fut<br> ) -> Result<<a class="struct" href="../future/struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</a><Fut::Output>, <a class="struct" href="struct.SpawnError.html" title="struct futures_util::task::SpawnError">SpawnError</a>><br> <span class="where">where<br> Fut: Future + Send + 'static,<br> Fut::Output: Send</span>, |
| { ... } |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extension trait for <code>Spawn</code>.</p> |
| </div></details><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.spawn" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/task/spawn.rs.html#49-54">source</a><h4 class="code-header">fn <a href="#method.spawn" class="fnname">spawn</a><Fut>(&self, future: Fut) -> Result<(), <a class="struct" href="struct.SpawnError.html" title="struct futures_util::task::SpawnError">SpawnError</a>><span class="where fmt-newline">where<br> Fut: Future<Output = ()> + Send + 'static,</span></h4></section></summary><div class="docblock"><p>Spawns a task that polls the given future with output <code>()</code> to |
| completion.</p> |
| <p>This method returns a [<code>Result</code>] that contains a <a href="struct.SpawnError.html" title="SpawnError"><code>SpawnError</code></a> if |
| spawning fails.</p> |
| <p>You can use <a href="trait.SpawnExt.html#method.spawn_with_handle"><code>spawn_with_handle</code></a> if |
| you want to spawn a future with output other than <code>()</code> or if you want |
| to be able to await its completion.</p> |
| <p>Note this method will eventually be replaced with the upcoming |
| <code>Spawn::spawn</code> method which will take a <code>dyn Future</code> as input. |
| Technical limitations prevent <code>Spawn::spawn</code> from being implemented |
| today. Feel free to use this method in the meantime.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::executor::ThreadPool; |
| <span class="kw">use </span>futures::task::SpawnExt; |
| |
| <span class="kw">let </span>executor = ThreadPool::new().unwrap(); |
| |
| <span class="kw">let </span>future = <span class="kw">async </span>{ <span class="comment">/* ... */ </span>}; |
| executor.spawn(future).unwrap();</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.spawn_with_handle" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/task/spawn.rs.html#80-88">source</a><h4 class="code-header">fn <a href="#method.spawn_with_handle" class="fnname">spawn_with_handle</a><Fut>(<br> &self,<br> future: Fut<br>) -> Result<<a class="struct" href="../future/struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</a><Fut::Output>, <a class="struct" href="struct.SpawnError.html" title="struct futures_util::task::SpawnError">SpawnError</a>><span class="where fmt-newline">where<br> Fut: Future + Send + 'static,<br> Fut::Output: Send,</span></h4></section></summary><div class="docblock"><p>Spawns a task that polls the given future to completion and returns a |
| future that resolves to the spawned future’s output.</p> |
| <p>This method returns a [<code>Result</code>] that contains a <a href="../future/struct.RemoteHandle.html"><code>RemoteHandle</code></a>, or, if |
| spawning fails, a <a href="struct.SpawnError.html" title="SpawnError"><code>SpawnError</code></a>. <a href="../future/struct.RemoteHandle.html"><code>RemoteHandle</code></a> is a future that |
| resolves to the output of the spawned future.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::executor::{block_on, ThreadPool}; |
| <span class="kw">use </span>futures::future; |
| <span class="kw">use </span>futures::task::SpawnExt; |
| |
| <span class="kw">let </span>executor = ThreadPool::new().unwrap(); |
| |
| <span class="kw">let </span>future = future::ready(<span class="number">1</span>); |
| <span class="kw">let </span>join_handle_fut = executor.spawn_with_handle(future).unwrap(); |
| <span class="macro">assert_eq!</span>(block_on(join_handle_fut), <span class="number">1</span>);</code></pre></div> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-SpawnExt-for-Sp" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/task/spawn.rs.html#16">source</a><a href="#impl-SpawnExt-for-Sp" class="anchor"></a><h3 class="code-header">impl<Sp: ?Sized> <a class="trait" href="trait.SpawnExt.html" title="trait futures_util::task::SpawnExt">SpawnExt</a> for Sp<span class="where fmt-newline">where<br> Sp: <a class="trait" href="trait.Spawn.html" title="trait futures_util::task::Spawn">Spawn</a>,</span></h3></section></div><script src="../../implementors/futures_util/task/spawn/trait.SpawnExt.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
