evan/ludum-dare-50
Archived
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
This repository has been archived on 2022-04-04. You can view files and clone it, but cannot push or open issues or pull requests.
ludum-dare-50/rustdoc/tokio/runtime/struct.Builder.html

244 lines
56 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Builds Tokio Runtime with custom configuration values."><meta name="keywords" content="rust, rustlang, rust-lang, Builder"><title>Builder in tokio::runtime - 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">&#9776;</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 Builder</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.build">build</a><a href="#method.enable_all">enable_all</a><a href="#method.enable_io">enable_io</a><a href="#method.enable_time">enable_time</a><a href="#method.max_blocking_threads">max_blocking_threads</a><a href="#method.new_current_thread">new_current_thread</a><a href="#method.new_multi_thread">new_multi_thread</a><a href="#method.on_thread_park">on_thread_park</a><a href="#method.on_thread_start">on_thread_start</a><a href="#method.on_thread_stop">on_thread_stop</a><a href="#method.on_thread_unpark">on_thread_unpark</a><a href="#method.thread_keep_alive">thread_keep_alive</a><a href="#method.thread_name">thread_name</a><a href="#method.thread_name_fn">thread_name_fn</a><a href="#method.thread_stack_size">thread_stack_size</a><a href="#method.worker_threads">worker_threads</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Debug">Debug</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&lt;T&gt;</a><a href="#impl-BorrowMut%3CT%3E">BorrowMut&lt;T&gt;</a><a href="#impl-From%3CT%3E">From&lt;T&gt;</a><a href="#impl-Into%3CU%3E">Into&lt;U&gt;</a><a href="#impl-TryFrom%3CU%3E">TryFrom&lt;U&gt;</a><a href="#impl-TryInto%3CU%3E">TryInto&lt;U&gt;</a></div></div><h2 class="location">Other items in<br><a href="../index.html">tokio</a>::<wbr><a href="index.html">runtime</a></h2><div id="sidebar-vars" data-name="Builder" 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">runtime</a>::<wbr><a class="struct" href="#">Builder</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">&#x2212;</span>]</a></span><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#40-81" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust struct"><code>pub struct Builder { /* fields omitted */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Builds Tokio Runtime with custom configuration values.</p>
<p>Methods can be chained in order to set the configuration values. The
Runtime is constructed by calling <a href="struct.Builder.html#method.build"><code>build</code></a>.</p>
<p>New instances of <code>Builder</code> are obtained via <a href="struct.Builder.html#method.new_multi_thread"><code>Builder::new_multi_thread</code></a>
or <a href="struct.Builder.html#method.new_current_thread"><code>Builder::new_current_thread</code></a>.</p>
<p>See function level documentation for details on the various configuration
settings.</p>
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
<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">fn</span> <span class="ident">main</span>() {
<span class="comment">// build runtime</span>
<span class="kw">let</span> <span class="ident">runtime</span> <span class="op">=</span> <span class="ident">Builder::new_multi_thread</span>()
.<span class="ident">worker_threads</span>(<span class="number">4</span>)
.<span class="ident">thread_name</span>(<span class="string">&quot;my-custom-name&quot;</span>)
.<span class="ident">thread_stack_size</span>(<span class="number">3</span> <span class="op">*</span> <span class="number">1024</span> <span class="op">*</span> <span class="number">1024</span>)
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>();
<span class="comment">// use runtime ...</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/runtime/builder.rs.html#91-587" 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.Builder.html" title="struct tokio::runtime::Builder">Builder</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new_current_thread" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#100-102" title="goto source code">[src]</a></div><a href="#method.new_current_thread" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.new_current_thread" class="fnname">new_current_thread</a>() -&gt; <a class="struct" href="struct.Builder.html" title="struct tokio::runtime::Builder">Builder</a></h4></div></summary><div class="docblock"><p>Returns a new builder with the current thread scheduler selected.</p>
<p>Configuration methods can be chained on the return value.</p>
<p>To spawn non-<code>Send</code> tasks on the resulting runtime, combine it with a
<a href="../task/struct.LocalSet.html"><code>LocalSet</code></a>.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new_multi_thread" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#109-111" title="goto source code">[src]</a></div><a href="#method.new_multi_thread" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.new_multi_thread" class="fnname">new_multi_thread</a>() -&gt; <a class="struct" href="struct.Builder.html" title="struct tokio::runtime::Builder">Builder</a></h4></div></summary><div class="docblock"><p>Returns a new builder with the multi thread scheduler selected.</p>
<p>Configuration methods can be chained on the return value.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.enable_all" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#167-174" title="goto source code">[src]</a></div><a href="#method.enable_all" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.enable_all" class="fnname">enable_all</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self</h4></div></summary><div class="docblock"><p>Enables both I/O and time drivers.</p>
<p>Doing this is a shorthand for calling <code>enable_io</code> and <code>enable_time</code>
individually. If additional components are added to Tokio in the future,
<code>enable_all</code> will include these future components.</p>
<h5 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio::runtime</span>;
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">enable_all</span>()
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.worker_threads" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#225-229" title="goto source code">[src]</a></div><a href="#method.worker_threads" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.worker_threads" class="fnname">worker_threads</a>(&amp;mut self, val: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self</h4></div></summary><div class="docblock"><p>Sets the number of worker threads the <code>Runtime</code> will use.</p>
<p>This can be any number above 0 though it is advised to keep this value
on the smaller side.</p>
<h5 id="default" class="section-header"><a href="#default">Default</a></h5>
<p>The default value is the number of cores available to the system.</p>
<h5 id="panic" class="section-header"><a href="#panic">Panic</a></h5>
<p>When using the <code>current_thread</code> runtime this method will panic, since
those variants do not allow setting worker thread counts.</p>
<h5 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h5><h6 id="multi-threaded-runtime-with-4-threads" class="section-header"><a href="#multi-threaded-runtime-with-4-threads">Multi threaded runtime with 4 threads</a></h6>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio::runtime</span>;
<span class="comment">// This will spawn a work-stealing runtime with 4 worker threads.</span>
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">worker_threads</span>(<span class="number">4</span>)
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>();
<span class="ident">rt</span>.<span class="ident">spawn</span>(<span class="kw">async</span> <span class="kw">move</span> {});</code></pre></div>
<h6 id="current-thread-runtime-will-only-run-on-the-current-thread-via-runtimeblock_on" class="section-header"><a href="#current-thread-runtime-will-only-run-on-the-current-thread-via-runtimeblock_on">Current thread runtime (will only run on the current thread via <code>Runtime::block_on</code>)</a></h6>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio::runtime</span>;
<span class="comment">// Create a runtime that _must_ be driven from a call</span>
<span class="comment">// to `Runtime::block_on`.</span>
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_current_thread</span>()
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>();
<span class="comment">// This will run the runtime and future on the current thread</span>
<span class="ident">rt</span>.<span class="ident">block_on</span>(<span class="kw">async</span> <span class="kw">move</span> {});</code></pre></div>
<h5 id="panic-1" class="section-header"><a href="#panic-1">Panic</a></h5>
<p>This will panic if <code>val</code> is not larger than <code>0</code>.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.max_blocking_threads" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#253-257" title="goto source code">[src]</a></div><a href="#method.max_blocking_threads" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.max_blocking_threads" class="fnname">max_blocking_threads</a>(&amp;mut self, val: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self</h4></div></summary><div class="docblock"><p>Specifies the limit for additional threads spawned by the Runtime.</p>
<p>These threads are used for blocking operations like tasks spawned
through <a href="../task/fn.spawn_blocking.html"><code>spawn_blocking</code></a>. Unlike the <a href="struct.Builder.html#method.worker_threads"><code>worker_threads</code></a>, they are not
always active and will exit if left idle for too long. You can change
this timeout duration with <a href="struct.Builder.html#method.thread_keep_alive"><code>thread_keep_alive</code></a>.</p>
<p>The default value is 512.</p>
<h5 id="panic-2" class="section-header"><a href="#panic-2">Panic</a></h5>
<p>This will panic if <code>val</code> is not larger than <code>0</code>.</p>
<h5 id="upgrading-from-0x" class="section-header"><a href="#upgrading-from-0x">Upgrading from 0.x</a></h5>
<p>In old versions <code>max_threads</code> limited both blocking and worker threads, but the
current <code>max_blocking_threads</code> does not include async worker threads in the count.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.thread_name" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#274-278" title="goto source code">[src]</a></div><a href="#method.thread_name" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.thread_name" class="fnname">thread_name</a>(&amp;mut self, val: impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self</h4></div></summary><div class="docblock"><p>Sets name of threads spawned by the <code>Runtime</code>’s thread pool.</p>
<p>The default name is “tokio-runtime-worker”.</p>
<h5 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">thread_name</span>(<span class="string">&quot;my-pool&quot;</span>)
.<span class="ident">build</span>();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.thread_name_fn" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#300-306" title="goto source code">[src]</a></div><a href="#method.thread_name_fn" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.thread_name_fn" class="fnname">thread_name_fn</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -&gt; <a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,&nbsp;</span></h4></div></summary><div class="docblock"><p>Sets a function used to generate the name of threads spawned by the <code>Runtime</code>’s thread pool.</p>
<p>The default name fn is <code>|| &quot;tokio-runtime-worker&quot;.into()</code>.</p>
<h5 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">thread_name_fn</span>(<span class="op">|</span><span class="op">|</span> {
<span class="kw">static</span> <span class="ident">ATOMIC_ID</span>: <span class="ident">AtomicUsize</span> <span class="op">=</span> <span class="ident">AtomicUsize::new</span>(<span class="number">0</span>);
<span class="kw">let</span> <span class="ident">id</span> <span class="op">=</span> <span class="ident">ATOMIC_ID</span>.<span class="ident">fetch_add</span>(<span class="number">1</span>, <span class="ident">Ordering::SeqCst</span>);
<span class="macro">format!</span>(<span class="string">&quot;my-pool-{}&quot;</span>, <span class="ident">id</span>)
})
.<span class="ident">build</span>();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.thread_stack_size" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#327-330" title="goto source code">[src]</a></div><a href="#method.thread_stack_size" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.thread_stack_size" class="fnname">thread_stack_size</a>(&amp;mut self, val: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self</h4></div></summary><div class="docblock"><p>Sets the stack size (in bytes) for worker threads.</p>
<p>The actual stack size may be greater than this value if the platform
specifies minimal stack size.</p>
<p>The default stack size for spawned threads is 2 MiB, though this
particular stack size is subject to change in the future.</p>
<h5 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">thread_stack_size</span>(<span class="number">32</span> <span class="op">*</span> <span class="number">1024</span>)
.<span class="ident">build</span>();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.on_thread_start" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#351-357" title="goto source code">[src]</a></div><a href="#method.on_thread_start" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.on_thread_start" class="fnname">on_thread_start</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,&nbsp;</span></h4></div></summary><div class="docblock"><p>Executes function <code>f</code> after each thread is started but before it starts
doing work.</p>
<p>This is intended for bookkeeping and monitoring use cases.</p>
<h5 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let</span> <span class="ident">runtime</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">on_thread_start</span>(<span class="op">|</span><span class="op">|</span> {
<span class="macro">println!</span>(<span class="string">&quot;thread started&quot;</span>);
})
.<span class="ident">build</span>();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.on_thread_stop" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#377-383" title="goto source code">[src]</a></div><a href="#method.on_thread_stop" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.on_thread_stop" class="fnname">on_thread_stop</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,&nbsp;</span></h4></div></summary><div class="docblock"><p>Executes function <code>f</code> before each thread stops.</p>
<p>This is intended for bookkeeping and monitoring use cases.</p>
<h5 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let</span> <span class="ident">runtime</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">on_thread_stop</span>(<span class="op">|</span><span class="op">|</span> {
<span class="macro">println!</span>(<span class="string">&quot;thread stopping&quot;</span>);
})
.<span class="ident">build</span>();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.on_thread_park" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#455-461" title="goto source code">[src]</a></div><a href="#method.on_thread_park" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.on_thread_park" class="fnname">on_thread_park</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,&nbsp;</span></h4></div></summary><div class="docblock"><p>Executes function <code>f</code> just before a thread is parked (goes idle).
<code>f</code> is called within the Tokio context, so functions like <a href="../task/fn.spawn.html"><code>tokio::spawn</code></a>
can be called, and may result in this thread being unparked immediately.</p>
<p>This can be used to start work only when the executor is idle, or for bookkeeping
and monitoring purposes.</p>
<p>Note: There can only be one park callback for a runtime; calling this function
more than once replaces the last callback defined, rather than adding to it.</p>
<h5 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h5><h6 id="multithreaded-executor" class="section-header"><a href="#multithreaded-executor">Multithreaded executor</a></h6>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">once</span> <span class="op">=</span> <span class="ident">AtomicBool::new</span>(<span class="bool-val">true</span>);
<span class="kw">let</span> <span class="ident">barrier</span> <span class="op">=</span> <span class="ident">Arc::new</span>(<span class="ident">Barrier::new</span>(<span class="number">2</span>));
<span class="kw">let</span> <span class="ident">runtime</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">worker_threads</span>(<span class="number">1</span>)
.<span class="ident">on_thread_park</span>({
<span class="kw">let</span> <span class="ident">barrier</span> <span class="op">=</span> <span class="ident">barrier</span>.<span class="ident">clone</span>();
<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
<span class="kw">let</span> <span class="ident">barrier</span> <span class="op">=</span> <span class="ident">barrier</span>.<span class="ident">clone</span>();
<span class="kw">if</span> <span class="ident">once</span>.<span class="ident">swap</span>(<span class="bool-val">false</span>, <span class="ident">Ordering::Relaxed</span>) {
<span class="ident">tokio::spawn</span>(<span class="kw">async</span> <span class="kw">move</span> { <span class="ident">barrier</span>.<span class="ident">wait</span>().<span class="kw">await</span>; });
}
}
})
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>();
<span class="ident">runtime</span>.<span class="ident">block_on</span>(<span class="kw">async</span> {
<span class="ident">barrier</span>.<span class="ident">wait</span>().<span class="kw">await</span>;
})</code></pre></div>
<h6 id="current-thread-executor" class="section-header"><a href="#current-thread-executor">Current thread executor</a></h6>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">once</span> <span class="op">=</span> <span class="ident">AtomicBool::new</span>(<span class="bool-val">true</span>);
<span class="kw">let</span> <span class="ident">barrier</span> <span class="op">=</span> <span class="ident">Arc::new</span>(<span class="ident">Barrier::new</span>(<span class="number">2</span>));
<span class="kw">let</span> <span class="ident">runtime</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_current_thread</span>()
.<span class="ident">on_thread_park</span>({
<span class="kw">let</span> <span class="ident">barrier</span> <span class="op">=</span> <span class="ident">barrier</span>.<span class="ident">clone</span>();
<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
<span class="kw">let</span> <span class="ident">barrier</span> <span class="op">=</span> <span class="ident">barrier</span>.<span class="ident">clone</span>();
<span class="kw">if</span> <span class="ident">once</span>.<span class="ident">swap</span>(<span class="bool-val">false</span>, <span class="ident">Ordering::Relaxed</span>) {
<span class="ident">tokio::spawn</span>(<span class="kw">async</span> <span class="kw">move</span> { <span class="ident">barrier</span>.<span class="ident">wait</span>().<span class="kw">await</span>; });
}
}
})
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>();
<span class="ident">runtime</span>.<span class="ident">block_on</span>(<span class="kw">async</span> {
<span class="ident">barrier</span>.<span class="ident">wait</span>().<span class="kw">await</span>;
})</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.on_thread_unpark" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#491-497" title="goto source code">[src]</a></div><a href="#method.on_thread_unpark" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.on_thread_unpark" class="fnname">on_thread_unpark</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,&nbsp;</span></h4></div></summary><div class="docblock"><p>Executes function <code>f</code> just after a thread unparks (starts executing tasks).</p>
<p>This is intended for bookkeeping and monitoring use cases; note that work
in this callback will increase latencies when the application has allowed one or
more runtime threads to go idle.</p>
<p>Note: There can only be one unpark callback for a runtime; calling this function
more than once replaces the last callback defined, rather than adding to it.</p>
<h5 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let</span> <span class="ident">runtime</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">on_thread_unpark</span>(<span class="op">|</span><span class="op">|</span> {
<span class="macro">println!</span>(<span class="string">&quot;thread unparking&quot;</span>);
})
.<span class="ident">build</span>();
<span class="ident">runtime</span>.<span class="ident">unwrap</span>().<span class="ident">block_on</span>(<span class="kw">async</span> {
<span class="ident">tokio::task::yield_now</span>().<span class="kw">await</span>;
<span class="macro">println!</span>(<span class="string">&quot;Hello from Tokio!&quot;</span>);
})</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.build" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#514-520" title="goto source code">[src]</a></div><a href="#method.build" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.build" class="fnname">build</a>(&amp;mut self) -&gt; <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="struct" href="struct.Runtime.html" title="struct tokio::runtime::Runtime">Runtime</a>&gt;</h4></div></summary><div class="docblock"><p>Creates the configured <code>Runtime</code>.</p>
<p>The returned <code>Runtime</code> instance is ready to spawn tasks.</p>
<h5 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h5>
<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">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">Builder::new_multi_thread</span>().<span class="ident">build</span>().<span class="ident">unwrap</span>();
<span class="ident">rt</span>.<span class="ident">block_on</span>(<span class="kw">async</span> {
<span class="macro">println!</span>(<span class="string">&quot;Hello from the Tokio runtime&quot;</span>);
});</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.thread_keep_alive" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#552-555" title="goto source code">[src]</a></div><a href="#method.thread_keep_alive" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.thread_keep_alive" class="fnname">thread_keep_alive</a>(&amp;mut self, duration: <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self</h4></div></summary><div class="docblock"><p>Sets a custom timeout for a thread in the blocking pool.</p>
<p>By default, the timeout for a thread is set to 10 seconds. This can
be overridden using .thread_keep_alive().</p>
<h5 id="example" class="section-header"><a href="#example">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">thread_keep_alive</span>(<span class="ident">Duration::from_millis</span>(<span class="number">100</span>))
.<span class="ident">build</span>();</code></pre></div>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#590-610" title="goto source code">[src]</a></div><a href="#impl-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.Builder.html" title="struct tokio::runtime::Builder">Builder</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.enable_io" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#606-609" title="goto source code">[src]</a></div><a href="#method.enable_io" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.enable_io" class="fnname">enable_io</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self</h4></div></summary><div class="docblock"><p>Enables the I/O driver.</p>
<p>Doing this enables using net, process, signal, and some I/O types on
the runtime.</p>
<h5 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio::runtime</span>;
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">enable_io</span>()
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>();</code></pre></div>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-2" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#614-633" title="goto source code">[src]</a></div><a href="#impl-2" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.Builder.html" title="struct tokio::runtime::Builder">Builder</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.enable_time" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/tokio/runtime/builder.rs.html#629-632" title="goto source code">[src]</a></div><a href="#method.enable_time" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.enable_time" class="fnname">enable_time</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;mut </a>Self</h4></div></summary><div class="docblock"><p>Enables the time driver.</p>
<p>Doing this enables using <code>tokio::time</code> on the runtime.</p>
<h5 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio::runtime</span>;
<span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">runtime::Builder::new_multi_thread</span>()
.<span class="ident">enable_time</span>()
.<span class="ident">build</span>()
.<span class="ident">unwrap</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/runtime/builder.rs.html#702-718" 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.Builder.html" title="struct tokio::runtime::Builder">Builder</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/runtime/builder.rs.html#703-717" 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>(&amp;self, fmt: &amp;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>&lt;'_&gt;) -&gt; <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></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.Builder.html" title="struct tokio::runtime::Builder">Builder</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.Builder.html" title="struct tokio::runtime::Builder">Builder</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.Builder.html" title="struct tokio::runtime::Builder">Builder</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.Builder.html" title="struct tokio::runtime::Builder">Builder</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.Builder.html" title="struct tokio::runtime::Builder">Builder</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&lt;T&gt; <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>&nbsp;&nbsp;&nbsp;&nbsp;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>,&nbsp;</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>(&amp;self) -&gt; <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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>,&nbsp;</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>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;</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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>,&nbsp;</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>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&amp;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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; 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) -&gt; 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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>&lt;T&gt;,&nbsp;</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) -&gt; 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-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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>&lt;T&gt;,&nbsp;</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) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;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>&lt;U&gt;&gt;::<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>&gt;</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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>&lt;T&gt;,&nbsp;</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> = &lt;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>&lt;T&gt;&gt;::<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) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;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>&lt;T&gt;&gt;::<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>&gt;</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>
Reference in New Issue View Git Blame Copy Permalink