147 lines
7.3 KiB
HTML
147 lines
7.3 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 `futures`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, spawn">
|
|||
|
|
|
|||
|
|
<title>futures::sync::oneshot::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="../../../main.css" id="themeStyle">
|
|||
|
|
<script src="../../../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</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>
|
|||
|
|
|
|||
|
|
<p class='location'><a href='../../index.html'>futures</a>::<wbr><a href='../index.html'>sync</a>::<wbr><a href='index.html'>oneshot</a></p><script>window.sidebarCurrent = {name: 'spawn', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
|||
|
|
</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">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Function <a href='../../index.html'>futures</a>::<wbr><a href='../index.html'>sync</a>::<wbr><a href='index.html'>oneshot</a>::<wbr><a class="fn" href=''>spawn</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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../../../src/futures/sync/oneshot.rs.html#474-487' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust fn'>pub fn spawn<F, E>(future: F, executor: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>E) -> <a class="struct" href="../../../futures/sync/oneshot/struct.SpawnHandle.html" title="struct futures::sync::oneshot::SpawnHandle">SpawnHandle</a><F::<a class="type" href="../../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, F::<a class="type" href="../../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>> <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>,<br> E: <a class="trait" href="../../../futures/future/trait.Executor.html" title="trait futures::future::Executor">Executor</a><<a class="struct" href="../../../futures/sync/oneshot/struct.Execute.html" title="struct futures::sync::oneshot::Execute">Execute</a><F>>, </span></pre><div class='docblock'><p>Spawns a <code>future</code> onto the instance of <code>Executor</code> provided, <code>executor</code>,
|
|||
|
|
returning a handle representing the completion of the future.</p>
|
|||
|
|
<p>The <code>SpawnHandle</code> returned is a future that is a proxy for <code>future</code> itself.
|
|||
|
|
When <code>future</code> completes on <code>executor</code> then the <code>SpawnHandle</code> will itself be
|
|||
|
|
resolved. Internally <code>SpawnHandle</code> contains a <code>oneshot</code> channel and is
|
|||
|
|
thus safe to send across threads.</p>
|
|||
|
|
<p>The <code>future</code> will be canceled if the <code>SpawnHandle</code> is dropped. If this is
|
|||
|
|
not desired then the <code>SpawnHandle::forget</code> function can be used to continue
|
|||
|
|
running the future to completion.</p>
|
|||
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
|||
|
|
<p>This function will panic if the instance of <code>Spawn</code> provided is unable to
|
|||
|
|
spawn the <code>future</code> provided.</p>
|
|||
|
|
<p>If the provided instance of <code>Spawn</code> does not actually run <code>future</code> to
|
|||
|
|
completion, then the returned handle may panic when polled. Typically this
|
|||
|
|
is not a problem, though, as most instances of <code>Spawn</code> will run futures to
|
|||
|
|
completion.</p>
|
|||
|
|
<p>Note that the returned future will likely panic if the <code>futures</code> provided
|
|||
|
|
panics. If a future running on an executor panics that typically means that
|
|||
|
|
the executor drops the future, which falls into the above case of not
|
|||
|
|
running the future to completion essentially.</p>
|
|||
|
|
</div></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>⏎</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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../../";
|
|||
|
|
window.currentCrate = "futures";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../../main.js"></script>
|
|||
|
|
<script defer src="../../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|