26 lines
5.1 KiB
HTML
26 lines
5.1 KiB
HTML
<!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 `spawn` fn in crate `tokio_executor`."><meta name="keywords" content="rust, rustlang, rust-lang, spawn"><title>tokio_executor::spawn - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[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">☰</div><a href='../tokio_executor/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>tokio_executor</a></p><script>window.sidebarCurrent = {name: 'spawn', ty: 'fn', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/tokio_executor/global.rs.html#168-173' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>tokio_executor</a>::<wbr><a class="fn" href=''>spawn</a></span></h1><pre class='rust fn'>pub fn spawn<T>(future: T) <span class="where fmt-newline">where<br> T: <a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></pre><div class='docblock'><p>Submits a future for execution on the default executor -- usually a
|
||
threadpool.</p>
|
||
<p>Futures are lazy constructs. When they are defined, no work happens. In
|
||
order for the logic defined by the future to be run, the future must be
|
||
spawned on an executor. This function is the easiest way to do so.</p>
|
||
<p>This function must be called from an execution context, i.e. from a future
|
||
that has been already spawned onto an executor.</p>
|
||
<p>Once spawned, the future will execute. The details of how that happens is
|
||
left up to the executor instance. If the executor is a thread pool, the
|
||
future will be pushed onto a queue that a worker thread polls from. If the
|
||
executor is a "current thread" executor, the future might be polled
|
||
immediately from within the call to <code>spawn</code> or it might be pushed onto an
|
||
internal queue.</p>
|
||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<p>This function will panic if the default executor is not set or if spawning
|
||
onto the default executor returns an error. To avoid the panic, use the
|
||
<code>DefaultExecutor</code> handle directly.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::<span class="ident">lazy</span>;
|
||
|
||
<span class="ident">spawn</span>(<span class="ident">lazy</span>(<span class="op">|</span><span class="op">|</span> {
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"running on the default executor"</span>);
|
||
<span class="prelude-val">Ok</span>(())
|
||
}));</pre></div>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "tokio_executor";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |