286 lines
52 KiB
HTML
286 lines
52 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."><title>LocalSet in tokio::task - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="tokio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">LocalSet</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../tokio/index.html">tokio</a><span class="version">1.49.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Local<wbr>Set</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#use-with-run_until" title="Use with `run_until`">Use with <code>run_until</code></a><ul><li><a href="#awaiting-a-localset" title="Awaiting a `LocalSet`">Awaiting a <code>LocalSet</code></a></li><li><a href="#use-inside-tokiospawn" title="Use inside `tokio::spawn`">Use inside <code>tokio::spawn</code></a></li></ul></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.block_on" title="block_on">block_on</a></li><li><a href="#method.enter" title="enter">enter</a></li><li><a href="#method.id" title="id">id</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.run_until" title="run_until">run_until</a></li><li><a href="#method.spawn_local" title="spawn_local">spawn_local</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-LocalSet" title="Debug">Debug</a></li><li><a href="#impl-Default-for-LocalSet" title="Default">Default</a></li><li><a href="#impl-Drop-for-LocalSet" title="Drop">Drop</a></li><li><a href="#impl-Future-for-LocalSet" title="Future">Future</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-LocalSet" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-LocalSet" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-LocalSet" title="!Send">!Send</a></li><li><a href="#impl-Sync-for-LocalSet" title="!Sync">!Sync</a></li><li><a href="#impl-UnwindSafe-for-LocalSet" title="!UnwindSafe">!UnwindSafe</a></li><li><a href="#impl-Unpin-for-LocalSet" title="Unpin">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-IntoFuture-for-F" title="IntoFuture">IntoFuture</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In tokio::<wbr>task</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">tokio</a>::<wbr><a href="index.html">task</a></div><h1>Struct <span class="struct">Local<wbr>Set</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/tokio/task/local.rs.html#224-233">Source</a> </span></div><pre class="rust item-decl"><code>pub struct LocalSet { <span class="comment">/* private fields */</span> }</code></pre><details class="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.93.1/core/marker/trait.Send.html" title="trait core::marker::Send"><code>Send</code></a> and thus are unsafe to send between threads. In these
|
||
cases, a <a href="struct.LocalSet.html" title="struct tokio::task::LocalSet">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="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::rc::Rc;
|
||
|
||
<span class="attr">#[tokio::main]
|
||
</span><span class="kw">async fn </span>main() {
|
||
<span class="comment">// `Rc` does not implement `Send`, and thus may not be sent between
|
||
// threads safely.
|
||
</span><span class="kw">let </span>nonsend_data = Rc::new(<span class="string">"my nonsend data..."</span>);
|
||
|
||
<span class="kw">let </span>nonsend_data = nonsend_data.clone();
|
||
<span class="comment">// Because the `async` block here moves `nonsend_data`, the future is `!Send`.
|
||
// Since `tokio::spawn` requires the spawned future to implement `Send`, this
|
||
// will not compile.
|
||
</span>tokio::spawn(<span class="kw">async move </span>{
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, nonsend_data);
|
||
<span class="comment">// ...
|
||
</span>}).<span class="kw">await</span>.unwrap();
|
||
}</code></pre></div><h2 id="use-with-run_until"><a class="doc-anchor" href="#use-with-run_until">§</a>Use with <code>run_until</code></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" title="method tokio::runtime::Runtime::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" title="fn tokio::task::spawn_local"><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>std::rc::Rc;
|
||
<span class="kw">use </span>tokio::task;
|
||
|
||
<span class="kw">let </span>nonsend_data = Rc::new(<span class="string">"my nonsend data..."</span>);
|
||
|
||
<span class="comment">// Construct a local task set that can run `!Send` futures.
|
||
</span><span class="kw">let </span>local = task::LocalSet::new();
|
||
|
||
<span class="comment">// Run the local task set.
|
||
</span>local.run_until(<span class="kw">async move </span>{
|
||
<span class="kw">let </span>nonsend_data = nonsend_data.clone();
|
||
<span class="comment">// `spawn_local` ensures that the future is spawned on the local
|
||
// task set.
|
||
</span>task::spawn_local(<span class="kw">async move </span>{
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, nonsend_data);
|
||
<span class="comment">// ...
|
||
</span>}).<span class="kw">await</span>.unwrap();
|
||
}).<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" title="method tokio::runtime::Runtime::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"><a class="doc-anchor" href="#awaiting-a-localset">§</a>Awaiting a <code>LocalSet</code></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>tokio::{task, time};
|
||
<span class="kw">use </span>std::rc::Rc;
|
||
|
||
<span class="kw">let </span>nonsend_data = Rc::new(<span class="string">"world"</span>);
|
||
<span class="kw">let </span>local = task::LocalSet::new();
|
||
|
||
<span class="kw">let </span>nonsend_data2 = nonsend_data.clone();
|
||
local.spawn_local(<span class="kw">async move </span>{
|
||
<span class="comment">// ...
|
||
</span><span class="macro">println!</span>(<span class="string">"hello {}"</span>, nonsend_data2)
|
||
});
|
||
|
||
local.spawn_local(<span class="kw">async move </span>{
|
||
time::sleep(time::Duration::from_millis(<span class="number">100</span>)).<span class="kw">await</span>;
|
||
<span class="macro">println!</span>(<span class="string">"goodbye {}"</span>, nonsend_data)
|
||
});
|
||
|
||
<span class="comment">// ...
|
||
|
||
</span>local.<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" title="method tokio::runtime::Runtime::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"><a class="doc-anchor" href="#use-inside-tokiospawn">§</a>Use inside <code>tokio::spawn</code></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="../sync/mpsc/index.html" title="mod tokio::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>tokio::runtime::Builder;
|
||
<span class="kw">use </span>tokio::sync::{mpsc, oneshot};
|
||
<span class="kw">use </span>tokio::task::LocalSet;
|
||
|
||
<span class="comment">// This struct describes the task you want to spawn. Here we include
|
||
// some simple examples. The oneshot channel allows sending a response
|
||
// to the spawner.
|
||
</span><span class="attr">#[derive(Debug)]
|
||
</span><span class="kw">enum </span>Task {
|
||
PrintNumber(u32),
|
||
AddOne(u32, oneshot::Sender<u32>),
|
||
}
|
||
|
||
<span class="attr">#[derive(Clone)]
|
||
</span><span class="kw">struct </span>LocalSpawner {
|
||
send: mpsc::UnboundedSender<Task>,
|
||
}
|
||
|
||
<span class="kw">impl </span>LocalSpawner {
|
||
<span class="kw">pub fn </span>new() -> <span class="self">Self </span>{
|
||
<span class="kw">let </span>(send, <span class="kw-2">mut </span>recv) = mpsc::unbounded_channel();
|
||
|
||
<span class="kw">let </span>rt = Builder::new_current_thread()
|
||
.enable_all()
|
||
.build()
|
||
.unwrap();
|
||
|
||
std::thread::spawn(<span class="kw">move </span>|| {
|
||
<span class="kw">let </span>local = LocalSet::new();
|
||
|
||
local.spawn_local(<span class="kw">async move </span>{
|
||
<span class="kw">while let </span><span class="prelude-val">Some</span>(new_task) = recv.recv().<span class="kw">await </span>{
|
||
tokio::task::spawn_local(run_task(new_task));
|
||
}
|
||
<span class="comment">// If the while loop returns, then all the LocalSpawner
|
||
// objects have been dropped.
|
||
</span>});
|
||
|
||
<span class="comment">// This will return once all senders are dropped and all
|
||
// spawned tasks have returned.
|
||
</span>rt.block_on(local);
|
||
});
|
||
|
||
<span class="self">Self </span>{
|
||
send,
|
||
}
|
||
}
|
||
|
||
<span class="kw">pub fn </span>spawn(<span class="kw-2">&</span><span class="self">self</span>, task: Task) {
|
||
<span class="self">self</span>.send.send(task).expect(<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,
|
||
// but it could be anything.
|
||
//
|
||
// The Task struct is an enum to support spawning many different kinds
|
||
// of operations.
|
||
</span><span class="kw">async fn </span>run_task(task: Task) {
|
||
<span class="kw">match </span>task {
|
||
Task::PrintNumber(n) => {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, n);
|
||
},
|
||
Task::AddOne(n, response) => {
|
||
<span class="comment">// We ignore failures to send the response.
|
||
</span><span class="kw">let _ </span>= response.send(n + <span class="number">1</span>);
|
||
},
|
||
}
|
||
}
|
||
|
||
<span class="attr">#[tokio::main]
|
||
</span><span class="kw">async fn </span>main() {
|
||
<span class="kw">let </span>spawner = LocalSpawner::new();
|
||
|
||
<span class="kw">let </span>(send, response) = oneshot::channel();
|
||
spawner.spawn(Task::AddOne(<span class="number">10</span>, send));
|
||
<span class="kw">let </span>eleven = response.<span class="kw">await</span>.unwrap();
|
||
<span class="macro">assert_eq!</span>(eleven, <span class="number">11</span>);
|
||
}</code></pre></div></div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-LocalSet" class="impl"><a class="src rightside" href="../../src/tokio/task/local.rs.html#505-865">Source</a><a href="#impl-LocalSet" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/tokio/task/local.rs.html#507-528">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -> <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a> <a href="#" class="tooltip" data-notable-ty="LocalSet">ⓘ</a></h4></section></summary><div class="docblock"><p>Returns a new local task set.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.enter" class="method"><a class="src rightside" href="../../src/tokio/task/local.rs.html#536-551">Source</a><h4 class="code-header">pub fn <a href="#method.enter" class="fn">enter</a>(&self) -> <a class="struct" href="struct.LocalEnterGuard.html" title="struct tokio::task::LocalEnterGuard">LocalEnterGuard</a></h4></section></summary><div class="docblock"><p>Enters the context of this <code>LocalSet</code>.</p>
|
||
<p>The <a href="fn.spawn_local.html" title="fn tokio::task::spawn_local"><code>spawn_local</code></a> method will spawn tasks on the <code>LocalSet</code> whose
|
||
context you are inside.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.spawn_local" class="method"><a class="src rightside" href="../../src/tokio/task/local.rs.html#595-606">Source</a><h4 class="code-header">pub fn <a href="#method.spawn_local" class="fn">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.93.1/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>> <a href="#" class="tooltip" data-notable-ty="JoinHandle<F::Output>">ⓘ</a><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + 'static,
|
||
F::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>: 'static,</div></h4></section></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" title="fn tokio::task::spawn_local"><code>spawn_local</code></a>, this method may be used to
|
||
spawn local tasks when the <code>LocalSet</code> is <em>not</em> running. The provided
|
||
future will start running once the <code>LocalSet</code> is next started, even if
|
||
you don’t await the returned <code>JoinHandle</code>.</p>
|
||
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task;
|
||
|
||
<span class="kw">let </span>local = task::LocalSet::new();
|
||
|
||
<span class="comment">// Spawn a future on the local set. This future will be run when
|
||
// we call `run_until` to drive the task set.
|
||
</span>local.spawn_local(<span class="kw">async </span>{
|
||
<span class="comment">// ...
|
||
</span>});
|
||
|
||
<span class="comment">// Run the local task set.
|
||
</span>local.run_until(<span class="kw">async move </span>{
|
||
<span class="comment">// ...
|
||
</span>}).<span class="kw">await</span>;
|
||
|
||
<span class="comment">// When `run` finishes, we can spawn _more_ futures, which will
|
||
// run in subsequent calls to `run_until`.
|
||
</span>local.spawn_local(<span class="kw">async </span>{
|
||
<span class="comment">// ...
|
||
</span>});
|
||
|
||
local.run_until(<span class="kw">async move </span>{
|
||
<span class="comment">// ...
|
||
</span>}).<span class="kw">await</span>;</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.block_on" class="method"><a class="src rightside" href="../../src/tokio/task/local.rs.html#676-681">Source</a><h4 class="code-header">pub fn <a href="#method.block_on" class="fn">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.93.1/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>,</div></h4></section></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" title="fn tokio::task::spawn_local"><code>spawn_local</code></a> to <code>spawn_local</code> additional local futures on the
|
||
current thread.</p>
|
||
<p>This method should not be called from an asynchronous context.</p>
|
||
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</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"><a class="doc-anchor" href="#notes">§</a>Notes</h5>
|
||
<p>Since this function internally calls <a href="../runtime/struct.Runtime.html#method.block_on" title="method tokio::runtime::Runtime::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" title="fn tokio::task::block_in_place">in-place blocking</a>. If a blocking call needs to be
|
||
issued from a local task, the <a href="fn.spawn_blocking.html" title="fn tokio::task::spawn_blocking"><code>spawn_blocking</code></a> API may be used instead.</p>
|
||
<p>For example, this will panic:</p>
|
||
|
||
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested on wasm">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::runtime::Runtime;
|
||
<span class="kw">use </span>tokio::task;
|
||
|
||
<span class="kw">let </span>rt = Runtime::new().unwrap();
|
||
<span class="kw">let </span>local = task::LocalSet::new();
|
||
local.block_on(<span class="kw-2">&</span>rt, <span class="kw">async </span>{
|
||
<span class="kw">let </span>join = task::spawn_local(<span class="kw">async </span>{
|
||
<span class="kw">let </span>blocking_result = task::block_in_place(|| {
|
||
<span class="comment">// ...
|
||
</span>});
|
||
<span class="comment">// ...
|
||
</span>});
|
||
join.<span class="kw">await</span>.unwrap();
|
||
})</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>tokio::runtime::Runtime;
|
||
<span class="kw">use </span>tokio::task;
|
||
|
||
<span class="kw">let </span>rt = Runtime::new().unwrap();
|
||
<span class="kw">let </span>local = task::LocalSet::new();
|
||
local.block_on(<span class="kw-2">&</span>rt, <span class="kw">async </span>{
|
||
<span class="kw">let </span>join = task::spawn_local(<span class="kw">async </span>{
|
||
<span class="kw">let </span>blocking_result = task::spawn_blocking(|| {
|
||
<span class="comment">// ...
|
||
</span>}).<span class="kw">await</span>;
|
||
<span class="comment">// ...
|
||
</span>});
|
||
join.<span class="kw">await</span>.unwrap();
|
||
})</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.run_until" class="method"><a class="src rightside" href="../../src/tokio/task/local.rs.html#715-724">Source</a><h4 class="code-header">pub async fn <a href="#method.run_until" class="fn">run_until</a><F>(&self, future: F) -> F::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>,</div></h4></section></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" title="fn tokio::task::spawn_local"><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_until</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="cancel-safety"><a class="doc-anchor" href="#cancel-safety">§</a>Cancel safety</h5>
|
||
<p>This method is cancel safe when <code>future</code> is cancel safe.</p>
|
||
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task;
|
||
|
||
task::LocalSet::new().run_until(<span class="kw">async </span>{
|
||
task::spawn_local(<span class="kw">async move </span>{
|
||
<span class="comment">// ...
|
||
</span>}).<span class="kw">await</span>.unwrap();
|
||
<span class="comment">// ...
|
||
</span>}).<span class="kw">await</span>;</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.id" class="method"><a class="src rightside" href="../../src/tokio/task/local.rs.html#862-864">Source</a><h4 class="code-header">pub fn <a href="#method.id" class="fn">id</a>(&self) -> <a class="struct" href="../runtime/struct.Id.html" title="struct tokio::runtime::Id">Id</a></h4></section></summary><div class="docblock"><p>Returns the <a href="../runtime/struct.Id.html" title="struct tokio::runtime::Id"><code>Id</code></a> of the current <a href="struct.LocalSet.html" title="struct tokio::task::LocalSet"><code>LocalSet</code></a> runtime.</p>
|
||
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task;
|
||
|
||
<span class="kw">let </span>local_set = task::LocalSet::new();
|
||
<span class="macro">println!</span>(<span class="string">"Local set id: {}"</span>, local_set.id());</code></pre></div></div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-LocalSet" class="impl"><a class="src rightside" href="../../src/tokio/task/local.rs.html#938-942">Source</a><a href="#impl-Debug-for-LocalSet" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/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></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/tokio/task/local.rs.html#939-941">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-LocalSet" class="impl"><a class="src rightside" href="../../src/tokio/task/local.rs.html#973-977">Source</a><a href="#impl-Default-for-LocalSet" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/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></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../../src/tokio/task/local.rs.html#974-976">Source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a> <a href="#" class="tooltip" data-notable-ty="LocalSet">ⓘ</a></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Drop-for-LocalSet" class="impl"><a class="src rightside" href="../../src/tokio/task/local.rs.html#979-1025">Source</a><a href="#impl-Drop-for-LocalSet" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/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></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../../src/tokio/task/local.rs.html#980-1024">Source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.93.1/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Future-for-LocalSet" class="impl"><a class="src rightside" href="../../src/tokio/task/local.rs.html#944-971">Source</a><a href="#impl-Future-for-LocalSet" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/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></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a class="src rightside" href="../../src/tokio/task/local.rs.html#945">Source</a><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a></h4></section></summary><div class='docblock'>The type of value produced on completion.</div></details><details class="toggle method-toggle" open><summary><section id="method.poll" class="method trait-impl"><a class="src rightside" href="../../src/tokio/task/local.rs.html#947-970">Source</a><a href="#method.poll" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html#tymethod.poll" class="fn">poll</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>, cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/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.93.1/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></h4></section></summary><div class='docblock'>Attempts 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.93.1/core/future/future/trait.Future.html#tymethod.poll">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-LocalSet" class="impl"><a href="#impl-Freeze-for-LocalSet" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a></h3></section><section id="impl-RefUnwindSafe-for-LocalSet" class="impl"><a href="#impl-RefUnwindSafe-for-LocalSet" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.93.1/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></section><section id="impl-Send-for-LocalSet" class="impl"><a href="#impl-Send-for-LocalSet" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.93.1/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></section><section id="impl-Sync-for-LocalSet" class="impl"><a href="#impl-Sync-for-LocalSet" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.93.1/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></section><section id="impl-Unpin-for-LocalSet" class="impl"><a href="#impl-Unpin-for-LocalSet" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/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></section><section id="impl-UnwindSafe-for-LocalSet" class="impl"><a href="#impl-UnwindSafe-for-LocalSet" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.93.1/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></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoFuture-for-F" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/future/into_future.rs.html#138">Source</a><a href="#impl-IntoFuture-for-F" class="anchor">§</a><h3 class="code-header">impl<F> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a> for F<div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Output-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/future/into_future.rs.html#139">Source</a><a href="#associatedtype.Output-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/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.93.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a></h4></section></summary><div class='docblock'>The output that the future will produce on completion.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoFuture" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/future/into_future.rs.html#140">Source</a><a href="#associatedtype.IntoFuture" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/future/into_future/trait.IntoFuture.html#associatedtype.IntoFuture" class="associatedtype">IntoFuture</a> = F</h4></section></summary><div class='docblock'>Which kind of future are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_future" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/future/into_future.rs.html#142">Source</a><a href="#method.into_future" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/future/into_future/trait.IntoFuture.html#tymethod.into_future" class="fn">into_future</a>(self) -> <F as <a class="trait" href="https://doc.rust-lang.org/1.93.1/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.93.1/core/future/into_future/trait.IntoFuture.html#associatedtype.IntoFuture" title="type core::future::into_future::IntoFuture::IntoFuture">IntoFuture</a></h4></section></summary><div class='docblock'>Creates a future from a value. <a href="https://doc.rust-lang.org/1.93.1/core/future/into_future/trait.IntoFuture.html#tymethod.into_future">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/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.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/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.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div><script type="text/json" id="notable-traits-data">{"JoinHandle<F::Output>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.JoinHandle.html\" title=\"struct tokio::task::JoinHandle\">JoinHandle</a><T></code></h3><pre><code><div class=\"where\">impl<T> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/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></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html#associatedtype.Output\" class=\"associatedtype\">Output</a> = <a class=\"enum\" href=\"https://doc.rust-lang.org/1.93.1/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>>;</div>","LocalSet":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.LocalSet.html\" title=\"struct tokio::task::LocalSet\">LocalSet</a></code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/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></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.93.1/core/future/future/trait.Future.html#associatedtype.Output\" class=\"associatedtype\">Output</a> = <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.93.1/std/primitive.unit.html\">()</a>;</div>"}</script></section></div></main></body></html> |