mentat/tokio/executor/struct.Spawn.html
2018-08-22 17:04:13 +00:00

150 lines
No EOL
9.4 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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` struct in crate `tokio`.">
<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="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc struct">
<!--[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'>Struct Spawn</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-IntoFuture">IntoFuture</a></div></div><p class='location'><a href='../index.html'>tokio</a>::<wbr><a href='index.html'>executor</a></p><script>window.sidebarCurrent = {name: 'Spawn', ty: 'struct', 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">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>tokio</a>::<wbr><a href='index.html'>executor</a>::<wbr><a class="struct" 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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/tokio/executor/mod.rs.html#155' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Spawn(_);</pre><div class='docblock'><p>Return value from the <code>spawn</code> function.</p>
<p>Currently this value doesn't actually provide any functionality. However, it
provides a way to add functionality later without breaking backwards
compatibility.</p>
<p>This also implements <code>IntoFuture</code> so that it can be used as the return value
in a <code>for_each</code> loop.</p>
<p>See <a href="fn.spawn.html"><code>spawn</code></a> for more details.</p>
</div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tokio/executor/struct.Spawn.html" title="struct tokio::executor::Spawn">Spawn</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio/executor/mod.rs.html#154' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio/executor/mod.rs.html#154' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-IntoFuture' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a> for <a class="struct" href="../../tokio/executor/struct.Spawn.html" title="struct tokio::executor::Spawn">Spawn</a></code><a href='#impl-IntoFuture' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio/executor/mod.rs.html#220-228' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Future' class="type"><span id='Future.t' class='invisible'><code>type <a href='../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future' class="type">Future</a> = <a class="struct" href="../../tokio/prelude/future/struct.Done.html" title="struct tokio::prelude::future::Done">FutureResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></h4>
<div class='docblock'><p>The future that this type can be converted into.</p>
</div><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='../../tokio/prelude/trait.IntoFuture.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></span></h4>
<div class='docblock'><p>The item that the future may resolve with.</p>
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../../tokio/prelude/trait.IntoFuture.html#associatedtype.Error' class="type">Error</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></span></h4>
<div class='docblock'><p>The error that the future may resolve with.</p>
</div><h4 id='method.into_future' class="method"><span id='into_future.v' class='invisible'><code>fn <a href='../../tokio/prelude/trait.IntoFuture.html#tymethod.into_future' class='fnname'>into_future</a>(self) -&gt; Self::<a class="type" href="../../tokio/prelude/trait.IntoFuture.html#associatedtype.Future" title="type tokio::prelude::IntoFuture::Future">Future</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio/executor/mod.rs.html#225-227' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Consumes this object and produces a future.</p>
</div></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>&#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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "tokio";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>