24 lines
5.0 KiB
HTML
24 lines
5.0 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 `test` attr in crate `tokio_macros`."><meta name="keywords" content="rust, rustlang, rust-lang, test"><title>tokio_macros::test - 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: "test", 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#235-237" 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="">test</a></span></h1><pre class="rust attr">#[test]</pre><div class="docblock"><p>Marks async function to be executed by runtime, suitable to test environment</p>
|
|||
|
|
<h2 id="usage" class="section-header"><a href="#usage">Usage</a></h2><h3 id="multi-thread-runtime" class="section-header"><a href="#multi-thread-runtime">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">test</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">1</span>)]</span>
|
|||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">my_test</span>() {
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="bool-val">true</span>);
|
|||
|
|
}</pre></div>
|
|||
|
|
<h3 id="using-default" class="section-header"><a href="#using-default">Using default</a></h3>
|
|||
|
|
<p>The default test runtime 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">test</span>]</span>
|
|||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">my_test</span>() {
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="bool-val">true</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>
|