296 lines
59 KiB
HTML
296 lines
59 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="A set of tasks which are executed on the same thread."><meta name="keywords" content="rust, rustlang, rust-lang, LocalSet"><title>LocalSet in tokio::task - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Struct LocalSet</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.block_on">block_on</a><a href="#method.new">new</a><a href="#method.run_until">run_until</a><a href="#method.spawn_local">spawn_local</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a><a href="#impl-Drop">Drop</a><a href="#impl-Future">Future</a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-IntoFuture">IntoFuture</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2 class="location">Other items in<br><a href="../index.html">tokio</a>::<wbr><a href="index.html">task</a></h2><div id="sidebar-vars" data-name="LocalSet" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../tokio/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">tokio</a>::<wbr><a href="index.html">task</a>::<wbr><a class="struct" href="#">LocalSet</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></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/task/local.rs.html#213-222" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust struct"><code>pub struct LocalSet { /* fields omitted */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A set of tasks which are executed on the same thread.</p>
|
||
<p>In some cases, it is necessary to run one or more futures that do not
|
||
implement <a href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html"><code>Send</code></a> and thus are unsafe to send between threads. In these
|
||
cases, a <a href="struct.LocalSet.html">local task set</a> may be used to schedule one or more <code>!Send</code>
|
||
futures to run together on the same thread.</p>
|
||
<p>For example, the following code will not compile:</p>
|
||
|
||
<div class='information'><div class='tooltip compile_fail'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered compile_fail"><code><span class="kw">use</span> <span class="ident">std::rc::Rc</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">tokio::main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="comment">// `Rc` does not implement `Send`, and thus may not be sent between</span>
|
||
<span class="comment">// threads safely.</span>
|
||
<span class="kw">let</span> <span class="ident">unsend_data</span> <span class="op">=</span> <span class="ident">Rc::new</span>(<span class="string">"my unsend data..."</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">unsend_data</span> <span class="op">=</span> <span class="ident">unsend_data</span>.<span class="ident">clone</span>();
|
||
<span class="comment">// Because the `async` block here moves `unsend_data`, the future is `!Send`.</span>
|
||
<span class="comment">// Since `tokio::spawn` requires the spawned future to implement `Send`, this</span>
|
||
<span class="comment">// will not compile.</span>
|
||
<span class="ident">tokio::spawn</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="ident">unsend_data</span>);
|
||
<span class="comment">// ...</span>
|
||
}).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||
}</code></pre></div>
|
||
<h2 id="use-with-run_until" class="section-header"><a href="#use-with-run_until">Use with <code>run_until</code></a></h2>
|
||
<p>To spawn <code>!Send</code> futures, we can use a local task set to schedule them
|
||
on the thread calling <a href="../runtime/struct.Runtime.html#method.block_on"><code>Runtime::block_on</code></a>. When running inside of the
|
||
local task set, we can use <a href="fn.spawn_local.html"><code>task::spawn_local</code></a>, which can spawn
|
||
<code>!Send</code> futures. For example:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::rc::Rc</span>;
|
||
<span class="kw">use</span> <span class="ident">tokio::task</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">tokio::main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">unsend_data</span> <span class="op">=</span> <span class="ident">Rc::new</span>(<span class="string">"my unsend data..."</span>);
|
||
|
||
<span class="comment">// Construct a local task set that can run `!Send` futures.</span>
|
||
<span class="kw">let</span> <span class="ident">local</span> <span class="op">=</span> <span class="ident">task::LocalSet::new</span>();
|
||
|
||
<span class="comment">// Run the local task set.</span>
|
||
<span class="ident">local</span>.<span class="ident">run_until</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="kw">let</span> <span class="ident">unsend_data</span> <span class="op">=</span> <span class="ident">unsend_data</span>.<span class="ident">clone</span>();
|
||
<span class="comment">// `spawn_local` ensures that the future is spawned on the local</span>
|
||
<span class="comment">// task set.</span>
|
||
<span class="ident">task::spawn_local</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="ident">unsend_data</span>);
|
||
<span class="comment">// ...</span>
|
||
}).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||
}).<span class="kw">await</span>;
|
||
}</code></pre></div>
|
||
<p><strong>Note:</strong> The <code>run_until</code> method can only be used in <code>#[tokio::main]</code>,
|
||
<code>#[tokio::test]</code> or directly inside a call to <a href="../runtime/struct.Runtime.html#method.block_on"><code>Runtime::block_on</code></a>. It
|
||
cannot be used inside a task spawned with <code>tokio::spawn</code>.</p>
|
||
<h3 id="awaiting-a-localset" class="section-header"><a href="#awaiting-a-localset">Awaiting a <code>LocalSet</code></a></h3>
|
||
<p>Additionally, a <code>LocalSet</code> itself implements <code>Future</code>, completing when
|
||
<em>all</em> tasks spawned on the <code>LocalSet</code> complete. This can be used to run
|
||
several futures on a <code>LocalSet</code> and drive the whole set until they
|
||
complete. For example,</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio</span>::{<span class="ident">task</span>, <span class="ident">time</span>};
|
||
<span class="kw">use</span> <span class="ident">std::rc::Rc</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">tokio::main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">unsend_data</span> <span class="op">=</span> <span class="ident">Rc::new</span>(<span class="string">"world"</span>);
|
||
<span class="kw">let</span> <span class="ident">local</span> <span class="op">=</span> <span class="ident">task::LocalSet::new</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">unsend_data2</span> <span class="op">=</span> <span class="ident">unsend_data</span>.<span class="ident">clone</span>();
|
||
<span class="ident">local</span>.<span class="ident">spawn_local</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="comment">// ...</span>
|
||
<span class="macro">println!</span>(<span class="string">"hello {}"</span>, <span class="ident">unsend_data2</span>)
|
||
});
|
||
|
||
<span class="ident">local</span>.<span class="ident">spawn_local</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="ident">time::sleep</span>(<span class="ident">time::Duration::from_millis</span>(<span class="number">100</span>)).<span class="kw">await</span>;
|
||
<span class="macro">println!</span>(<span class="string">"goodbye {}"</span>, <span class="ident">unsend_data</span>)
|
||
});
|
||
|
||
<span class="comment">// ...</span>
|
||
|
||
<span class="ident">local</span>.<span class="kw">await</span>;
|
||
}</code></pre></div>
|
||
<p><strong>Note:</strong> Awaiting a <code>LocalSet</code> can only be done inside
|
||
<code>#[tokio::main]</code>, <code>#[tokio::test]</code> or directly inside a call to
|
||
<a href="../runtime/struct.Runtime.html#method.block_on"><code>Runtime::block_on</code></a>. It cannot be used inside a task spawned with
|
||
<code>tokio::spawn</code>.</p>
|
||
<h3 id="use-inside-tokiospawn" class="section-header"><a href="#use-inside-tokiospawn">Use inside <code>tokio::spawn</code></a></h3>
|
||
<p>The two methods mentioned above cannot be used inside <code>tokio::spawn</code>, so
|
||
to spawn <code>!Send</code> futures from inside <code>tokio::spawn</code>, we need to do
|
||
something else. The solution is to create the <code>LocalSet</code> somewhere else,
|
||
and communicate with it using an <a href="mod@crate::sync::mpsc"><code>mpsc</code></a> channel.</p>
|
||
<p>The following example puts the <code>LocalSet</code> inside a new thread.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio::runtime::Builder</span>;
|
||
<span class="kw">use</span> <span class="ident">tokio::sync</span>::{<span class="ident">mpsc</span>, <span class="ident">oneshot</span>};
|
||
<span class="kw">use</span> <span class="ident">tokio::task::LocalSet</span>;
|
||
|
||
<span class="comment">// This struct describes the task you want to spawn. Here we include</span>
|
||
<span class="comment">// some simple examples. The oneshot channel allows sending a response</span>
|
||
<span class="comment">// to the spawner.</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
|
||
<span class="kw">enum</span> <span class="ident">Task</span> {
|
||
<span class="ident">PrintNumber</span>(<span class="ident">u32</span>),
|
||
<span class="ident">AddOne</span>(<span class="ident">u32</span>, <span class="ident">oneshot::Sender</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span>),
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>)]</span>
|
||
<span class="kw">struct</span> <span class="ident">LocalSpawner</span> {
|
||
<span class="ident">send</span>: <span class="ident">mpsc::UnboundedSender</span><span class="op"><</span><span class="ident">Task</span><span class="op">></span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">LocalSpawner</span> {
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() -> <span class="self">Self</span> {
|
||
<span class="kw">let</span> (<span class="ident">send</span>, <span class="kw-2">mut</span> <span class="ident">recv</span>) <span class="op">=</span> <span class="ident">mpsc::unbounded_channel</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">Builder::new_current_thread</span>()
|
||
.<span class="ident">enable_all</span>()
|
||
.<span class="ident">build</span>()
|
||
.<span class="ident">unwrap</span>();
|
||
|
||
<span class="ident">std::thread::spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
|
||
<span class="kw">let</span> <span class="ident">local</span> <span class="op">=</span> <span class="ident">LocalSet::new</span>();
|
||
|
||
<span class="ident">local</span>.<span class="ident">spawn_local</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">new_task</span>) <span class="op">=</span> <span class="ident">recv</span>.<span class="ident">recv</span>().<span class="kw">await</span> {
|
||
<span class="ident">tokio::task::spawn_local</span>(<span class="ident">run_task</span>(<span class="ident">new_task</span>));
|
||
}
|
||
<span class="comment">// If the while loop returns, then all the LocalSpawner</span>
|
||
<span class="comment">// objects have have been dropped.</span>
|
||
});
|
||
|
||
<span class="comment">// This will return once all senders are dropped and all</span>
|
||
<span class="comment">// spawned tasks have returned.</span>
|
||
<span class="ident">rt</span>.<span class="ident">block_on</span>(<span class="ident">local</span>);
|
||
});
|
||
|
||
<span class="self">Self</span> {
|
||
<span class="ident">send</span>,
|
||
}
|
||
}
|
||
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">spawn</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">task</span>: <span class="ident">Task</span>) {
|
||
<span class="self">self</span>.<span class="ident">send</span>.<span class="ident">send</span>(<span class="ident">task</span>).<span class="ident">expect</span>(<span class="string">"Thread with LocalSet has shut down."</span>);
|
||
}
|
||
}
|
||
|
||
<span class="comment">// This task may do !Send stuff. We use printing a number as an example,</span>
|
||
<span class="comment">// but it could be anything.</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// The Task struct is an enum to support spawning many different kinds</span>
|
||
<span class="comment">// of operations.</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">run_task</span>(<span class="ident">task</span>: <span class="ident">Task</span>) {
|
||
<span class="kw">match</span> <span class="ident">task</span> {
|
||
<span class="ident">Task::PrintNumber</span>(<span class="ident">n</span>) => {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="ident">n</span>);
|
||
},
|
||
<span class="ident">Task::AddOne</span>(<span class="ident">n</span>, <span class="ident">response</span>) => {
|
||
<span class="comment">// We ignore failures to send the response.</span>
|
||
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">response</span>.<span class="ident">send</span>(<span class="ident">n</span> <span class="op">+</span> <span class="number">1</span>);
|
||
},
|
||
}
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">tokio::main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">spawner</span> <span class="op">=</span> <span class="ident">LocalSpawner::new</span>();
|
||
|
||
<span class="kw">let</span> (<span class="ident">send</span>, <span class="ident">response</span>) <span class="op">=</span> <span class="ident">oneshot::channel</span>();
|
||
<span class="ident">spawner</span>.<span class="ident">spawn</span>(<span class="ident">Task::AddOne</span>(<span class="number">10</span>, <span class="ident">send</span>));
|
||
<span class="kw">let</span> <span class="ident">eleven</span> <span class="op">=</span> <span class="ident">response</span>.<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">eleven</span>, <span class="number">11</span>);
|
||
}</code></pre></div>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#329-563" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#331-344" title="goto source code">[src]</a></div><a href="#method.new" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><div class="notable">Notable traits for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></div><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.unit.html">()</a>;</span></code></span></div></span></span></h4></div></summary><div class="docblock"><p>Returns a new local task set.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.spawn_local" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#383-398" title="goto source code">[src]</a></div><a href="#method.spawn_local" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.spawn_local" class="fnname">spawn_local</a><F>(&self, future: F) -> <a class="struct" href="struct.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</a><F::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><div class="notable">Notable traits for <a class="struct" href="struct.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</a><T></div><code class="content"><span class="where fmt-newline">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="struct.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</a><T></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="struct.JoinError.html" title="struct tokio::task::JoinError">JoinError</a>>;</span></code></span></div></span></span> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + 'static,<br> F::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>: 'static, </span></h4></div></summary><div class="docblock"><p>Spawns a <code>!Send</code> task onto the local task set.</p>
|
||
<p>This task is guaranteed to be run on the current thread.</p>
|
||
<p>Unlike the free function <a href="fn.spawn_local.html"><code>spawn_local</code></a>, this method may be used to
|
||
spawn local tasks when the task set is <em>not</em> running. For example:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio::task</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">tokio::main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">local</span> <span class="op">=</span> <span class="ident">task::LocalSet::new</span>();
|
||
|
||
<span class="comment">// Spawn a future on the local set. This future will be run when</span>
|
||
<span class="comment">// we call `run_until` to drive the task set.</span>
|
||
<span class="ident">local</span>.<span class="ident">spawn_local</span>(<span class="kw">async</span> {
|
||
<span class="comment">// ...</span>
|
||
});
|
||
|
||
<span class="comment">// Run the local task set.</span>
|
||
<span class="ident">local</span>.<span class="ident">run_until</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="comment">// ...</span>
|
||
}).<span class="kw">await</span>;
|
||
|
||
<span class="comment">// When `run` finishes, we can spawn _more_ futures, which will</span>
|
||
<span class="comment">// run in subsequent calls to `run_until`.</span>
|
||
<span class="ident">local</span>.<span class="ident">spawn_local</span>(<span class="kw">async</span> {
|
||
<span class="comment">// ...</span>
|
||
});
|
||
|
||
<span class="ident">local</span>.<span class="ident">run_until</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="comment">// ...</span>
|
||
}).<span class="kw">await</span>;
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.block_on" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#464-469" title="goto source code">[src]</a></div><a href="#method.block_on" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.block_on" class="fnname">block_on</a><F>(&self, rt: &<a class="struct" href="../runtime/struct.Runtime.html" title="struct tokio::runtime::Runtime">Runtime</a>, future: F) -> F::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>, </span></h4></div></summary><div class="docblock"><p>Runs a future to completion on the provided runtime, driving any local
|
||
futures spawned on this task set on the current thread.</p>
|
||
<p>This runs the given future on the runtime, blocking until it is
|
||
complete, and yielding its resolved result. Any tasks or timers which
|
||
the future spawns internally will be executed on the runtime. The future
|
||
may also call <a href="fn.spawn_local.html"><code>spawn_local</code></a> to spawn_local additional local futures on the
|
||
current thread.</p>
|
||
<p>This method should not be called from an asynchronous context.</p>
|
||
<h5 id="panics" class="section-header"><a href="#panics">Panics</a></h5>
|
||
<p>This function panics if the executor is at capacity, if the provided
|
||
future panics, or if called within an asynchronous execution context.</p>
|
||
<h5 id="notes" class="section-header"><a href="#notes">Notes</a></h5>
|
||
<p>Since this function internally calls <a href="../runtime/struct.Runtime.html#method.block_on"><code>Runtime::block_on</code></a>, and drives
|
||
futures in the local task set inside that call to <code>block_on</code>, the local
|
||
futures may not use <a href="fn.block_in_place.html">in-place blocking</a>. If a blocking call needs to be
|
||
issued from a local task, the <a href="fn.spawn_blocking.html"><code>spawn_blocking</code></a> API may be used instead.</p>
|
||
<p>For example, this will panic:</p>
|
||
|
||
<div class='information'><div class='tooltip should_panic'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered should_panic"><code><span class="kw">use</span> <span class="ident">tokio::runtime::Runtime</span>;
|
||
<span class="kw">use</span> <span class="ident">tokio::task</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">Runtime::new</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">local</span> <span class="op">=</span> <span class="ident">task::LocalSet::new</span>();
|
||
<span class="ident">local</span>.<span class="ident">block_on</span>(<span class="kw-2">&</span><span class="ident">rt</span>, <span class="kw">async</span> {
|
||
<span class="kw">let</span> <span class="ident">join</span> <span class="op">=</span> <span class="ident">task::spawn_local</span>(<span class="kw">async</span> {
|
||
<span class="kw">let</span> <span class="ident">blocking_result</span> <span class="op">=</span> <span class="ident">task::block_in_place</span>(<span class="op">|</span><span class="op">|</span> {
|
||
<span class="comment">// ...</span>
|
||
});
|
||
<span class="comment">// ...</span>
|
||
});
|
||
<span class="ident">join</span>.<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||
})</code></pre></div>
|
||
<p>This, however, will not panic:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio::runtime::Runtime</span>;
|
||
<span class="kw">use</span> <span class="ident">tokio::task</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">Runtime::new</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">local</span> <span class="op">=</span> <span class="ident">task::LocalSet::new</span>();
|
||
<span class="ident">local</span>.<span class="ident">block_on</span>(<span class="kw-2">&</span><span class="ident">rt</span>, <span class="kw">async</span> {
|
||
<span class="kw">let</span> <span class="ident">join</span> <span class="op">=</span> <span class="ident">task::spawn_local</span>(<span class="kw">async</span> {
|
||
<span class="kw">let</span> <span class="ident">blocking_result</span> <span class="op">=</span> <span class="ident">task::spawn_blocking</span>(<span class="op">|</span><span class="op">|</span> {
|
||
<span class="comment">// ...</span>
|
||
}).<span class="kw">await</span>;
|
||
<span class="comment">// ...</span>
|
||
});
|
||
<span class="ident">join</span>.<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||
})</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.run_until" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#499-508" title="goto source code">[src]</a></div><a href="#method.run_until" class="anchor"></a><h4 class="code-header">pub async fn <a href="#method.run_until" class="fnname">run_until</a><F>(&self, future: F) -> F::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>, </span></h4></div></summary><div class="docblock"><p>Runs a future to completion on the local set, returning its output.</p>
|
||
<p>This returns a future that runs the given future with a local set,
|
||
allowing it to call <a href="fn.spawn_local.html"><code>spawn_local</code></a> to spawn additional <code>!Send</code> futures.
|
||
Any local futures spawned on the local set will be driven in the
|
||
background until the future passed to <code>run_until</code> completes. When the future
|
||
passed to <code>run</code> finishes, any local futures which have not completed
|
||
will remain on the local set, and will be driven on subsequent calls to
|
||
<code>run_until</code> or when <a href="#awaiting-a-localset">awaiting the local set</a> itself.</p>
|
||
<h5 id="examples" class="section-header"><a href="#examples">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio::task</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">tokio::main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="ident">task::LocalSet::new</span>().<span class="ident">run_until</span>(<span class="kw">async</span> {
|
||
<span class="ident">task::spawn_local</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="comment">// ...</span>
|
||
}).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||
<span class="comment">// ...</span>
|
||
}).<span class="kw">await</span>;
|
||
}</code></pre></div>
|
||
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Debug" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#565-569" title="goto source code">[src]</a></div><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#566-568" title="goto source code">[src]</a></div><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Default" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#595-599" title="goto source code">[src]</a></div><a href="#impl-Default" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.default" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#596-598" title="goto source code">[src]</a></div><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><div class="notable">Notable traits for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></div><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.unit.html">()</a>;</span></code></span></div></span></span></h4></div></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Drop" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#601-624" title="goto source code">[src]</a></div><a href="#impl-Drop" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.drop" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#602-623" title="goto source code">[src]</a></div><a href="#method.drop" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/ops/drop/trait.Drop.html#tymethod.drop" class="fnname">drop</a>(&mut self)</h4></div></summary><div class='docblock'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.59.0/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Future" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#571-593" title="goto source code">[src]</a></div><a href="#impl-Future" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Output" class="type trait-impl has-srclink"><a href="#associatedtype.Output" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.unit.html">()</a></h4></div></summary><div class='docblock'><p>The type of value produced on completion.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.poll" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/task/local.rs.html#574-592" title="goto source code">[src]</a></div><a href="#method.poll" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#tymethod.poll" class="fnname">poll</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&mut </a>Self>, cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></h4></div></summary><div class='docblock'><p>Attempt to resolve the future to a final value, registering
|
||
the current task for wakeup if the value is not yet available. <a href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#tymethod.poll">Read more</a></p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl !<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl !<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl !<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl !<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#132-136" title="goto source code">[src]</a></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#133" title="goto source code">[src]</a></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#209-214" title="goto source code">[src]</a></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#211" title="goto source code">[src]</a></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&</a>T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#218-222" title="goto source code">[src]</a></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#219" title="goto source code">[src]</a></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&mut </a>T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#550-554" title="goto source code">[src]</a></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#551" title="goto source code">[src]</a></div><a href="#method.from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#538-545" title="goto source code">[src]</a></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#542" title="goto source code">[src]</a></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-IntoFuture" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/future/into_future.rs.html#21-28" title="goto source code">[src]</a></div><a href="#impl-IntoFuture" class="anchor"></a><h3 class="code-header in-band">impl<F> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Output-1" class="type trait-impl has-srclink"><a href="#associatedtype.Output-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/future/into_future/trait.IntoFuture.html#associatedtype.Output" class="associatedtype">Output</a> = <F as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a></h4></div></summary><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock'><p>The output that the future will produce on completion.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.Future" class="type trait-impl has-srclink"><a href="#associatedtype.Future" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/future/into_future/trait.IntoFuture.html#associatedtype.Future" class="associatedtype">Future</a> = F</h4></div></summary><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock'><p>Which kind of future are we turning this into?</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_future" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/future/into_future.rs.html#25" title="goto source code">[src]</a></div><a href="#method.into_future" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/future/into_future/trait.IntoFuture.html#tymethod.into_future" class="fnname">into_future</a>(self) -> <F as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/future/into_future/trait.IntoFuture.html#associatedtype.Future" title="type core::future::into_future::IntoFuture::Future">Future</a></h4></div></summary><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>into_future</code>)</div></div><div class='docblock'><p>Creates a future from a value.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#588-597" title="goto source code">[src]</a></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#594" title="goto source code">[src]</a></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#574-583" title="goto source code">[src]</a></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#580" title="goto source code">[src]</a></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |