164 lines
No EOL
18 KiB
HTML
164 lines
No EOL
18 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 `TaskExecutor` struct in crate `tokio`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, TaskExecutor">
|
||
|
||
<title>tokio::executor::current_thread::TaskExecutor - 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">☰</div>
|
||
|
||
<p class='location'>Struct TaskExecutor</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.current">current</a><a href="#method.spawn_local">spawn_local</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</a><a href="#impl-Executor">Executor</a><a href="#impl-Executor%3CF%3E">Executor<F></a></div></div><p class='location'><a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>executor</a>::<wbr><a href='index.html'>current_thread</a></p><script>window.sidebarCurrent = {name: 'TaskExecutor', 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 href='index.html'>current_thread</a>::<wbr><a class="struct" href=''>TaskExecutor</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/tokio/executor/current_thread/mod.rs.html#152-155' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct TaskExecutor { /* fields omitted */ }</pre><div class='docblock'><p>Executes futures on the current thread.</p>
|
||
<p>All futures executed using this executor will be executed on the current
|
||
thread. As such, <code>run</code> will wait for these futures to complete before
|
||
returning.</p>
|
||
<p>For more details, see the <a href="index.html">module level</a> documentation.</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/executor/current_thread/struct.TaskExecutor.html" title="struct tokio::executor::current_thread::TaskExecutor">TaskExecutor</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio/executor/current_thread/mod.rs.html#671-700' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.current' class="method"><span id='current.v' class='invisible'><code>pub fn <a href='#method.current' class='fnname'>current</a>() -> <a class="struct" href="../../../tokio/executor/current_thread/struct.TaskExecutor.html" title="struct tokio::executor::current_thread::TaskExecutor">TaskExecutor</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio/executor/current_thread/mod.rs.html#678-682' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns an executor that executes futures on the current thread.</p>
|
||
<p>The user of <code>TaskExecutor</code> must ensure that when a future is submitted,
|
||
that it is done within the context of a call to <code>run</code>.</p>
|
||
<p>For more details, see the <a href="index.html">module level</a> documentation.</p>
|
||
</div><h4 id='method.spawn_local' class="method"><span id='spawn_local.v' class='invisible'><code>pub fn <a href='#method.spawn_local' class='fnname'>spawn_local</a>(<br> &mut self, <br> future: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::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>>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio/executor/current_thread/mod.rs.html#685-699' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Spawn a future onto the current <code>CurrentThread</code> instance.</p>
|
||
</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/executor/current_thread/struct.TaskExecutor.html" title="struct tokio::executor::current_thread::TaskExecutor">TaskExecutor</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/current_thread/mod.rs.html#151' 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>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <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/current_thread/mod.rs.html#151' 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-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/executor/current_thread/struct.TaskExecutor.html" title="struct tokio::executor::current_thread::TaskExecutor">TaskExecutor</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/executor/current_thread/mod.rs.html#151' 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>(&self) -> <a class="struct" href="../../../tokio/executor/current_thread/struct.TaskExecutor.html" title="struct tokio::executor::current_thread::TaskExecutor">TaskExecutor</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio/executor/current_thread/mod.rs.html#151' 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>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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><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/executor/current_thread/struct.TaskExecutor.html" title="struct tokio::executor::current_thread::TaskExecutor">TaskExecutor</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/executor/current_thread/mod.rs.html#702-725' 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>fn <a href='../../../tokio/executor/trait.Executor.html#tymethod.spawn' class='fnname'>spawn</a>(<br> &mut self, <br> future: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::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>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio/executor/current_thread/mod.rs.html#703-707' 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><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>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio/executor/current_thread/mod.rs.html#716-724' 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></div><h3 id='impl-Executor%3CF%3E' class='impl'><span class='in-band'><code>impl<F> <a class="trait" href="../../../tokio/prelude/future/trait.Executor.html" title="trait tokio::prelude::future::Executor">Executor</a><F> for <a class="struct" href="../../../tokio/executor/current_thread/struct.TaskExecutor.html" title="struct tokio::executor::current_thread::TaskExecutor">TaskExecutor</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../tokio/prelude/future/trait.Future.html" title="trait tokio::prelude::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>> + 'static, </span></code><a href='#impl-Executor%3CF%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio/executor/current_thread/mod.rs.html#727-743' 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='../../../tokio/prelude/future/trait.Executor.html#tymethod.execute' class='fnname'>execute</a>(&self, future: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../../tokio/prelude/future/struct.ExecuteError.html" title="struct tokio::prelude::future::ExecuteError">ExecuteError</a><F>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio/executor/current_thread/mod.rs.html#730-742' 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 "background". <a href="../../../tokio/prelude/future/trait.Executor.html#tymethod.execute">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>⏎</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> |