97 lines
10 KiB
HTML
97 lines
10 KiB
HTML
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `main` attr in crate `tokio_macros`."><meta name="keywords" content="rust, rustlang, rust-lang, main"><title>tokio_macros::main - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
|||
|
|
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
|||
|
|
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc attr"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../tokio_macros/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="index.html">tokio_macros</a></p><script>window.sidebarCurrent = {name: "main", ty: "attr", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><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" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
|
|||
|
|
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/tokio_macros/lib.rs.html#155-157" title="goto source code">[src]</a></span><span class="in-band">Attribute Macro <a href="index.html">tokio_macros</a>::<wbr><a class="attr" href="">main</a></span></h1><pre class="rust attr">#[main]</pre><div class="docblock"><p>Marks async function to be executed by the selected runtime. This macro
|
|||
|
|
helps set up a <code>Runtime</code> without requiring the user to use
|
|||
|
|
<a href="../tokio/runtime/struct.Runtime.html">Runtime</a> or
|
|||
|
|
<a href="../tokio/runtime/struct.Builder.html">Builder</a> directly.</p>
|
|||
|
|
<p>Note: This macro is designed to be simplistic and targets applications that
|
|||
|
|
do not require a complex setup. If the provided functionality is not
|
|||
|
|
sufficient, you may be interested in using
|
|||
|
|
<a href="../tokio/runtime/struct.Builder.html">Builder</a>, which provides a more
|
|||
|
|
powerful interface.</p>
|
|||
|
|
<p>Note: This macro can be used on any function and not just the <code>main</code>
|
|||
|
|
function. Using it on a non-main function makes the function behave as if it
|
|||
|
|
was synchronous by starting a new runtime each time it is called. If the
|
|||
|
|
function is called often, it is preferable to create the runtime using the
|
|||
|
|
runtime builder so the runtime can be reused across calls.</p>
|
|||
|
|
<h1 id="multi-threaded-runtime" class="section-header"><a href="#multi-threaded-runtime">Multi-threaded runtime</a></h1>
|
|||
|
|
<p>To use the multi-threaded runtime, the macro can be configured using</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>(<span class="ident">flavor</span> <span class="op">=</span> <span class="string">"multi_thread"</span>, <span class="ident">worker_threads</span> <span class="op">=</span> <span class="number">10</span>)]</span></pre></div>
|
|||
|
|
<p>The <code>worker_threads</code> option configures the number of worker threads, and
|
|||
|
|
defaults to the number of cpus on the system. This is the default flavor.</p>
|
|||
|
|
<p>Note: The multi-threaded runtime requires the <code>rt-multi-thread</code> feature
|
|||
|
|
flag.</p>
|
|||
|
|
<h1 id="current-thread-runtime" class="section-header"><a href="#current-thread-runtime">Current thread runtime</a></h1>
|
|||
|
|
<p>To use the single-threaded runtime known as the <code>current_thread</code> runtime,
|
|||
|
|
the macro can be configured using</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>(<span class="ident">flavor</span> <span class="op">=</span> <span class="string">"current_thread"</span>)]</span></pre></div>
|
|||
|
|
<h2 id="function-arguments" class="section-header"><a href="#function-arguments">Function arguments:</a></h2>
|
|||
|
|
<p>Arguments are allowed for any functions aside from <code>main</code> which is special</p>
|
|||
|
|
<h2 id="usage" class="section-header"><a href="#usage">Usage</a></h2><h3 id="using-the-multi-thread-runtime" class="section-header"><a href="#using-the-multi-thread-runtime">Using the multi-thread runtime</a></h3>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
|||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Hello world"</span>);
|
|||
|
|
}</pre></div>
|
|||
|
|
<p>Equivalent code not using <code>#[tokio::main]</code></p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="ident">tokio</span>::<span class="ident">runtime</span>::<span class="ident">Builder</span>::<span class="ident">new_multi_thread</span>()
|
|||
|
|
.<span class="ident">enable_all</span>()
|
|||
|
|
.<span class="ident">build</span>()
|
|||
|
|
.<span class="ident">unwrap</span>()
|
|||
|
|
.<span class="ident">block_on</span>(<span class="ident">async</span> {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Hello world"</span>);
|
|||
|
|
})
|
|||
|
|
}</pre></div>
|
|||
|
|
<h3 id="using-current-thread-runtime" class="section-header"><a href="#using-current-thread-runtime">Using current thread runtime</a></h3>
|
|||
|
|
<p>The basic scheduler is single-threaded.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>(<span class="ident">flavor</span> <span class="op">=</span> <span class="string">"current_thread"</span>)]</span>
|
|||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Hello world"</span>);
|
|||
|
|
}</pre></div>
|
|||
|
|
<p>Equivalent code not using <code>#[tokio::main]</code></p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="ident">tokio</span>::<span class="ident">runtime</span>::<span class="ident">Builder</span>::<span class="ident">new_current_thread</span>()
|
|||
|
|
.<span class="ident">enable_all</span>()
|
|||
|
|
.<span class="ident">build</span>()
|
|||
|
|
.<span class="ident">unwrap</span>()
|
|||
|
|
.<span class="ident">block_on</span>(<span class="ident">async</span> {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Hello world"</span>);
|
|||
|
|
})
|
|||
|
|
}</pre></div>
|
|||
|
|
<h3 id="set-number-of-worker-threads" class="section-header"><a href="#set-number-of-worker-threads">Set number of worker threads</a></h3>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>(<span class="ident">worker_threads</span> <span class="op">=</span> <span class="number">2</span>)]</span>
|
|||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Hello world"</span>);
|
|||
|
|
}</pre></div>
|
|||
|
|
<p>Equivalent code not using <code>#[tokio::main]</code></p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="ident">tokio</span>::<span class="ident">runtime</span>::<span class="ident">Builder</span>::<span class="ident">new_multi_thread</span>()
|
|||
|
|
.<span class="ident">worker_threads</span>(<span class="number">2</span>)
|
|||
|
|
.<span class="ident">enable_all</span>()
|
|||
|
|
.<span class="ident">build</span>()
|
|||
|
|
.<span class="ident">unwrap</span>()
|
|||
|
|
.<span class="ident">block_on</span>(<span class="ident">async</span> {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Hello world"</span>);
|
|||
|
|
})
|
|||
|
|
}</pre></div>
|
|||
|
|
<h3 id="note" class="section-header"><a href="#note">NOTE:</a></h3>
|
|||
|
|
<p>If you rename the Tokio crate in your dependencies this macro will not work.
|
|||
|
|
If you must rename the current version of Tokio because you're also using an
|
|||
|
|
older version of Tokio, you <em>must</em> make the current version of Tokio
|
|||
|
|
available as <code>tokio</code> in the module where this macro is expanded.</p>
|
|||
|
|
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "tokio_macros";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|