mentat/tokio/runtime/current_thread/index.html
2018-08-22 17:04:13 +00:00

198 lines
No EOL
9.8 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 `current_thread` mod in crate `tokio`.">
<meta name="keywords" content="rust, rustlang, rust-lang, current_thread">
<title>tokio::runtime::current_thread - 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 mod">
<!--[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'>Module current_thread</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'><a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>runtime</a></p><script>window.sidebarCurrent = {name: 'current_thread', ty: 'mod', 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'>Module <a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>runtime</a>::<wbr><a class="mod" href=''>current_thread</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/runtime/current_thread/mod.rs.html#1-70' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A runtime implementation that runs everything on the current thread.</p>
<p><a href="struct.Runtime.html"><code>current_thread::Runtime</code></a> is similar to the primary
<a href="../struct.Runtime.html"><code>Runtime</code></a> except that it runs all components on the current
thread instead of using a thread pool. This means that it is able to spawn
futures that do not implement <code>Send</code>.</p>
<p>Same as the default <a href="../struct.Runtime.html"><code>Runtime</code></a>, the
<a href="struct.Runtime.html"><code>current_thread::Runtime</code></a> includes:</p>
<ul>
<li>A [reactor] to drive I/O resources.</li>
<li>An [executor] to execute tasks that use these I/O resources.</li>
<li>A [timer] for scheduling work to run after a set period of time.</li>
</ul>
<p>Note that <a href="struct.Runtime.html"><code>current_thread::Runtime</code></a> does not implement <code>Send</code> itself
and cannot be safely moved to other threads.</p>
<h1 id="spawning-from-other-threads" class="section-header"><a href="#spawning-from-other-threads">Spawning from other threads</a></h1>
<p>While <a href="struct.Runtime.html"><code>current_thread::Runtime</code></a> does not implement <code>Send</code> and cannot
safely be moved to other threads, it provides a <code>Handle</code> that can be sent
to other threads and allows to spawn new tasks from there.</p>
<p>For example:</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">runtime</span>::<span class="ident">current_thread</span>::<span class="ident">Runtime</span>;
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">runtime</span> <span class="op">=</span> <span class="ident">Runtime</span>::<span class="ident">new</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="ident">runtime</span>.<span class="ident">handle</span>();
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> {
<span class="ident">handle</span>.<span class="ident">spawn</span>(<span class="ident">future</span>::<span class="ident">ok</span>(()));
}).<span class="ident">join</span>().<span class="ident">unwrap</span>();
<span class="ident">runtime</span>.<span class="ident">run</span>().<span class="ident">unwrap</span>();</pre>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<p>Creating a new <code>Runtime</code> and running a future <code>f</code> until its completion and
returning its result.</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">runtime</span>::<span class="ident">current_thread</span>::<span class="ident">Runtime</span>;
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">runtime</span> <span class="op">=</span> <span class="ident">Runtime</span>::<span class="ident">new</span>().<span class="ident">unwrap</span>();
<span class="comment">// Use the runtime...</span>
<span class="comment">// runtime.block_on(f); // where f is a future</span></pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Builder.html"
title='struct tokio::runtime::current_thread::Builder'>Builder</a></td>
<td class='docblock-short'>
<p>Builds a Single-threaded runtime with custom configuration values.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Handle.html"
title='struct tokio::runtime::current_thread::Handle'>Handle</a></td>
<td class='docblock-short'>
<p>Handle to spawn a future on the corresponding <code>CurrentThread</code> runtime instance</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Runtime.html"
title='struct tokio::runtime::current_thread::Runtime'>Runtime</a></td>
<td class='docblock-short'>
<p>Single-threaded runtime provides a way to start reactor
and executor on the current thread.</p>
</td>
</tr></table></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>