mentat/tokio_threadpool/struct.Sender.html
2018-08-22 17:04:13 +00:00

203 lines
No EOL
22 KiB
HTML
Raw 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 `Sender` struct in crate `tokio_threadpool`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Sender">
<title>tokio_threadpool::Sender - 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 Sender</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.spawn">spawn</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Executor">Executor</a><a href="#impl-Executor%3CT%3E">Executor&lt;T&gt;</a><a href="#impl-Clone">Clone</a></div></div><p class='location'><a href='index.html'>tokio_threadpool</a></p><script>window.sidebarCurrent = {name: 'Sender', 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_threadpool</a>::<wbr><a class="struct" href=''>Sender</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_threadpool/sender.rs.html#29-31' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Sender { /* fields omitted */ }</pre><div class='docblock'><p>Submit futures to the associated thread pool for execution.</p>
<p>A <code>Sender</code> instance is a handle to a single thread pool, allowing the owner
of the handle to spawn futures onto the thread pool. New futures are spawned
using <a href="#method.spawn"><code>Sender::spawn</code></a>.</p>
<p>The <code>Sender</code> handle is <em>only</em> used for spawning new futures. It does not
impact the lifecycle of the thread pool in any way.</p>
<p><code>Sender</code> instances are obtained by calling <a href="struct.ThreadPool.html#method.sender"><code>ThreadPool::sender</code></a>. The
<code>Sender</code> struct implements the <code>Executor</code> trait.</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../tokio_threadpool/struct.Sender.html" title="struct tokio_threadpool::Sender">Sender</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#33-124' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.spawn' class="method"><span id='spawn.v' class='invisible'><code>pub fn <a href='#method.spawn' class='fnname'>spawn</a>&lt;F&gt;(&amp;self, future: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../tokio_executor/struct.SpawnError.html" title="struct tokio_executor::SpawnError">SpawnError</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;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>&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#83-88' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Spawn a future onto the thread pool</p>
<p>This function takes ownership of the future and spawns it onto the
thread pool, assigning it to a worker thread. The exact strategy used to
assign a future to a worker depends on if the caller is already on a
worker thread or external to the thread pool.</p>
<p>If the caller is currently on the thread pool, the spawned future will
be assigned to the same worker that the caller is on. If the caller is
external to the thread pool, the future will be assigned to a random
worker.</p>
<p>If <code>spawn</code> returns <code>Ok</code>, this does not mean that the future will be
executed. The thread pool can be forcibly shutdown between the time
<code>spawn</code> is called and the future has a chance to execute.</p>
<p>If <code>spawn</code> returns <code>Err</code>, then the future failed to be spawned. There
are two possible causes:</p>
<ul>
<li>The thread pool is at capacity and is unable to spawn a new future.
This is a temporary failure. At some point in the future, the thread
pool might be able to spawn new futures.</li>
<li>The thread pool is shutdown. This is a permanent failure indicating
that the handle will never be able to spawn new futures.</li>
</ul>
<p>The status of the thread pool can be queried before calling <code>spawn</code>
using the <code>status</code> function (part of the <code>Executor</code> trait).</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>::{<span class="ident">Future</span>, <span class="ident">lazy</span>};
<span class="comment">// Create a thread pool with default configuration values</span>
<span class="kw">let</span> <span class="ident">thread_pool</span> <span class="op">=</span> <span class="ident">ThreadPool</span>::<span class="ident">new</span>();
<span class="ident">thread_pool</span>.<span class="ident">sender</span>().<span class="ident">spawn</span>(<span class="ident">lazy</span>(<span class="op">||</span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;called from a worker thread&quot;</span>);
<span class="prelude-val">Ok</span>(())
})).<span class="ident">unwrap</span>();
<span class="comment">// Gracefully shutdown the threadpool</span>
<span class="ident">thread_pool</span>.<span class="ident">shutdown</span>().<span class="ident">wait</span>().<span class="ident">unwrap</span>();</pre>
</div></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_threadpool/struct.Sender.html" title="struct tokio_threadpool::Sender">Sender</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_threadpool/sender.rs.html#28' 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_threadpool/sender.rs.html#28' 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-Executor' class='impl'><span class='in-band'><code>impl <a class="trait" href="../tokio_executor/trait.Executor.html" title="trait tokio_executor::Executor">Executor</a> for <a class="struct" href="../tokio_threadpool/struct.Sender.html" title="struct tokio_threadpool::Sender">Sender</a></code><a href='#impl-Executor' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#126-143' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.status' class="method"><span id='status.v' class='invisible'><code>fn <a href='../tokio_executor/trait.Executor.html#method.status' class='fnname'>status</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../tokio_executor/struct.SpawnError.html" title="struct tokio_executor::SpawnError">SpawnError</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#127-130' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Provides a best effort hint to whether or not <code>spawn</code> will succeed. <a href="../tokio_executor/trait.Executor.html#method.status">Read more</a></p>
</div><h4 id='method.spawn-1' class="method"><span id='spawn.v-1' class='invisible'><code>fn <a href='../tokio_executor/trait.Executor.html#tymethod.spawn' class='fnname'>spawn</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;future: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;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>&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../tokio_executor/struct.SpawnError.html" title="struct tokio_executor::SpawnError">SpawnError</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#132-137' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Spawns a future object to run on this executor. <a href="../tokio_executor/trait.Executor.html#tymethod.spawn">Read more</a></p>
</div></div><h3 id='impl-Executor-1' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="../tokio_executor/trait.Executor.html" title="trait tokio_executor::Executor">Executor</a> for &amp;'a <a class="struct" href="../tokio_threadpool/struct.Sender.html" title="struct tokio_threadpool::Sender">Sender</a></code><a href='#impl-Executor-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#145-182' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.status-1' class="method"><span id='status.v-1' class='invisible'><code>fn <a href='../tokio_executor/trait.Executor.html#method.status' class='fnname'>status</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../tokio_executor/struct.SpawnError.html" title="struct tokio_executor::SpawnError">SpawnError</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#146-160' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Provides a best effort hint to whether or not <code>spawn</code> will succeed. <a href="../tokio_executor/trait.Executor.html#method.status">Read more</a></p>
</div><h4 id='method.spawn-2' class="method"><span id='spawn.v-2' class='invisible'><code>fn <a href='../tokio_executor/trait.Executor.html#tymethod.spawn' class='fnname'>spawn</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;future: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;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>&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../tokio_executor/struct.SpawnError.html" title="struct tokio_executor::SpawnError">SpawnError</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#162-176' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Spawns a future object to run on this executor. <a href="../tokio_executor/trait.Executor.html#tymethod.spawn">Read more</a></p>
</div></div><h3 id='impl-Executor%3CT%3E' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="../futures/future/trait.Executor.html" title="trait futures::future::Executor">Executor</a>&lt;T&gt; for <a class="struct" href="../tokio_threadpool/struct.Sender.html" title="struct tokio_threadpool::Sender">Sender</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;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>&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,&nbsp;</span></code><a href='#impl-Executor%3CT%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#184-201' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.execute' class="method"><span id='execute.v' class='invisible'><code>fn <a href='../futures/future/trait.Executor.html#tymethod.execute' class='fnname'>execute</a>(&amp;self, future: T) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../futures/future/struct.ExecuteError.html" title="struct futures::future::ExecuteError">ExecuteError</a>&lt;T&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#187-200' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Spawns a future to run on this <code>Executor</code>, typically in the &quot;background&quot;. <a href="../futures/future/trait.Executor.html#tymethod.execute">Read more</a></p>
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../tokio_threadpool/struct.Sender.html" title="struct tokio_threadpool::Sender">Sender</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#244-250' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../tokio_threadpool/struct.Sender.html" title="struct tokio_threadpool::Sender">Sender</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_threadpool/sender.rs.html#246-249' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></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_threadpool";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>