Adding large folders

This commit is contained in:
2026-02-26 12:00:21 -05:00
parent 5400d82acd
commit 49701c85ad
47332 changed files with 1942573 additions and 0 deletions

View File

@@ -0,0 +1,724 @@
<!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="Source of the Rust file `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/tokio-macros-2.6.0/src/entry.rs`."><title>entry.rs - source</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_macros" 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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[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="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">tokio_macros/</div>entry.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>proc_macro2::{Span, TokenStream, TokenTree};
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>quote::{quote, quote_spanned, ToTokens};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>syn::parse::{Parse, ParseStream, Parser};
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>syn::{braced, Attribute, Ident, Path, Signature, Visibility};
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="comment">// syn::AttributeArgs does not implement syn::Parse
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">type </span>AttributeArgs = syn::punctuated::Punctuated&lt;syn::Meta, <span class="macro">syn::Token!</span>[,]&gt;;
<a href=#8 id=8 data-nosnippet>8</a>
<a href=#9 id=9 data-nosnippet>9</a><span class="attr">#[derive(Clone, Copy, PartialEq)]
<a href=#10 id=10 data-nosnippet>10</a></span><span class="kw">enum </span>RuntimeFlavor {
<a href=#11 id=11 data-nosnippet>11</a> CurrentThread,
<a href=#12 id=12 data-nosnippet>12</a> Threaded,
<a href=#13 id=13 data-nosnippet>13</a> Local,
<a href=#14 id=14 data-nosnippet>14</a>}
<a href=#15 id=15 data-nosnippet>15</a>
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">impl </span>RuntimeFlavor {
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">fn </span>from_str(s: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;RuntimeFlavor, String&gt; {
<a href=#18 id=18 data-nosnippet>18</a> <span class="kw">match </span>s {
<a href=#19 id=19 data-nosnippet>19</a> <span class="string">"current_thread" </span>=&gt; <span class="prelude-val">Ok</span>(RuntimeFlavor::CurrentThread),
<a href=#20 id=20 data-nosnippet>20</a> <span class="string">"multi_thread" </span>=&gt; <span class="prelude-val">Ok</span>(RuntimeFlavor::Threaded),
<a href=#21 id=21 data-nosnippet>21</a> <span class="string">"local" </span>=&gt; <span class="prelude-val">Ok</span>(RuntimeFlavor::Local),
<a href=#22 id=22 data-nosnippet>22</a> <span class="string">"single_thread" </span>=&gt; <span class="prelude-val">Err</span>(<span class="string">"The single threaded runtime flavor is called `current_thread`."</span>.to_string()),
<a href=#23 id=23 data-nosnippet>23</a> <span class="string">"basic_scheduler" </span>=&gt; <span class="prelude-val">Err</span>(<span class="string">"The `basic_scheduler` runtime flavor has been renamed to `current_thread`."</span>.to_string()),
<a href=#24 id=24 data-nosnippet>24</a> <span class="string">"threaded_scheduler" </span>=&gt; <span class="prelude-val">Err</span>(<span class="string">"The `threaded_scheduler` runtime flavor has been renamed to `multi_thread`."</span>.to_string()),
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">"No such runtime flavor `{s}`. The runtime flavors are `current_thread`, `local`, and `multi_thread`."</span>)),
<a href=#26 id=26 data-nosnippet>26</a> }
<a href=#27 id=27 data-nosnippet>27</a> }
<a href=#28 id=28 data-nosnippet>28</a>}
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a><span class="attr">#[derive(Clone, Copy, PartialEq)]
<a href=#31 id=31 data-nosnippet>31</a></span><span class="kw">enum </span>UnhandledPanic {
<a href=#32 id=32 data-nosnippet>32</a> Ignore,
<a href=#33 id=33 data-nosnippet>33</a> ShutdownRuntime,
<a href=#34 id=34 data-nosnippet>34</a>}
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a><span class="kw">impl </span>UnhandledPanic {
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">fn </span>from_str(s: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;UnhandledPanic, String&gt; {
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">match </span>s {
<a href=#39 id=39 data-nosnippet>39</a> <span class="string">"ignore" </span>=&gt; <span class="prelude-val">Ok</span>(UnhandledPanic::Ignore),
<a href=#40 id=40 data-nosnippet>40</a> <span class="string">"shutdown_runtime" </span>=&gt; <span class="prelude-val">Ok</span>(UnhandledPanic::ShutdownRuntime),
<a href=#41 id=41 data-nosnippet>41</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">"No such unhandled panic behavior `{s}`. The unhandled panic behaviors are `ignore` and `shutdown_runtime`."</span>)),
<a href=#42 id=42 data-nosnippet>42</a> }
<a href=#43 id=43 data-nosnippet>43</a> }
<a href=#44 id=44 data-nosnippet>44</a>
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">fn </span>into_tokens(<span class="self">self</span>, crate_path: <span class="kw-2">&amp;</span>TokenStream) -&gt; TokenStream {
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">match </span><span class="self">self </span>{
<a href=#47 id=47 data-nosnippet>47</a> UnhandledPanic::Ignore =&gt; <span class="macro">quote!</span> { #crate_path::runtime::UnhandledPanic::Ignore },
<a href=#48 id=48 data-nosnippet>48</a> UnhandledPanic::ShutdownRuntime =&gt; {
<a href=#49 id=49 data-nosnippet>49</a> <span class="macro">quote!</span> { #crate_path::runtime::UnhandledPanic::ShutdownRuntime }
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a> }
<a href=#52 id=52 data-nosnippet>52</a> }
<a href=#53 id=53 data-nosnippet>53</a>}
<a href=#54 id=54 data-nosnippet>54</a>
<a href=#55 id=55 data-nosnippet>55</a><span class="kw">struct </span>FinalConfig {
<a href=#56 id=56 data-nosnippet>56</a> flavor: RuntimeFlavor,
<a href=#57 id=57 data-nosnippet>57</a> worker_threads: <span class="prelude-ty">Option</span>&lt;usize&gt;,
<a href=#58 id=58 data-nosnippet>58</a> start_paused: <span class="prelude-ty">Option</span>&lt;bool&gt;,
<a href=#59 id=59 data-nosnippet>59</a> crate_name: <span class="prelude-ty">Option</span>&lt;Path&gt;,
<a href=#60 id=60 data-nosnippet>60</a> unhandled_panic: <span class="prelude-ty">Option</span>&lt;UnhandledPanic&gt;,
<a href=#61 id=61 data-nosnippet>61</a>}
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a><span class="doccomment">/// Config used in case of the attribute not being able to build a valid config
<a href=#64 id=64 data-nosnippet>64</a></span><span class="kw">const </span>DEFAULT_ERROR_CONFIG: FinalConfig = FinalConfig {
<a href=#65 id=65 data-nosnippet>65</a> flavor: RuntimeFlavor::CurrentThread,
<a href=#66 id=66 data-nosnippet>66</a> worker_threads: <span class="prelude-val">None</span>,
<a href=#67 id=67 data-nosnippet>67</a> start_paused: <span class="prelude-val">None</span>,
<a href=#68 id=68 data-nosnippet>68</a> crate_name: <span class="prelude-val">None</span>,
<a href=#69 id=69 data-nosnippet>69</a> unhandled_panic: <span class="prelude-val">None</span>,
<a href=#70 id=70 data-nosnippet>70</a>};
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a><span class="kw">struct </span>Configuration {
<a href=#73 id=73 data-nosnippet>73</a> rt_multi_thread_available: bool,
<a href=#74 id=74 data-nosnippet>74</a> default_flavor: RuntimeFlavor,
<a href=#75 id=75 data-nosnippet>75</a> flavor: <span class="prelude-ty">Option</span>&lt;RuntimeFlavor&gt;,
<a href=#76 id=76 data-nosnippet>76</a> worker_threads: <span class="prelude-ty">Option</span>&lt;(usize, Span)&gt;,
<a href=#77 id=77 data-nosnippet>77</a> start_paused: <span class="prelude-ty">Option</span>&lt;(bool, Span)&gt;,
<a href=#78 id=78 data-nosnippet>78</a> is_test: bool,
<a href=#79 id=79 data-nosnippet>79</a> crate_name: <span class="prelude-ty">Option</span>&lt;Path&gt;,
<a href=#80 id=80 data-nosnippet>80</a> unhandled_panic: <span class="prelude-ty">Option</span>&lt;(UnhandledPanic, Span)&gt;,
<a href=#81 id=81 data-nosnippet>81</a>}
<a href=#82 id=82 data-nosnippet>82</a>
<a href=#83 id=83 data-nosnippet>83</a><span class="kw">impl </span>Configuration {
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw">fn </span>new(is_test: bool, rt_multi_thread: bool) -&gt; <span class="self">Self </span>{
<a href=#85 id=85 data-nosnippet>85</a> Configuration {
<a href=#86 id=86 data-nosnippet>86</a> rt_multi_thread_available: rt_multi_thread,
<a href=#87 id=87 data-nosnippet>87</a> default_flavor: <span class="kw">match </span>is_test {
<a href=#88 id=88 data-nosnippet>88</a> <span class="bool-val">true </span>=&gt; RuntimeFlavor::CurrentThread,
<a href=#89 id=89 data-nosnippet>89</a> <span class="bool-val">false </span>=&gt; RuntimeFlavor::Threaded,
<a href=#90 id=90 data-nosnippet>90</a> },
<a href=#91 id=91 data-nosnippet>91</a> flavor: <span class="prelude-val">None</span>,
<a href=#92 id=92 data-nosnippet>92</a> worker_threads: <span class="prelude-val">None</span>,
<a href=#93 id=93 data-nosnippet>93</a> start_paused: <span class="prelude-val">None</span>,
<a href=#94 id=94 data-nosnippet>94</a> is_test,
<a href=#95 id=95 data-nosnippet>95</a> crate_name: <span class="prelude-val">None</span>,
<a href=#96 id=96 data-nosnippet>96</a> unhandled_panic: <span class="prelude-val">None</span>,
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a> }
<a href=#99 id=99 data-nosnippet>99</a>
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">fn </span>set_flavor(<span class="kw-2">&amp;mut </span><span class="self">self</span>, runtime: syn::Lit, span: Span) -&gt; <span class="prelude-ty">Result</span>&lt;(), syn::Error&gt; {
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw">if </span><span class="self">self</span>.flavor.is_some() {
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new(span, <span class="string">"`flavor` set multiple times."</span>));
<a href=#103 id=103 data-nosnippet>103</a> }
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a> <span class="kw">let </span>runtime_str = parse_string(runtime, span, <span class="string">"flavor"</span>)<span class="question-mark">?</span>;
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">let </span>runtime =
<a href=#107 id=107 data-nosnippet>107</a> RuntimeFlavor::from_str(<span class="kw-2">&amp;</span>runtime_str).map_err(|err| syn::Error::new(span, err))<span class="question-mark">?</span>;
<a href=#108 id=108 data-nosnippet>108</a> <span class="self">self</span>.flavor = <span class="prelude-val">Some</span>(runtime);
<a href=#109 id=109 data-nosnippet>109</a> <span class="prelude-val">Ok</span>(())
<a href=#110 id=110 data-nosnippet>110</a> }
<a href=#111 id=111 data-nosnippet>111</a>
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw">fn </span>set_worker_threads(
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#114 id=114 data-nosnippet>114</a> worker_threads: syn::Lit,
<a href=#115 id=115 data-nosnippet>115</a> span: Span,
<a href=#116 id=116 data-nosnippet>116</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;(), syn::Error&gt; {
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">if </span><span class="self">self</span>.worker_threads.is_some() {
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new(
<a href=#119 id=119 data-nosnippet>119</a> span,
<a href=#120 id=120 data-nosnippet>120</a> <span class="string">"`worker_threads` set multiple times."</span>,
<a href=#121 id=121 data-nosnippet>121</a> ));
<a href=#122 id=122 data-nosnippet>122</a> }
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">let </span>worker_threads = parse_int(worker_threads, span, <span class="string">"worker_threads"</span>)<span class="question-mark">?</span>;
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">if </span>worker_threads == <span class="number">0 </span>{
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new(span, <span class="string">"`worker_threads` may not be 0."</span>));
<a href=#127 id=127 data-nosnippet>127</a> }
<a href=#128 id=128 data-nosnippet>128</a> <span class="self">self</span>.worker_threads = <span class="prelude-val">Some</span>((worker_threads, span));
<a href=#129 id=129 data-nosnippet>129</a> <span class="prelude-val">Ok</span>(())
<a href=#130 id=130 data-nosnippet>130</a> }
<a href=#131 id=131 data-nosnippet>131</a>
<a href=#132 id=132 data-nosnippet>132</a> <span class="kw">fn </span>set_start_paused(<span class="kw-2">&amp;mut </span><span class="self">self</span>, start_paused: syn::Lit, span: Span) -&gt; <span class="prelude-ty">Result</span>&lt;(), syn::Error&gt; {
<a href=#133 id=133 data-nosnippet>133</a> <span class="kw">if </span><span class="self">self</span>.start_paused.is_some() {
<a href=#134 id=134 data-nosnippet>134</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new(span, <span class="string">"`start_paused` set multiple times."</span>));
<a href=#135 id=135 data-nosnippet>135</a> }
<a href=#136 id=136 data-nosnippet>136</a>
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw">let </span>start_paused = parse_bool(start_paused, span, <span class="string">"start_paused"</span>)<span class="question-mark">?</span>;
<a href=#138 id=138 data-nosnippet>138</a> <span class="self">self</span>.start_paused = <span class="prelude-val">Some</span>((start_paused, span));
<a href=#139 id=139 data-nosnippet>139</a> <span class="prelude-val">Ok</span>(())
<a href=#140 id=140 data-nosnippet>140</a> }
<a href=#141 id=141 data-nosnippet>141</a>
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">fn </span>set_crate_name(<span class="kw-2">&amp;mut </span><span class="self">self</span>, name: syn::Lit, span: Span) -&gt; <span class="prelude-ty">Result</span>&lt;(), syn::Error&gt; {
<a href=#143 id=143 data-nosnippet>143</a> <span class="kw">if </span><span class="self">self</span>.crate_name.is_some() {
<a href=#144 id=144 data-nosnippet>144</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new(span, <span class="string">"`crate` set multiple times."</span>));
<a href=#145 id=145 data-nosnippet>145</a> }
<a href=#146 id=146 data-nosnippet>146</a> <span class="kw">let </span>name_path = parse_path(name, span, <span class="string">"crate"</span>)<span class="question-mark">?</span>;
<a href=#147 id=147 data-nosnippet>147</a> <span class="self">self</span>.crate_name = <span class="prelude-val">Some</span>(name_path);
<a href=#148 id=148 data-nosnippet>148</a> <span class="prelude-val">Ok</span>(())
<a href=#149 id=149 data-nosnippet>149</a> }
<a href=#150 id=150 data-nosnippet>150</a>
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">fn </span>set_unhandled_panic(
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#153 id=153 data-nosnippet>153</a> unhandled_panic: syn::Lit,
<a href=#154 id=154 data-nosnippet>154</a> span: Span,
<a href=#155 id=155 data-nosnippet>155</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;(), syn::Error&gt; {
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">if </span><span class="self">self</span>.unhandled_panic.is_some() {
<a href=#157 id=157 data-nosnippet>157</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new(
<a href=#158 id=158 data-nosnippet>158</a> span,
<a href=#159 id=159 data-nosnippet>159</a> <span class="string">"`unhandled_panic` set multiple times."</span>,
<a href=#160 id=160 data-nosnippet>160</a> ));
<a href=#161 id=161 data-nosnippet>161</a> }
<a href=#162 id=162 data-nosnippet>162</a>
<a href=#163 id=163 data-nosnippet>163</a> <span class="kw">let </span>unhandled_panic = parse_string(unhandled_panic, span, <span class="string">"unhandled_panic"</span>)<span class="question-mark">?</span>;
<a href=#164 id=164 data-nosnippet>164</a> <span class="kw">let </span>unhandled_panic =
<a href=#165 id=165 data-nosnippet>165</a> UnhandledPanic::from_str(<span class="kw-2">&amp;</span>unhandled_panic).map_err(|err| syn::Error::new(span, err))<span class="question-mark">?</span>;
<a href=#166 id=166 data-nosnippet>166</a> <span class="self">self</span>.unhandled_panic = <span class="prelude-val">Some</span>((unhandled_panic, span));
<a href=#167 id=167 data-nosnippet>167</a> <span class="prelude-val">Ok</span>(())
<a href=#168 id=168 data-nosnippet>168</a> }
<a href=#169 id=169 data-nosnippet>169</a>
<a href=#170 id=170 data-nosnippet>170</a> <span class="kw">fn </span>macro_name(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">'static </span>str {
<a href=#171 id=171 data-nosnippet>171</a> <span class="kw">if </span><span class="self">self</span>.is_test {
<a href=#172 id=172 data-nosnippet>172</a> <span class="string">"tokio::test"
<a href=#173 id=173 data-nosnippet>173</a> </span>} <span class="kw">else </span>{
<a href=#174 id=174 data-nosnippet>174</a> <span class="string">"tokio::main"
<a href=#175 id=175 data-nosnippet>175</a> </span>}
<a href=#176 id=176 data-nosnippet>176</a> }
<a href=#177 id=177 data-nosnippet>177</a>
<a href=#178 id=178 data-nosnippet>178</a> <span class="kw">fn </span>build(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;FinalConfig, syn::Error&gt; {
<a href=#179 id=179 data-nosnippet>179</a> <span class="kw">use </span>RuntimeFlavor <span class="kw">as </span>F;
<a href=#180 id=180 data-nosnippet>180</a>
<a href=#181 id=181 data-nosnippet>181</a> <span class="kw">let </span>flavor = <span class="self">self</span>.flavor.unwrap_or(<span class="self">self</span>.default_flavor);
<a href=#182 id=182 data-nosnippet>182</a>
<a href=#183 id=183 data-nosnippet>183</a> <span class="kw">let </span>worker_threads = <span class="kw">match </span>(flavor, <span class="self">self</span>.worker_threads) {
<a href=#184 id=184 data-nosnippet>184</a> (F::CurrentThread | F::Local, <span class="prelude-val">Some</span>((<span class="kw">_</span>, worker_threads_span))) =&gt; {
<a href=#185 id=185 data-nosnippet>185</a> <span class="kw">let </span>msg = <span class="macro">format!</span>(
<a href=#186 id=186 data-nosnippet>186</a> <span class="string">"The `worker_threads` option requires the `multi_thread` runtime flavor. Use `#[{}(flavor = \"multi_thread\")]`"</span>,
<a href=#187 id=187 data-nosnippet>187</a> <span class="self">self</span>.macro_name(),
<a href=#188 id=188 data-nosnippet>188</a> );
<a href=#189 id=189 data-nosnippet>189</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new(worker_threads_span, msg));
<a href=#190 id=190 data-nosnippet>190</a> }
<a href=#191 id=191 data-nosnippet>191</a> (F::CurrentThread | F::Local, <span class="prelude-val">None</span>) =&gt; <span class="prelude-val">None</span>,
<a href=#192 id=192 data-nosnippet>192</a> (F::Threaded, worker_threads) <span class="kw">if </span><span class="self">self</span>.rt_multi_thread_available =&gt; {
<a href=#193 id=193 data-nosnippet>193</a> worker_threads.map(|(val, _span)| val)
<a href=#194 id=194 data-nosnippet>194</a> }
<a href=#195 id=195 data-nosnippet>195</a> (F::Threaded, <span class="kw">_</span>) =&gt; {
<a href=#196 id=196 data-nosnippet>196</a> <span class="kw">let </span>msg = <span class="kw">if </span><span class="self">self</span>.flavor.is_none() {
<a href=#197 id=197 data-nosnippet>197</a> <span class="string">"The default runtime flavor is `multi_thread`, but the `rt-multi-thread` feature is disabled."
<a href=#198 id=198 data-nosnippet>198</a> </span>} <span class="kw">else </span>{
<a href=#199 id=199 data-nosnippet>199</a> <span class="string">"The runtime flavor `multi_thread` requires the `rt-multi-thread` feature."
<a href=#200 id=200 data-nosnippet>200</a> </span>};
<a href=#201 id=201 data-nosnippet>201</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new(Span::call_site(), msg));
<a href=#202 id=202 data-nosnippet>202</a> }
<a href=#203 id=203 data-nosnippet>203</a> };
<a href=#204 id=204 data-nosnippet>204</a>
<a href=#205 id=205 data-nosnippet>205</a> <span class="kw">let </span>start_paused = <span class="kw">match </span>(flavor, <span class="self">self</span>.start_paused) {
<a href=#206 id=206 data-nosnippet>206</a> (F::Threaded, <span class="prelude-val">Some</span>((<span class="kw">_</span>, start_paused_span))) =&gt; {
<a href=#207 id=207 data-nosnippet>207</a> <span class="kw">let </span>msg = <span class="macro">format!</span>(
<a href=#208 id=208 data-nosnippet>208</a> <span class="string">"The `start_paused` option requires the `current_thread` runtime flavor. Use `#[{}(flavor = \"current_thread\")]`"</span>,
<a href=#209 id=209 data-nosnippet>209</a> <span class="self">self</span>.macro_name(),
<a href=#210 id=210 data-nosnippet>210</a> );
<a href=#211 id=211 data-nosnippet>211</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new(start_paused_span, msg));
<a href=#212 id=212 data-nosnippet>212</a> }
<a href=#213 id=213 data-nosnippet>213</a> (F::CurrentThread | F::Local, <span class="prelude-val">Some</span>((start_paused, <span class="kw">_</span>))) =&gt; <span class="prelude-val">Some</span>(start_paused),
<a href=#214 id=214 data-nosnippet>214</a> (<span class="kw">_</span>, <span class="prelude-val">None</span>) =&gt; <span class="prelude-val">None</span>,
<a href=#215 id=215 data-nosnippet>215</a> };
<a href=#216 id=216 data-nosnippet>216</a>
<a href=#217 id=217 data-nosnippet>217</a> <span class="kw">let </span>unhandled_panic = <span class="kw">match </span>(flavor, <span class="self">self</span>.unhandled_panic) {
<a href=#218 id=218 data-nosnippet>218</a> (F::Threaded, <span class="prelude-val">Some</span>((<span class="kw">_</span>, unhandled_panic_span))) =&gt; {
<a href=#219 id=219 data-nosnippet>219</a> <span class="kw">let </span>msg = <span class="macro">format!</span>(
<a href=#220 id=220 data-nosnippet>220</a> <span class="string">"The `unhandled_panic` option requires the `current_thread` runtime flavor. Use `#[{}(flavor = \"current_thread\")]`"</span>,
<a href=#221 id=221 data-nosnippet>221</a> <span class="self">self</span>.macro_name(),
<a href=#222 id=222 data-nosnippet>222</a> );
<a href=#223 id=223 data-nosnippet>223</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new(unhandled_panic_span, msg));
<a href=#224 id=224 data-nosnippet>224</a> }
<a href=#225 id=225 data-nosnippet>225</a> (F::CurrentThread | F::Local, <span class="prelude-val">Some</span>((unhandled_panic, <span class="kw">_</span>))) =&gt; <span class="prelude-val">Some</span>(unhandled_panic),
<a href=#226 id=226 data-nosnippet>226</a> (<span class="kw">_</span>, <span class="prelude-val">None</span>) =&gt; <span class="prelude-val">None</span>,
<a href=#227 id=227 data-nosnippet>227</a> };
<a href=#228 id=228 data-nosnippet>228</a>
<a href=#229 id=229 data-nosnippet>229</a> <span class="prelude-val">Ok</span>(FinalConfig {
<a href=#230 id=230 data-nosnippet>230</a> crate_name: <span class="self">self</span>.crate_name.clone(),
<a href=#231 id=231 data-nosnippet>231</a> flavor,
<a href=#232 id=232 data-nosnippet>232</a> worker_threads,
<a href=#233 id=233 data-nosnippet>233</a> start_paused,
<a href=#234 id=234 data-nosnippet>234</a> unhandled_panic,
<a href=#235 id=235 data-nosnippet>235</a> })
<a href=#236 id=236 data-nosnippet>236</a> }
<a href=#237 id=237 data-nosnippet>237</a>}
<a href=#238 id=238 data-nosnippet>238</a>
<a href=#239 id=239 data-nosnippet>239</a><span class="kw">fn </span>parse_int(int: syn::Lit, span: Span, field: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;usize, syn::Error&gt; {
<a href=#240 id=240 data-nosnippet>240</a> <span class="kw">match </span>int {
<a href=#241 id=241 data-nosnippet>241</a> syn::Lit::Int(lit) =&gt; <span class="kw">match </span>lit.base10_parse::&lt;usize&gt;() {
<a href=#242 id=242 data-nosnippet>242</a> <span class="prelude-val">Ok</span>(value) =&gt; <span class="prelude-val">Ok</span>(value),
<a href=#243 id=243 data-nosnippet>243</a> <span class="prelude-val">Err</span>(e) =&gt; <span class="prelude-val">Err</span>(syn::Error::new(
<a href=#244 id=244 data-nosnippet>244</a> span,
<a href=#245 id=245 data-nosnippet>245</a> <span class="macro">format!</span>(<span class="string">"Failed to parse value of `{field}` as integer: {e}"</span>),
<a href=#246 id=246 data-nosnippet>246</a> )),
<a href=#247 id=247 data-nosnippet>247</a> },
<a href=#248 id=248 data-nosnippet>248</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(syn::Error::new(
<a href=#249 id=249 data-nosnippet>249</a> span,
<a href=#250 id=250 data-nosnippet>250</a> <span class="macro">format!</span>(<span class="string">"Failed to parse value of `{field}` as integer."</span>),
<a href=#251 id=251 data-nosnippet>251</a> )),
<a href=#252 id=252 data-nosnippet>252</a> }
<a href=#253 id=253 data-nosnippet>253</a>}
<a href=#254 id=254 data-nosnippet>254</a>
<a href=#255 id=255 data-nosnippet>255</a><span class="kw">fn </span>parse_string(int: syn::Lit, span: Span, field: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;String, syn::Error&gt; {
<a href=#256 id=256 data-nosnippet>256</a> <span class="kw">match </span>int {
<a href=#257 id=257 data-nosnippet>257</a> syn::Lit::Str(s) =&gt; <span class="prelude-val">Ok</span>(s.value()),
<a href=#258 id=258 data-nosnippet>258</a> syn::Lit::Verbatim(s) =&gt; <span class="prelude-val">Ok</span>(s.to_string()),
<a href=#259 id=259 data-nosnippet>259</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(syn::Error::new(
<a href=#260 id=260 data-nosnippet>260</a> span,
<a href=#261 id=261 data-nosnippet>261</a> <span class="macro">format!</span>(<span class="string">"Failed to parse value of `{field}` as string."</span>),
<a href=#262 id=262 data-nosnippet>262</a> )),
<a href=#263 id=263 data-nosnippet>263</a> }
<a href=#264 id=264 data-nosnippet>264</a>}
<a href=#265 id=265 data-nosnippet>265</a>
<a href=#266 id=266 data-nosnippet>266</a><span class="kw">fn </span>parse_path(lit: syn::Lit, span: Span, field: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;Path, syn::Error&gt; {
<a href=#267 id=267 data-nosnippet>267</a> <span class="kw">match </span>lit {
<a href=#268 id=268 data-nosnippet>268</a> syn::Lit::Str(s) =&gt; {
<a href=#269 id=269 data-nosnippet>269</a> <span class="kw">let </span>err = syn::Error::new(
<a href=#270 id=270 data-nosnippet>270</a> span,
<a href=#271 id=271 data-nosnippet>271</a> <span class="macro">format!</span>(
<a href=#272 id=272 data-nosnippet>272</a> <span class="string">"Failed to parse value of `{}` as path: \"{}\""</span>,
<a href=#273 id=273 data-nosnippet>273</a> field,
<a href=#274 id=274 data-nosnippet>274</a> s.value()
<a href=#275 id=275 data-nosnippet>275</a> ),
<a href=#276 id=276 data-nosnippet>276</a> );
<a href=#277 id=277 data-nosnippet>277</a> s.parse::&lt;syn::Path&gt;().map_err(|<span class="kw">_</span>| err.clone())
<a href=#278 id=278 data-nosnippet>278</a> }
<a href=#279 id=279 data-nosnippet>279</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(syn::Error::new(
<a href=#280 id=280 data-nosnippet>280</a> span,
<a href=#281 id=281 data-nosnippet>281</a> <span class="macro">format!</span>(<span class="string">"Failed to parse value of `{field}` as path."</span>),
<a href=#282 id=282 data-nosnippet>282</a> )),
<a href=#283 id=283 data-nosnippet>283</a> }
<a href=#284 id=284 data-nosnippet>284</a>}
<a href=#285 id=285 data-nosnippet>285</a>
<a href=#286 id=286 data-nosnippet>286</a><span class="kw">fn </span>parse_bool(bool: syn::Lit, span: Span, field: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;bool, syn::Error&gt; {
<a href=#287 id=287 data-nosnippet>287</a> <span class="kw">match </span>bool {
<a href=#288 id=288 data-nosnippet>288</a> syn::Lit::Bool(b) =&gt; <span class="prelude-val">Ok</span>(b.value),
<a href=#289 id=289 data-nosnippet>289</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(syn::Error::new(
<a href=#290 id=290 data-nosnippet>290</a> span,
<a href=#291 id=291 data-nosnippet>291</a> <span class="macro">format!</span>(<span class="string">"Failed to parse value of `{field}` as bool."</span>),
<a href=#292 id=292 data-nosnippet>292</a> )),
<a href=#293 id=293 data-nosnippet>293</a> }
<a href=#294 id=294 data-nosnippet>294</a>}
<a href=#295 id=295 data-nosnippet>295</a>
<a href=#296 id=296 data-nosnippet>296</a><span class="kw">fn </span>build_config(
<a href=#297 id=297 data-nosnippet>297</a> input: <span class="kw-2">&amp;</span>ItemFn,
<a href=#298 id=298 data-nosnippet>298</a> args: AttributeArgs,
<a href=#299 id=299 data-nosnippet>299</a> is_test: bool,
<a href=#300 id=300 data-nosnippet>300</a> rt_multi_thread: bool,
<a href=#301 id=301 data-nosnippet>301</a>) -&gt; <span class="prelude-ty">Result</span>&lt;FinalConfig, syn::Error&gt; {
<a href=#302 id=302 data-nosnippet>302</a> <span class="kw">if </span>input.sig.asyncness.is_none() {
<a href=#303 id=303 data-nosnippet>303</a> <span class="kw">let </span>msg = <span class="string">"the `async` keyword is missing from the function declaration"</span>;
<a href=#304 id=304 data-nosnippet>304</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new_spanned(input.sig.fn_token, msg));
<a href=#305 id=305 data-nosnippet>305</a> }
<a href=#306 id=306 data-nosnippet>306</a>
<a href=#307 id=307 data-nosnippet>307</a> <span class="kw">let </span><span class="kw-2">mut </span>config = Configuration::new(is_test, rt_multi_thread);
<a href=#308 id=308 data-nosnippet>308</a> <span class="kw">let </span>macro_name = config.macro_name();
<a href=#309 id=309 data-nosnippet>309</a>
<a href=#310 id=310 data-nosnippet>310</a> <span class="kw">for </span>arg <span class="kw">in </span>args {
<a href=#311 id=311 data-nosnippet>311</a> <span class="kw">match </span>arg {
<a href=#312 id=312 data-nosnippet>312</a> syn::Meta::NameValue(namevalue) =&gt; {
<a href=#313 id=313 data-nosnippet>313</a> <span class="kw">let </span>ident = namevalue
<a href=#314 id=314 data-nosnippet>314</a> .path
<a href=#315 id=315 data-nosnippet>315</a> .get_ident()
<a href=#316 id=316 data-nosnippet>316</a> .ok_or_else(|| {
<a href=#317 id=317 data-nosnippet>317</a> syn::Error::new_spanned(<span class="kw-2">&amp;</span>namevalue, <span class="string">"Must have specified ident"</span>)
<a href=#318 id=318 data-nosnippet>318</a> })<span class="question-mark">?
<a href=#319 id=319 data-nosnippet>319</a> </span>.to_string()
<a href=#320 id=320 data-nosnippet>320</a> .to_lowercase();
<a href=#321 id=321 data-nosnippet>321</a> <span class="kw">let </span>lit = <span class="kw">match </span><span class="kw-2">&amp;</span>namevalue.value {
<a href=#322 id=322 data-nosnippet>322</a> syn::Expr::Lit(syn::ExprLit { lit, .. }) =&gt; lit,
<a href=#323 id=323 data-nosnippet>323</a> expr =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new_spanned(expr, <span class="string">"Must be a literal"</span>)),
<a href=#324 id=324 data-nosnippet>324</a> };
<a href=#325 id=325 data-nosnippet>325</a> <span class="kw">match </span>ident.as_str() {
<a href=#326 id=326 data-nosnippet>326</a> <span class="string">"worker_threads" </span>=&gt; {
<a href=#327 id=327 data-nosnippet>327</a> config.set_worker_threads(lit.clone(), syn::spanned::Spanned::span(lit))<span class="question-mark">?</span>;
<a href=#328 id=328 data-nosnippet>328</a> }
<a href=#329 id=329 data-nosnippet>329</a> <span class="string">"flavor" </span>=&gt; {
<a href=#330 id=330 data-nosnippet>330</a> config.set_flavor(lit.clone(), syn::spanned::Spanned::span(lit))<span class="question-mark">?</span>;
<a href=#331 id=331 data-nosnippet>331</a> }
<a href=#332 id=332 data-nosnippet>332</a> <span class="string">"start_paused" </span>=&gt; {
<a href=#333 id=333 data-nosnippet>333</a> config.set_start_paused(lit.clone(), syn::spanned::Spanned::span(lit))<span class="question-mark">?</span>;
<a href=#334 id=334 data-nosnippet>334</a> }
<a href=#335 id=335 data-nosnippet>335</a> <span class="string">"core_threads" </span>=&gt; {
<a href=#336 id=336 data-nosnippet>336</a> <span class="kw">let </span>msg = <span class="string">"Attribute `core_threads` is renamed to `worker_threads`"</span>;
<a href=#337 id=337 data-nosnippet>337</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new_spanned(namevalue, msg));
<a href=#338 id=338 data-nosnippet>338</a> }
<a href=#339 id=339 data-nosnippet>339</a> <span class="string">"crate" </span>=&gt; {
<a href=#340 id=340 data-nosnippet>340</a> config.set_crate_name(lit.clone(), syn::spanned::Spanned::span(lit))<span class="question-mark">?</span>;
<a href=#341 id=341 data-nosnippet>341</a> }
<a href=#342 id=342 data-nosnippet>342</a> <span class="string">"unhandled_panic" </span>=&gt; {
<a href=#343 id=343 data-nosnippet>343</a> config
<a href=#344 id=344 data-nosnippet>344</a> .set_unhandled_panic(lit.clone(), syn::spanned::Spanned::span(lit))<span class="question-mark">?</span>;
<a href=#345 id=345 data-nosnippet>345</a> }
<a href=#346 id=346 data-nosnippet>346</a> name =&gt; {
<a href=#347 id=347 data-nosnippet>347</a> <span class="kw">let </span>msg = <span class="macro">format!</span>(
<a href=#348 id=348 data-nosnippet>348</a> <span class="string">"Unknown attribute {name} is specified; expected one of: `flavor`, `worker_threads`, `start_paused`, `crate`, `unhandled_panic`"</span>,
<a href=#349 id=349 data-nosnippet>349</a> );
<a href=#350 id=350 data-nosnippet>350</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new_spanned(namevalue, msg));
<a href=#351 id=351 data-nosnippet>351</a> }
<a href=#352 id=352 data-nosnippet>352</a> }
<a href=#353 id=353 data-nosnippet>353</a> }
<a href=#354 id=354 data-nosnippet>354</a> syn::Meta::Path(path) =&gt; {
<a href=#355 id=355 data-nosnippet>355</a> <span class="kw">let </span>name = path
<a href=#356 id=356 data-nosnippet>356</a> .get_ident()
<a href=#357 id=357 data-nosnippet>357</a> .ok_or_else(|| syn::Error::new_spanned(<span class="kw-2">&amp;</span>path, <span class="string">"Must have specified ident"</span>))<span class="question-mark">?
<a href=#358 id=358 data-nosnippet>358</a> </span>.to_string()
<a href=#359 id=359 data-nosnippet>359</a> .to_lowercase();
<a href=#360 id=360 data-nosnippet>360</a> <span class="kw">let </span>msg = <span class="kw">match </span>name.as_str() {
<a href=#361 id=361 data-nosnippet>361</a> <span class="string">"threaded_scheduler" </span>| <span class="string">"multi_thread" </span>=&gt; {
<a href=#362 id=362 data-nosnippet>362</a> <span class="macro">format!</span>(
<a href=#363 id=363 data-nosnippet>363</a> <span class="string">"Set the runtime flavor with #[{macro_name}(flavor = \"multi_thread\")]."
<a href=#364 id=364 data-nosnippet>364</a> </span>)
<a href=#365 id=365 data-nosnippet>365</a> }
<a href=#366 id=366 data-nosnippet>366</a> <span class="string">"basic_scheduler" </span>| <span class="string">"current_thread" </span>| <span class="string">"single_threaded" </span>=&gt; {
<a href=#367 id=367 data-nosnippet>367</a> <span class="macro">format!</span>(
<a href=#368 id=368 data-nosnippet>368</a> <span class="string">"Set the runtime flavor with #[{macro_name}(flavor = \"current_thread\")]."
<a href=#369 id=369 data-nosnippet>369</a> </span>)
<a href=#370 id=370 data-nosnippet>370</a> }
<a href=#371 id=371 data-nosnippet>371</a> <span class="string">"flavor" </span>| <span class="string">"worker_threads" </span>| <span class="string">"start_paused" </span>| <span class="string">"crate" </span>| <span class="string">"unhandled_panic" </span>=&gt; {
<a href=#372 id=372 data-nosnippet>372</a> <span class="macro">format!</span>(<span class="string">"The `{name}` attribute requires an argument."</span>)
<a href=#373 id=373 data-nosnippet>373</a> }
<a href=#374 id=374 data-nosnippet>374</a> name =&gt; {
<a href=#375 id=375 data-nosnippet>375</a> <span class="macro">format!</span>(<span class="string">"Unknown attribute {name} is specified; expected one of: `flavor`, `worker_threads`, `start_paused`, `crate`, `unhandled_panic`."</span>)
<a href=#376 id=376 data-nosnippet>376</a> }
<a href=#377 id=377 data-nosnippet>377</a> };
<a href=#378 id=378 data-nosnippet>378</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new_spanned(path, msg));
<a href=#379 id=379 data-nosnippet>379</a> }
<a href=#380 id=380 data-nosnippet>380</a> other =&gt; {
<a href=#381 id=381 data-nosnippet>381</a> <span class="kw">return </span><span class="prelude-val">Err</span>(syn::Error::new_spanned(
<a href=#382 id=382 data-nosnippet>382</a> other,
<a href=#383 id=383 data-nosnippet>383</a> <span class="string">"Unknown attribute inside the macro"</span>,
<a href=#384 id=384 data-nosnippet>384</a> ));
<a href=#385 id=385 data-nosnippet>385</a> }
<a href=#386 id=386 data-nosnippet>386</a> }
<a href=#387 id=387 data-nosnippet>387</a> }
<a href=#388 id=388 data-nosnippet>388</a>
<a href=#389 id=389 data-nosnippet>389</a> config.build()
<a href=#390 id=390 data-nosnippet>390</a>}
<a href=#391 id=391 data-nosnippet>391</a>
<a href=#392 id=392 data-nosnippet>392</a><span class="kw">fn </span>parse_knobs(<span class="kw-2">mut </span>input: ItemFn, is_test: bool, config: FinalConfig) -&gt; TokenStream {
<a href=#393 id=393 data-nosnippet>393</a> input.sig.asyncness = <span class="prelude-val">None</span>;
<a href=#394 id=394 data-nosnippet>394</a>
<a href=#395 id=395 data-nosnippet>395</a> <span class="comment">// If type mismatch occurs, the current rustc points to the last statement.
<a href=#396 id=396 data-nosnippet>396</a> </span><span class="kw">let </span>(last_stmt_start_span, last_stmt_end_span) = {
<a href=#397 id=397 data-nosnippet>397</a> <span class="kw">let </span><span class="kw-2">mut </span>last_stmt = input.stmts.last().cloned().unwrap_or_default().into_iter();
<a href=#398 id=398 data-nosnippet>398</a>
<a href=#399 id=399 data-nosnippet>399</a> <span class="comment">// `Span` on stable Rust has a limitation that only points to the first
<a href=#400 id=400 data-nosnippet>400</a> // token, not the whole tokens. We can work around this limitation by
<a href=#401 id=401 data-nosnippet>401</a> // using the first/last span of the tokens like
<a href=#402 id=402 data-nosnippet>402</a> // `syn::Error::new_spanned` does.
<a href=#403 id=403 data-nosnippet>403</a> </span><span class="kw">let </span>start = last_stmt.next().map_or_else(Span::call_site, |t| t.span());
<a href=#404 id=404 data-nosnippet>404</a> <span class="kw">let </span>end = last_stmt.last().map_or(start, |t| t.span());
<a href=#405 id=405 data-nosnippet>405</a> (start, end)
<a href=#406 id=406 data-nosnippet>406</a> };
<a href=#407 id=407 data-nosnippet>407</a>
<a href=#408 id=408 data-nosnippet>408</a> <span class="kw">let </span>crate_path = config
<a href=#409 id=409 data-nosnippet>409</a> .crate_name
<a href=#410 id=410 data-nosnippet>410</a> .map(ToTokens::into_token_stream)
<a href=#411 id=411 data-nosnippet>411</a> .unwrap_or_else(|| Ident::new(<span class="string">"tokio"</span>, last_stmt_start_span).into_token_stream());
<a href=#412 id=412 data-nosnippet>412</a>
<a href=#413 id=413 data-nosnippet>413</a> <span class="kw">let </span><span class="kw-2">mut </span>rt = <span class="kw">match </span>config.flavor {
<a href=#414 id=414 data-nosnippet>414</a> RuntimeFlavor::CurrentThread | RuntimeFlavor::Local =&gt; {
<a href=#415 id=415 data-nosnippet>415</a> <span class="macro">quote_spanned!</span> {last_stmt_start_span=&gt;
<a href=#416 id=416 data-nosnippet>416</a> #crate_path::runtime::Builder::new_current_thread()
<a href=#417 id=417 data-nosnippet>417</a> }
<a href=#418 id=418 data-nosnippet>418</a> }
<a href=#419 id=419 data-nosnippet>419</a> RuntimeFlavor::Threaded =&gt; <span class="macro">quote_spanned!</span> {last_stmt_start_span=&gt;
<a href=#420 id=420 data-nosnippet>420</a> #crate_path::runtime::Builder::new_multi_thread()
<a href=#421 id=421 data-nosnippet>421</a> },
<a href=#422 id=422 data-nosnippet>422</a> };
<a href=#423 id=423 data-nosnippet>423</a>
<a href=#424 id=424 data-nosnippet>424</a> <span class="kw">let </span><span class="kw-2">mut </span>checks = <span class="macro">vec!</span>[];
<a href=#425 id=425 data-nosnippet>425</a> <span class="kw">let </span><span class="kw-2">mut </span>errors = <span class="macro">vec!</span>[];
<a href=#426 id=426 data-nosnippet>426</a>
<a href=#427 id=427 data-nosnippet>427</a> <span class="kw">let </span>build = <span class="kw">if let </span>RuntimeFlavor::Local = config.flavor {
<a href=#428 id=428 data-nosnippet>428</a> checks.push(<span class="macro">quote!</span> { tokio_unstable });
<a href=#429 id=429 data-nosnippet>429</a> errors.push(<span class="string">"The local runtime flavor is only available when `tokio_unstable` is set."</span>);
<a href=#430 id=430 data-nosnippet>430</a> <span class="macro">quote_spanned!</span> {last_stmt_start_span=&gt; build_local(Default::default())}
<a href=#431 id=431 data-nosnippet>431</a> } <span class="kw">else </span>{
<a href=#432 id=432 data-nosnippet>432</a> <span class="macro">quote_spanned!</span> {last_stmt_start_span=&gt; build()}
<a href=#433 id=433 data-nosnippet>433</a> };
<a href=#434 id=434 data-nosnippet>434</a>
<a href=#435 id=435 data-nosnippet>435</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = config.worker_threads {
<a href=#436 id=436 data-nosnippet>436</a> rt = <span class="macro">quote_spanned!</span> {last_stmt_start_span=&gt; #rt.worker_threads(#v) };
<a href=#437 id=437 data-nosnippet>437</a> }
<a href=#438 id=438 data-nosnippet>438</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = config.start_paused {
<a href=#439 id=439 data-nosnippet>439</a> rt = <span class="macro">quote_spanned!</span> {last_stmt_start_span=&gt; #rt.start_paused(#v) };
<a href=#440 id=440 data-nosnippet>440</a> }
<a href=#441 id=441 data-nosnippet>441</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = config.unhandled_panic {
<a href=#442 id=442 data-nosnippet>442</a> <span class="kw">let </span>unhandled_panic = v.into_tokens(<span class="kw-2">&amp;</span>crate_path);
<a href=#443 id=443 data-nosnippet>443</a> rt = <span class="macro">quote_spanned!</span> {last_stmt_start_span=&gt; #rt.unhandled_panic(#unhandled_panic) };
<a href=#444 id=444 data-nosnippet>444</a> }
<a href=#445 id=445 data-nosnippet>445</a>
<a href=#446 id=446 data-nosnippet>446</a> <span class="kw">let </span>generated_attrs = <span class="kw">if </span>is_test {
<a href=#447 id=447 data-nosnippet>447</a> <span class="macro">quote!</span> {
<a href=#448 id=448 data-nosnippet>448</a> <span class="attr">#[::core::prelude::v1::test]
<a href=#449 id=449 data-nosnippet>449</a> </span>}
<a href=#450 id=450 data-nosnippet>450</a> } <span class="kw">else </span>{
<a href=#451 id=451 data-nosnippet>451</a> <span class="macro">quote!</span> {}
<a href=#452 id=452 data-nosnippet>452</a> };
<a href=#453 id=453 data-nosnippet>453</a>
<a href=#454 id=454 data-nosnippet>454</a> <span class="kw">let </span>do_checks: TokenStream = checks
<a href=#455 id=455 data-nosnippet>455</a> .iter()
<a href=#456 id=456 data-nosnippet>456</a> .zip(<span class="kw-2">&amp;</span>errors)
<a href=#457 id=457 data-nosnippet>457</a> .map(|(check, error)| {
<a href=#458 id=458 data-nosnippet>458</a> <span class="macro">quote!</span> {
<a href=#459 id=459 data-nosnippet>459</a> <span class="attr">#[cfg(not(#check))]
<a href=#460 id=460 data-nosnippet>460</a> </span><span class="macro">compile_error!</span>(#error);
<a href=#461 id=461 data-nosnippet>461</a> }
<a href=#462 id=462 data-nosnippet>462</a> })
<a href=#463 id=463 data-nosnippet>463</a> .collect();
<a href=#464 id=464 data-nosnippet>464</a>
<a href=#465 id=465 data-nosnippet>465</a> <span class="kw">let </span>body_ident = <span class="macro">quote!</span> { body };
<a href=#466 id=466 data-nosnippet>466</a> <span class="comment">// This explicit `return` is intentional. See tokio-rs/tokio#4636
<a href=#467 id=467 data-nosnippet>467</a> </span><span class="kw">let </span>last_block = <span class="macro">quote_spanned!</span> {last_stmt_end_span=&gt;
<a href=#468 id=468 data-nosnippet>468</a> #do_checks
<a href=#469 id=469 data-nosnippet>469</a>
<a href=#470 id=470 data-nosnippet>470</a> <span class="attr">#[cfg(all(#(#checks),<span class="kw-2">*</span>))]
<a href=#471 id=471 data-nosnippet>471</a> #[allow(clippy::expect_used, clippy::diverging_sub_expression, clippy::needless_return, clippy::unwrap_in_result)]
<a href=#472 id=472 data-nosnippet>472</a> </span>{
<a href=#473 id=473 data-nosnippet>473</a> <span class="kw">return </span>#rt
<a href=#474 id=474 data-nosnippet>474</a> .enable_all()
<a href=#475 id=475 data-nosnippet>475</a> .#build
<a href=#476 id=476 data-nosnippet>476</a> .expect(<span class="string">"Failed building the Runtime"</span>)
<a href=#477 id=477 data-nosnippet>477</a> .block_on(#body_ident);
<a href=#478 id=478 data-nosnippet>478</a> }
<a href=#479 id=479 data-nosnippet>479</a>
<a href=#480 id=480 data-nosnippet>480</a> <span class="attr">#[cfg(not(all(#(#checks),<span class="kw-2">*</span>)))]
<a href=#481 id=481 data-nosnippet>481</a> </span>{
<a href=#482 id=482 data-nosnippet>482</a> <span class="macro">panic!</span>(<span class="string">"fell through checks"</span>)
<a href=#483 id=483 data-nosnippet>483</a> }
<a href=#484 id=484 data-nosnippet>484</a> };
<a href=#485 id=485 data-nosnippet>485</a>
<a href=#486 id=486 data-nosnippet>486</a> <span class="kw">let </span>body = input.body();
<a href=#487 id=487 data-nosnippet>487</a>
<a href=#488 id=488 data-nosnippet>488</a> <span class="comment">// For test functions pin the body to the stack and use `Pin&lt;&amp;mut dyn
<a href=#489 id=489 data-nosnippet>489</a> // Future&gt;` to reduce the amount of `Runtime::block_on` (and related
<a href=#490 id=490 data-nosnippet>490</a> // functions) copies we generate during compilation due to the generic
<a href=#491 id=491 data-nosnippet>491</a> // parameter `F` (the future to block on). This could have an impact on
<a href=#492 id=492 data-nosnippet>492</a> // performance, but because it's only for testing it's unlikely to be very
<a href=#493 id=493 data-nosnippet>493</a> // large.
<a href=#494 id=494 data-nosnippet>494</a> //
<a href=#495 id=495 data-nosnippet>495</a> // We don't do this for the main function as it should only be used once so
<a href=#496 id=496 data-nosnippet>496</a> // there will be no benefit.
<a href=#497 id=497 data-nosnippet>497</a> </span><span class="kw">let </span>body = <span class="kw">if </span>is_test {
<a href=#498 id=498 data-nosnippet>498</a> <span class="kw">let </span>output_type = <span class="kw">match </span><span class="kw-2">&amp;</span>input.sig.output {
<a href=#499 id=499 data-nosnippet>499</a> <span class="comment">// For functions with no return value syn doesn't print anything,
<a href=#500 id=500 data-nosnippet>500</a> // but that doesn't work as `Output` for our boxed `Future`, so
<a href=#501 id=501 data-nosnippet>501</a> // default to `()` (the same type as the function output).
<a href=#502 id=502 data-nosnippet>502</a> </span>syn::ReturnType::Default =&gt; <span class="macro">quote!</span> { () },
<a href=#503 id=503 data-nosnippet>503</a> syn::ReturnType::Type(<span class="kw">_</span>, ret_type) =&gt; <span class="macro">quote!</span> { #ret_type },
<a href=#504 id=504 data-nosnippet>504</a> };
<a href=#505 id=505 data-nosnippet>505</a> <span class="macro">quote!</span> {
<a href=#506 id=506 data-nosnippet>506</a> <span class="kw">let </span>body = <span class="kw">async </span>#body;
<a href=#507 id=507 data-nosnippet>507</a> #<span class="macro">crate_path::pin!</span>(body);
<a href=#508 id=508 data-nosnippet>508</a> <span class="kw">let </span>body: ::core::pin::Pin&lt;<span class="kw-2">&amp;mut </span><span class="kw">dyn </span>::core::future::Future&lt;Output = #output_type&gt;&gt; = body;
<a href=#509 id=509 data-nosnippet>509</a> }
<a href=#510 id=510 data-nosnippet>510</a> } <span class="kw">else </span>{
<a href=#511 id=511 data-nosnippet>511</a> <span class="macro">quote!</span> {
<a href=#512 id=512 data-nosnippet>512</a> <span class="kw">let </span>body = <span class="kw">async </span>#body;
<a href=#513 id=513 data-nosnippet>513</a> }
<a href=#514 id=514 data-nosnippet>514</a> };
<a href=#515 id=515 data-nosnippet>515</a>
<a href=#516 id=516 data-nosnippet>516</a> input.into_tokens(generated_attrs, body, last_block)
<a href=#517 id=517 data-nosnippet>517</a>}
<a href=#518 id=518 data-nosnippet>518</a>
<a href=#519 id=519 data-nosnippet>519</a><span class="kw">fn </span>token_stream_with_error(<span class="kw-2">mut </span>tokens: TokenStream, error: syn::Error) -&gt; TokenStream {
<a href=#520 id=520 data-nosnippet>520</a> tokens.extend(error.into_compile_error());
<a href=#521 id=521 data-nosnippet>521</a> tokens
<a href=#522 id=522 data-nosnippet>522</a>}
<a href=#523 id=523 data-nosnippet>523</a>
<a href=#524 id=524 data-nosnippet>524</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>main(args: TokenStream, item: TokenStream, rt_multi_thread: bool) -&gt; TokenStream {
<a href=#525 id=525 data-nosnippet>525</a> <span class="comment">// If any of the steps for this macro fail, we still want to expand to an item that is as close
<a href=#526 id=526 data-nosnippet>526</a> // to the expected output as possible. This helps out IDEs such that completions and other
<a href=#527 id=527 data-nosnippet>527</a> // related features keep working.
<a href=#528 id=528 data-nosnippet>528</a> </span><span class="kw">let </span>input: ItemFn = <span class="kw">match </span>syn::parse2(item.clone()) {
<a href=#529 id=529 data-nosnippet>529</a> <span class="prelude-val">Ok</span>(it) =&gt; it,
<a href=#530 id=530 data-nosnippet>530</a> <span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span>token_stream_with_error(item, e),
<a href=#531 id=531 data-nosnippet>531</a> };
<a href=#532 id=532 data-nosnippet>532</a>
<a href=#533 id=533 data-nosnippet>533</a> <span class="kw">let </span>config = <span class="kw">if </span>input.sig.ident == <span class="string">"main" </span>&amp;&amp; !input.sig.inputs.is_empty() {
<a href=#534 id=534 data-nosnippet>534</a> <span class="kw">let </span>msg = <span class="string">"the main function cannot accept arguments"</span>;
<a href=#535 id=535 data-nosnippet>535</a> <span class="prelude-val">Err</span>(syn::Error::new_spanned(<span class="kw-2">&amp;</span>input.sig.ident, msg))
<a href=#536 id=536 data-nosnippet>536</a> } <span class="kw">else </span>{
<a href=#537 id=537 data-nosnippet>537</a> AttributeArgs::parse_terminated
<a href=#538 id=538 data-nosnippet>538</a> .parse2(args)
<a href=#539 id=539 data-nosnippet>539</a> .and_then(|args| build_config(<span class="kw-2">&amp;</span>input, args, <span class="bool-val">false</span>, rt_multi_thread))
<a href=#540 id=540 data-nosnippet>540</a> };
<a href=#541 id=541 data-nosnippet>541</a>
<a href=#542 id=542 data-nosnippet>542</a> <span class="kw">match </span>config {
<a href=#543 id=543 data-nosnippet>543</a> <span class="prelude-val">Ok</span>(config) =&gt; parse_knobs(input, <span class="bool-val">false</span>, config),
<a href=#544 id=544 data-nosnippet>544</a> <span class="prelude-val">Err</span>(e) =&gt; token_stream_with_error(parse_knobs(input, <span class="bool-val">false</span>, DEFAULT_ERROR_CONFIG), e),
<a href=#545 id=545 data-nosnippet>545</a> }
<a href=#546 id=546 data-nosnippet>546</a>}
<a href=#547 id=547 data-nosnippet>547</a>
<a href=#548 id=548 data-nosnippet>548</a><span class="comment">// Check whether given attribute is a test attribute of forms:
<a href=#549 id=549 data-nosnippet>549</a>// * `#[test]`
<a href=#550 id=550 data-nosnippet>550</a>// * `#[core::prelude::*::test]` or `#[::core::prelude::*::test]`
<a href=#551 id=551 data-nosnippet>551</a>// * `#[std::prelude::*::test]` or `#[::std::prelude::*::test]`
<a href=#552 id=552 data-nosnippet>552</a></span><span class="kw">fn </span>is_test_attribute(attr: <span class="kw-2">&amp;</span>Attribute) -&gt; bool {
<a href=#553 id=553 data-nosnippet>553</a> <span class="kw">let </span>path = <span class="kw">match </span><span class="kw-2">&amp;</span>attr.meta {
<a href=#554 id=554 data-nosnippet>554</a> syn::Meta::Path(path) =&gt; path,
<a href=#555 id=555 data-nosnippet>555</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="bool-val">false</span>,
<a href=#556 id=556 data-nosnippet>556</a> };
<a href=#557 id=557 data-nosnippet>557</a> <span class="kw">let </span>candidates = [
<a href=#558 id=558 data-nosnippet>558</a> [<span class="string">"core"</span>, <span class="string">"prelude"</span>, <span class="string">"*"</span>, <span class="string">"test"</span>],
<a href=#559 id=559 data-nosnippet>559</a> [<span class="string">"std"</span>, <span class="string">"prelude"</span>, <span class="string">"*"</span>, <span class="string">"test"</span>],
<a href=#560 id=560 data-nosnippet>560</a> ];
<a href=#561 id=561 data-nosnippet>561</a> <span class="kw">if </span>path.leading_colon.is_none()
<a href=#562 id=562 data-nosnippet>562</a> &amp;&amp; path.segments.len() == <span class="number">1
<a href=#563 id=563 data-nosnippet>563</a> </span>&amp;&amp; path.segments[<span class="number">0</span>].arguments.is_none()
<a href=#564 id=564 data-nosnippet>564</a> &amp;&amp; path.segments[<span class="number">0</span>].ident == <span class="string">"test"
<a href=#565 id=565 data-nosnippet>565</a> </span>{
<a href=#566 id=566 data-nosnippet>566</a> <span class="kw">return </span><span class="bool-val">true</span>;
<a href=#567 id=567 data-nosnippet>567</a> } <span class="kw">else if </span>path.segments.len() != candidates[<span class="number">0</span>].len() {
<a href=#568 id=568 data-nosnippet>568</a> <span class="kw">return </span><span class="bool-val">false</span>;
<a href=#569 id=569 data-nosnippet>569</a> }
<a href=#570 id=570 data-nosnippet>570</a> candidates.into_iter().any(|segments| {
<a href=#571 id=571 data-nosnippet>571</a> path.segments.iter().zip(segments).all(|(segment, path)| {
<a href=#572 id=572 data-nosnippet>572</a> segment.arguments.is_none() &amp;&amp; (path == <span class="string">"*" </span>|| segment.ident == path)
<a href=#573 id=573 data-nosnippet>573</a> })
<a href=#574 id=574 data-nosnippet>574</a> })
<a href=#575 id=575 data-nosnippet>575</a>}
<a href=#576 id=576 data-nosnippet>576</a>
<a href=#577 id=577 data-nosnippet>577</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>test(args: TokenStream, item: TokenStream, rt_multi_thread: bool) -&gt; TokenStream {
<a href=#578 id=578 data-nosnippet>578</a> <span class="comment">// If any of the steps for this macro fail, we still want to expand to an item that is as close
<a href=#579 id=579 data-nosnippet>579</a> // to the expected output as possible. This helps out IDEs such that completions and other
<a href=#580 id=580 data-nosnippet>580</a> // related features keep working.
<a href=#581 id=581 data-nosnippet>581</a> </span><span class="kw">let </span>input: ItemFn = <span class="kw">match </span>syn::parse2(item.clone()) {
<a href=#582 id=582 data-nosnippet>582</a> <span class="prelude-val">Ok</span>(it) =&gt; it,
<a href=#583 id=583 data-nosnippet>583</a> <span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span>token_stream_with_error(item, e),
<a href=#584 id=584 data-nosnippet>584</a> };
<a href=#585 id=585 data-nosnippet>585</a> <span class="kw">let </span>config = <span class="kw">if let </span><span class="prelude-val">Some</span>(attr) = input.attrs().find(|attr| is_test_attribute(attr)) {
<a href=#586 id=586 data-nosnippet>586</a> <span class="kw">let </span>msg = <span class="string">"second test attribute is supplied, consider removing or changing the order of your test attributes"</span>;
<a href=#587 id=587 data-nosnippet>587</a> <span class="prelude-val">Err</span>(syn::Error::new_spanned(attr, msg))
<a href=#588 id=588 data-nosnippet>588</a> } <span class="kw">else </span>{
<a href=#589 id=589 data-nosnippet>589</a> AttributeArgs::parse_terminated
<a href=#590 id=590 data-nosnippet>590</a> .parse2(args)
<a href=#591 id=591 data-nosnippet>591</a> .and_then(|args| build_config(<span class="kw-2">&amp;</span>input, args, <span class="bool-val">true</span>, rt_multi_thread))
<a href=#592 id=592 data-nosnippet>592</a> };
<a href=#593 id=593 data-nosnippet>593</a>
<a href=#594 id=594 data-nosnippet>594</a> <span class="kw">match </span>config {
<a href=#595 id=595 data-nosnippet>595</a> <span class="prelude-val">Ok</span>(config) =&gt; parse_knobs(input, <span class="bool-val">true</span>, config),
<a href=#596 id=596 data-nosnippet>596</a> <span class="prelude-val">Err</span>(e) =&gt; token_stream_with_error(parse_knobs(input, <span class="bool-val">true</span>, DEFAULT_ERROR_CONFIG), e),
<a href=#597 id=597 data-nosnippet>597</a> }
<a href=#598 id=598 data-nosnippet>598</a>}
<a href=#599 id=599 data-nosnippet>599</a>
<a href=#600 id=600 data-nosnippet>600</a><span class="kw">struct </span>ItemFn {
<a href=#601 id=601 data-nosnippet>601</a> outer_attrs: Vec&lt;Attribute&gt;,
<a href=#602 id=602 data-nosnippet>602</a> vis: Visibility,
<a href=#603 id=603 data-nosnippet>603</a> sig: Signature,
<a href=#604 id=604 data-nosnippet>604</a> brace_token: syn::token::Brace,
<a href=#605 id=605 data-nosnippet>605</a> inner_attrs: Vec&lt;Attribute&gt;,
<a href=#606 id=606 data-nosnippet>606</a> stmts: Vec&lt;proc_macro2::TokenStream&gt;,
<a href=#607 id=607 data-nosnippet>607</a>}
<a href=#608 id=608 data-nosnippet>608</a>
<a href=#609 id=609 data-nosnippet>609</a><span class="kw">impl </span>ItemFn {
<a href=#610 id=610 data-nosnippet>610</a> <span class="doccomment">/// Access all attributes of the function item.
<a href=#611 id=611 data-nosnippet>611</a> </span><span class="kw">fn </span>attrs(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">impl </span>Iterator&lt;Item = <span class="kw-2">&amp;</span>Attribute&gt; {
<a href=#612 id=612 data-nosnippet>612</a> <span class="self">self</span>.outer_attrs.iter().chain(<span class="self">self</span>.inner_attrs.iter())
<a href=#613 id=613 data-nosnippet>613</a> }
<a href=#614 id=614 data-nosnippet>614</a>
<a href=#615 id=615 data-nosnippet>615</a> <span class="doccomment">/// Get the body of the function item in a manner so that it can be
<a href=#616 id=616 data-nosnippet>616</a> /// conveniently used with the `quote!` macro.
<a href=#617 id=617 data-nosnippet>617</a> </span><span class="kw">fn </span>body(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Body&lt;<span class="lifetime">'_</span>&gt; {
<a href=#618 id=618 data-nosnippet>618</a> Body {
<a href=#619 id=619 data-nosnippet>619</a> brace_token: <span class="self">self</span>.brace_token,
<a href=#620 id=620 data-nosnippet>620</a> stmts: <span class="kw-2">&amp;</span><span class="self">self</span>.stmts,
<a href=#621 id=621 data-nosnippet>621</a> }
<a href=#622 id=622 data-nosnippet>622</a> }
<a href=#623 id=623 data-nosnippet>623</a>
<a href=#624 id=624 data-nosnippet>624</a> <span class="doccomment">/// Convert our local function item into a token stream.
<a href=#625 id=625 data-nosnippet>625</a> </span><span class="kw">fn </span>into_tokens(
<a href=#626 id=626 data-nosnippet>626</a> <span class="self">self</span>,
<a href=#627 id=627 data-nosnippet>627</a> generated_attrs: proc_macro2::TokenStream,
<a href=#628 id=628 data-nosnippet>628</a> body: proc_macro2::TokenStream,
<a href=#629 id=629 data-nosnippet>629</a> last_block: proc_macro2::TokenStream,
<a href=#630 id=630 data-nosnippet>630</a> ) -&gt; TokenStream {
<a href=#631 id=631 data-nosnippet>631</a> <span class="kw">let </span><span class="kw-2">mut </span>tokens = proc_macro2::TokenStream::new();
<a href=#632 id=632 data-nosnippet>632</a> <span class="comment">// Outer attributes are simply streamed as-is.
<a href=#633 id=633 data-nosnippet>633</a> </span><span class="kw">for </span>attr <span class="kw">in </span><span class="self">self</span>.outer_attrs {
<a href=#634 id=634 data-nosnippet>634</a> attr.to_tokens(<span class="kw-2">&amp;mut </span>tokens);
<a href=#635 id=635 data-nosnippet>635</a> }
<a href=#636 id=636 data-nosnippet>636</a>
<a href=#637 id=637 data-nosnippet>637</a> <span class="comment">// Inner attributes require extra care, since they're not supported on
<a href=#638 id=638 data-nosnippet>638</a> // blocks (which is what we're expanded into) we instead lift them
<a href=#639 id=639 data-nosnippet>639</a> // outside of the function. This matches the behavior of `syn`.
<a href=#640 id=640 data-nosnippet>640</a> </span><span class="kw">for </span><span class="kw-2">mut </span>attr <span class="kw">in </span><span class="self">self</span>.inner_attrs {
<a href=#641 id=641 data-nosnippet>641</a> attr.style = syn::AttrStyle::Outer;
<a href=#642 id=642 data-nosnippet>642</a> attr.to_tokens(<span class="kw-2">&amp;mut </span>tokens);
<a href=#643 id=643 data-nosnippet>643</a> }
<a href=#644 id=644 data-nosnippet>644</a>
<a href=#645 id=645 data-nosnippet>645</a> <span class="comment">// Add generated macros at the end, so macros processed later are aware of them.
<a href=#646 id=646 data-nosnippet>646</a> </span>generated_attrs.to_tokens(<span class="kw-2">&amp;mut </span>tokens);
<a href=#647 id=647 data-nosnippet>647</a>
<a href=#648 id=648 data-nosnippet>648</a> <span class="self">self</span>.vis.to_tokens(<span class="kw-2">&amp;mut </span>tokens);
<a href=#649 id=649 data-nosnippet>649</a> <span class="self">self</span>.sig.to_tokens(<span class="kw-2">&amp;mut </span>tokens);
<a href=#650 id=650 data-nosnippet>650</a>
<a href=#651 id=651 data-nosnippet>651</a> <span class="self">self</span>.brace_token.surround(<span class="kw-2">&amp;mut </span>tokens, |tokens| {
<a href=#652 id=652 data-nosnippet>652</a> body.to_tokens(tokens);
<a href=#653 id=653 data-nosnippet>653</a> last_block.to_tokens(tokens);
<a href=#654 id=654 data-nosnippet>654</a> });
<a href=#655 id=655 data-nosnippet>655</a>
<a href=#656 id=656 data-nosnippet>656</a> tokens
<a href=#657 id=657 data-nosnippet>657</a> }
<a href=#658 id=658 data-nosnippet>658</a>}
<a href=#659 id=659 data-nosnippet>659</a>
<a href=#660 id=660 data-nosnippet>660</a><span class="kw">impl </span>Parse <span class="kw">for </span>ItemFn {
<a href=#661 id=661 data-nosnippet>661</a> <span class="attr">#[inline]
<a href=#662 id=662 data-nosnippet>662</a> </span><span class="kw">fn </span>parse(input: ParseStream&lt;<span class="lifetime">'_</span>&gt;) -&gt; syn::Result&lt;<span class="self">Self</span>&gt; {
<a href=#663 id=663 data-nosnippet>663</a> <span class="comment">// This parse implementation has been largely lifted from `syn`, with
<a href=#664 id=664 data-nosnippet>664</a> // the exception of:
<a href=#665 id=665 data-nosnippet>665</a> // * We don't have access to the plumbing necessary to parse inner
<a href=#666 id=666 data-nosnippet>666</a> // attributes in-place.
<a href=#667 id=667 data-nosnippet>667</a> // * We do our own statements parsing to avoid recursively parsing
<a href=#668 id=668 data-nosnippet>668</a> // entire statements and only look for the parts we're interested in.
<a href=#669 id=669 data-nosnippet>669</a>
<a href=#670 id=670 data-nosnippet>670</a> </span><span class="kw">let </span>outer_attrs = input.call(Attribute::parse_outer)<span class="question-mark">?</span>;
<a href=#671 id=671 data-nosnippet>671</a> <span class="kw">let </span>vis: Visibility = input.parse()<span class="question-mark">?</span>;
<a href=#672 id=672 data-nosnippet>672</a> <span class="kw">let </span>sig: Signature = input.parse()<span class="question-mark">?</span>;
<a href=#673 id=673 data-nosnippet>673</a>
<a href=#674 id=674 data-nosnippet>674</a> <span class="kw">let </span>content;
<a href=#675 id=675 data-nosnippet>675</a> <span class="kw">let </span>brace_token = <span class="macro">braced!</span>(content <span class="kw">in </span>input);
<a href=#676 id=676 data-nosnippet>676</a> <span class="kw">let </span>inner_attrs = Attribute::parse_inner(<span class="kw-2">&amp;</span>content)<span class="question-mark">?</span>;
<a href=#677 id=677 data-nosnippet>677</a>
<a href=#678 id=678 data-nosnippet>678</a> <span class="kw">let </span><span class="kw-2">mut </span>buf = proc_macro2::TokenStream::new();
<a href=#679 id=679 data-nosnippet>679</a> <span class="kw">let </span><span class="kw-2">mut </span>stmts = Vec::new();
<a href=#680 id=680 data-nosnippet>680</a>
<a href=#681 id=681 data-nosnippet>681</a> <span class="kw">while </span>!content.is_empty() {
<a href=#682 id=682 data-nosnippet>682</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(semi) = content.parse::&lt;<span class="prelude-ty">Option</span>&lt;<span class="macro">syn::Token!</span>[;]&gt;&gt;()<span class="question-mark">? </span>{
<a href=#683 id=683 data-nosnippet>683</a> semi.to_tokens(<span class="kw-2">&amp;mut </span>buf);
<a href=#684 id=684 data-nosnippet>684</a> stmts.push(buf);
<a href=#685 id=685 data-nosnippet>685</a> buf = proc_macro2::TokenStream::new();
<a href=#686 id=686 data-nosnippet>686</a> <span class="kw">continue</span>;
<a href=#687 id=687 data-nosnippet>687</a> }
<a href=#688 id=688 data-nosnippet>688</a>
<a href=#689 id=689 data-nosnippet>689</a> <span class="comment">// Parse a single token tree and extend our current buffer with it.
<a href=#690 id=690 data-nosnippet>690</a> // This avoids parsing the entire content of the sub-tree.
<a href=#691 id=691 data-nosnippet>691</a> </span>buf.extend([content.parse::&lt;TokenTree&gt;()<span class="question-mark">?</span>]);
<a href=#692 id=692 data-nosnippet>692</a> }
<a href=#693 id=693 data-nosnippet>693</a>
<a href=#694 id=694 data-nosnippet>694</a> <span class="kw">if </span>!buf.is_empty() {
<a href=#695 id=695 data-nosnippet>695</a> stmts.push(buf);
<a href=#696 id=696 data-nosnippet>696</a> }
<a href=#697 id=697 data-nosnippet>697</a>
<a href=#698 id=698 data-nosnippet>698</a> <span class="prelude-val">Ok</span>(<span class="self">Self </span>{
<a href=#699 id=699 data-nosnippet>699</a> outer_attrs,
<a href=#700 id=700 data-nosnippet>700</a> vis,
<a href=#701 id=701 data-nosnippet>701</a> sig,
<a href=#702 id=702 data-nosnippet>702</a> brace_token,
<a href=#703 id=703 data-nosnippet>703</a> inner_attrs,
<a href=#704 id=704 data-nosnippet>704</a> stmts,
<a href=#705 id=705 data-nosnippet>705</a> })
<a href=#706 id=706 data-nosnippet>706</a> }
<a href=#707 id=707 data-nosnippet>707</a>}
<a href=#708 id=708 data-nosnippet>708</a>
<a href=#709 id=709 data-nosnippet>709</a><span class="kw">struct </span>Body&lt;<span class="lifetime">'a</span>&gt; {
<a href=#710 id=710 data-nosnippet>710</a> brace_token: syn::token::Brace,
<a href=#711 id=711 data-nosnippet>711</a> <span class="comment">// Statements, with terminating `;`.
<a href=#712 id=712 data-nosnippet>712</a> </span>stmts: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>[TokenStream],
<a href=#713 id=713 data-nosnippet>713</a>}
<a href=#714 id=714 data-nosnippet>714</a>
<a href=#715 id=715 data-nosnippet>715</a><span class="kw">impl </span>ToTokens <span class="kw">for </span>Body&lt;<span class="lifetime">'_</span>&gt; {
<a href=#716 id=716 data-nosnippet>716</a> <span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>proc_macro2::TokenStream) {
<a href=#717 id=717 data-nosnippet>717</a> <span class="self">self</span>.brace_token.surround(tokens, |tokens| {
<a href=#718 id=718 data-nosnippet>718</a> <span class="kw">for </span>stmt <span class="kw">in </span><span class="self">self</span>.stmts {
<a href=#719 id=719 data-nosnippet>719</a> stmt.to_tokens(tokens);
<a href=#720 id=720 data-nosnippet>720</a> }
<a href=#721 id=721 data-nosnippet>721</a> });
<a href=#722 id=722 data-nosnippet>722</a> }
<a href=#723 id=723 data-nosnippet>723</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,636 @@
<!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="Source of the Rust file `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/tokio-macros-2.6.0/src/lib.rs`."><title>lib.rs - source</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_macros" 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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[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="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">tokio_macros/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="attr">#![allow(clippy::needless_doctest_main)]
<a href=#2 id=2 data-nosnippet>2</a>#![warn(
<a href=#3 id=3 data-nosnippet>3</a> missing_debug_implementations,
<a href=#4 id=4 data-nosnippet>4</a> missing_docs,
<a href=#5 id=5 data-nosnippet>5</a> rust_2018_idioms,
<a href=#6 id=6 data-nosnippet>6</a> unreachable_pub
<a href=#7 id=7 data-nosnippet>7</a>)]
<a href=#8 id=8 data-nosnippet>8</a>#![doc(test(
<a href=#9 id=9 data-nosnippet>9</a> no_crate_inject,
<a href=#10 id=10 data-nosnippet>10</a> attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables))
<a href=#11 id=11 data-nosnippet>11</a>))]
<a href=#12 id=12 data-nosnippet>12</a>
<a href=#13 id=13 data-nosnippet>13</a></span><span class="doccomment">//! Macros for use with Tokio
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="comment">// This `extern` is required for older `rustc` versions but newer `rustc`
<a href=#16 id=16 data-nosnippet>16</a>// versions warn about the unused `extern crate`.
<a href=#17 id=17 data-nosnippet>17</a></span><span class="attr">#[allow(unused_extern_crates)]
<a href=#18 id=18 data-nosnippet>18</a></span><span class="kw">extern crate </span>proc_macro;
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">mod </span>entry;
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">mod </span>select;
<a href=#22 id=22 data-nosnippet>22</a>
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>proc_macro::TokenStream;
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a><span class="doccomment">/// Marks async function to be executed by the selected runtime. This macro
<a href=#26 id=26 data-nosnippet>26</a>/// helps set up a `Runtime` without requiring the user to use
<a href=#27 id=27 data-nosnippet>27</a>/// [Runtime](../tokio/runtime/struct.Runtime.html) or
<a href=#28 id=28 data-nosnippet>28</a>/// [Builder](../tokio/runtime/struct.Builder.html) directly.
<a href=#29 id=29 data-nosnippet>29</a>///
<a href=#30 id=30 data-nosnippet>30</a>/// Note: This macro is designed to be simplistic and targets applications that
<a href=#31 id=31 data-nosnippet>31</a>/// do not require a complex setup. If the provided functionality is not
<a href=#32 id=32 data-nosnippet>32</a>/// sufficient, you may be interested in using
<a href=#33 id=33 data-nosnippet>33</a>/// [Builder](../tokio/runtime/struct.Builder.html), which provides a more
<a href=#34 id=34 data-nosnippet>34</a>/// powerful interface.
<a href=#35 id=35 data-nosnippet>35</a>///
<a href=#36 id=36 data-nosnippet>36</a>/// Note: This macro can be used on any function and not just the `main`
<a href=#37 id=37 data-nosnippet>37</a>/// function. Using it on a non-main function makes the function behave as if it
<a href=#38 id=38 data-nosnippet>38</a>/// was synchronous by starting a new runtime each time it is called. If the
<a href=#39 id=39 data-nosnippet>39</a>/// function is called often, it is preferable to create the runtime using the
<a href=#40 id=40 data-nosnippet>40</a>/// runtime builder so the runtime can be reused across calls.
<a href=#41 id=41 data-nosnippet>41</a>///
<a href=#42 id=42 data-nosnippet>42</a>/// # Non-worker async function
<a href=#43 id=43 data-nosnippet>43</a>///
<a href=#44 id=44 data-nosnippet>44</a>/// Note that the async function marked with this macro does not run as a
<a href=#45 id=45 data-nosnippet>45</a>/// worker. The expectation is that other tasks are spawned by the function here.
<a href=#46 id=46 data-nosnippet>46</a>/// Awaiting on other futures from the function provided here will not
<a href=#47 id=47 data-nosnippet>47</a>/// perform as fast as those spawned as workers.
<a href=#48 id=48 data-nosnippet>48</a>///
<a href=#49 id=49 data-nosnippet>49</a>/// # Runtime flavors
<a href=#50 id=50 data-nosnippet>50</a>///
<a href=#51 id=51 data-nosnippet>51</a>/// The macro can be configured with a `flavor` parameter to select
<a href=#52 id=52 data-nosnippet>52</a>/// different runtime configurations.
<a href=#53 id=53 data-nosnippet>53</a>///
<a href=#54 id=54 data-nosnippet>54</a>/// ## Multi-threaded
<a href=#55 id=55 data-nosnippet>55</a>///
<a href=#56 id=56 data-nosnippet>56</a>/// To use the multi-threaded runtime, the macro can be configured using
<a href=#57 id=57 data-nosnippet>57</a>///
<a href=#58 id=58 data-nosnippet>58</a>/// ```
<a href=#59 id=59 data-nosnippet>59</a>/// #[tokio::main(flavor = "multi_thread", worker_threads = 10)]
<a href=#60 id=60 data-nosnippet>60</a>/// # async fn main() {}
<a href=#61 id=61 data-nosnippet>61</a>/// ```
<a href=#62 id=62 data-nosnippet>62</a>///
<a href=#63 id=63 data-nosnippet>63</a>/// The `worker_threads` option configures the number of worker threads, and
<a href=#64 id=64 data-nosnippet>64</a>/// defaults to the number of cpus on the system. This is the default flavor.
<a href=#65 id=65 data-nosnippet>65</a>///
<a href=#66 id=66 data-nosnippet>66</a>/// Note: The multi-threaded runtime requires the `rt-multi-thread` feature
<a href=#67 id=67 data-nosnippet>67</a>/// flag.
<a href=#68 id=68 data-nosnippet>68</a>///
<a href=#69 id=69 data-nosnippet>69</a>/// ## Current-thread
<a href=#70 id=70 data-nosnippet>70</a>///
<a href=#71 id=71 data-nosnippet>71</a>/// To use the single-threaded runtime known as the `current_thread` runtime,
<a href=#72 id=72 data-nosnippet>72</a>/// the macro can be configured using
<a href=#73 id=73 data-nosnippet>73</a>///
<a href=#74 id=74 data-nosnippet>74</a>/// ```rust
<a href=#75 id=75 data-nosnippet>75</a>/// #[tokio::main(flavor = "current_thread")]
<a href=#76 id=76 data-nosnippet>76</a>/// # async fn main() {}
<a href=#77 id=77 data-nosnippet>77</a>/// ```
<a href=#78 id=78 data-nosnippet>78</a>///
<a href=#79 id=79 data-nosnippet>79</a>/// ## Local
<a href=#80 id=80 data-nosnippet>80</a>///
<a href=#81 id=81 data-nosnippet>81</a>/// [Unstable API][unstable] only.
<a href=#82 id=82 data-nosnippet>82</a>///
<a href=#83 id=83 data-nosnippet>83</a>/// To use the [local runtime], the macro can be configured using
<a href=#84 id=84 data-nosnippet>84</a>///
<a href=#85 id=85 data-nosnippet>85</a>/// ```rust
<a href=#86 id=86 data-nosnippet>86</a>/// # #[cfg(tokio_unstable)]
<a href=#87 id=87 data-nosnippet>87</a>/// #[tokio::main(flavor = "local")]
<a href=#88 id=88 data-nosnippet>88</a>/// # async fn main() {}
<a href=#89 id=89 data-nosnippet>89</a>/// # #[cfg(not(tokio_unstable))]
<a href=#90 id=90 data-nosnippet>90</a>/// # fn main() {}
<a href=#91 id=91 data-nosnippet>91</a>/// ```
<a href=#92 id=92 data-nosnippet>92</a>///
<a href=#93 id=93 data-nosnippet>93</a>/// # Function arguments
<a href=#94 id=94 data-nosnippet>94</a>///
<a href=#95 id=95 data-nosnippet>95</a>/// Arguments are allowed for any functions, aside from `main` which is special.
<a href=#96 id=96 data-nosnippet>96</a>///
<a href=#97 id=97 data-nosnippet>97</a>/// # Usage
<a href=#98 id=98 data-nosnippet>98</a>///
<a href=#99 id=99 data-nosnippet>99</a>/// ## Using the multi-threaded runtime
<a href=#100 id=100 data-nosnippet>100</a>///
<a href=#101 id=101 data-nosnippet>101</a>/// ```rust
<a href=#102 id=102 data-nosnippet>102</a>/// #[tokio::main]
<a href=#103 id=103 data-nosnippet>103</a>/// async fn main() {
<a href=#104 id=104 data-nosnippet>104</a>/// println!("Hello world");
<a href=#105 id=105 data-nosnippet>105</a>/// }
<a href=#106 id=106 data-nosnippet>106</a>/// ```
<a href=#107 id=107 data-nosnippet>107</a>///
<a href=#108 id=108 data-nosnippet>108</a>/// Equivalent code not using `#[tokio::main]`
<a href=#109 id=109 data-nosnippet>109</a>///
<a href=#110 id=110 data-nosnippet>110</a>/// ```rust
<a href=#111 id=111 data-nosnippet>111</a>/// fn main() {
<a href=#112 id=112 data-nosnippet>112</a>/// tokio::runtime::Builder::new_multi_thread()
<a href=#113 id=113 data-nosnippet>113</a>/// .enable_all()
<a href=#114 id=114 data-nosnippet>114</a>/// .build()
<a href=#115 id=115 data-nosnippet>115</a>/// .unwrap()
<a href=#116 id=116 data-nosnippet>116</a>/// .block_on(async {
<a href=#117 id=117 data-nosnippet>117</a>/// println!("Hello world");
<a href=#118 id=118 data-nosnippet>118</a>/// })
<a href=#119 id=119 data-nosnippet>119</a>/// }
<a href=#120 id=120 data-nosnippet>120</a>/// ```
<a href=#121 id=121 data-nosnippet>121</a>///
<a href=#122 id=122 data-nosnippet>122</a>/// ## Using the current-thread runtime
<a href=#123 id=123 data-nosnippet>123</a>///
<a href=#124 id=124 data-nosnippet>124</a>/// The basic scheduler is single-threaded.
<a href=#125 id=125 data-nosnippet>125</a>///
<a href=#126 id=126 data-nosnippet>126</a>/// ```rust
<a href=#127 id=127 data-nosnippet>127</a>/// #[tokio::main(flavor = "current_thread")]
<a href=#128 id=128 data-nosnippet>128</a>/// async fn main() {
<a href=#129 id=129 data-nosnippet>129</a>/// println!("Hello world");
<a href=#130 id=130 data-nosnippet>130</a>/// }
<a href=#131 id=131 data-nosnippet>131</a>/// ```
<a href=#132 id=132 data-nosnippet>132</a>///
<a href=#133 id=133 data-nosnippet>133</a>/// Equivalent code not using `#[tokio::main]`
<a href=#134 id=134 data-nosnippet>134</a>///
<a href=#135 id=135 data-nosnippet>135</a>/// ```rust
<a href=#136 id=136 data-nosnippet>136</a>/// fn main() {
<a href=#137 id=137 data-nosnippet>137</a>/// tokio::runtime::Builder::new_current_thread()
<a href=#138 id=138 data-nosnippet>138</a>/// .enable_all()
<a href=#139 id=139 data-nosnippet>139</a>/// .build()
<a href=#140 id=140 data-nosnippet>140</a>/// .unwrap()
<a href=#141 id=141 data-nosnippet>141</a>/// .block_on(async {
<a href=#142 id=142 data-nosnippet>142</a>/// println!("Hello world");
<a href=#143 id=143 data-nosnippet>143</a>/// })
<a href=#144 id=144 data-nosnippet>144</a>/// }
<a href=#145 id=145 data-nosnippet>145</a>/// ```
<a href=#146 id=146 data-nosnippet>146</a>///
<a href=#147 id=147 data-nosnippet>147</a>/// ## Using the local runtime
<a href=#148 id=148 data-nosnippet>148</a>///
<a href=#149 id=149 data-nosnippet>149</a>/// Available in the [unstable API][unstable] only.
<a href=#150 id=150 data-nosnippet>150</a>///
<a href=#151 id=151 data-nosnippet>151</a>/// The [local runtime] is similar to the current-thread runtime but
<a href=#152 id=152 data-nosnippet>152</a>/// supports [`task::spawn_local`](../tokio/task/fn.spawn_local.html).
<a href=#153 id=153 data-nosnippet>153</a>///
<a href=#154 id=154 data-nosnippet>154</a>/// ```rust
<a href=#155 id=155 data-nosnippet>155</a>/// # #[cfg(tokio_unstable)]
<a href=#156 id=156 data-nosnippet>156</a>/// #[tokio::main(flavor = "local")]
<a href=#157 id=157 data-nosnippet>157</a>/// async fn main() {
<a href=#158 id=158 data-nosnippet>158</a>/// println!("Hello world");
<a href=#159 id=159 data-nosnippet>159</a>/// }
<a href=#160 id=160 data-nosnippet>160</a>/// # #[cfg(not(tokio_unstable))]
<a href=#161 id=161 data-nosnippet>161</a>/// # fn main() {}
<a href=#162 id=162 data-nosnippet>162</a>/// ```
<a href=#163 id=163 data-nosnippet>163</a>///
<a href=#164 id=164 data-nosnippet>164</a>/// Equivalent code not using `#[tokio::main]`
<a href=#165 id=165 data-nosnippet>165</a>///
<a href=#166 id=166 data-nosnippet>166</a>/// ```rust
<a href=#167 id=167 data-nosnippet>167</a>/// # #[cfg(tokio_unstable)]
<a href=#168 id=168 data-nosnippet>168</a>/// fn main() {
<a href=#169 id=169 data-nosnippet>169</a>/// tokio::runtime::Builder::new_current_thread()
<a href=#170 id=170 data-nosnippet>170</a>/// .enable_all()
<a href=#171 id=171 data-nosnippet>171</a>/// .build_local(tokio::runtime::LocalOptions::default())
<a href=#172 id=172 data-nosnippet>172</a>/// .unwrap()
<a href=#173 id=173 data-nosnippet>173</a>/// .block_on(async {
<a href=#174 id=174 data-nosnippet>174</a>/// println!("Hello world");
<a href=#175 id=175 data-nosnippet>175</a>/// })
<a href=#176 id=176 data-nosnippet>176</a>/// }
<a href=#177 id=177 data-nosnippet>177</a>/// # #[cfg(not(tokio_unstable))]
<a href=#178 id=178 data-nosnippet>178</a>/// # fn main() {}
<a href=#179 id=179 data-nosnippet>179</a>/// ```
<a href=#180 id=180 data-nosnippet>180</a>///
<a href=#181 id=181 data-nosnippet>181</a>///
<a href=#182 id=182 data-nosnippet>182</a>/// ## Set number of worker threads
<a href=#183 id=183 data-nosnippet>183</a>///
<a href=#184 id=184 data-nosnippet>184</a>/// ```rust
<a href=#185 id=185 data-nosnippet>185</a>/// #[tokio::main(worker_threads = 2)]
<a href=#186 id=186 data-nosnippet>186</a>/// async fn main() {
<a href=#187 id=187 data-nosnippet>187</a>/// println!("Hello world");
<a href=#188 id=188 data-nosnippet>188</a>/// }
<a href=#189 id=189 data-nosnippet>189</a>/// ```
<a href=#190 id=190 data-nosnippet>190</a>///
<a href=#191 id=191 data-nosnippet>191</a>/// Equivalent code not using `#[tokio::main]`
<a href=#192 id=192 data-nosnippet>192</a>///
<a href=#193 id=193 data-nosnippet>193</a>/// ```rust
<a href=#194 id=194 data-nosnippet>194</a>/// fn main() {
<a href=#195 id=195 data-nosnippet>195</a>/// tokio::runtime::Builder::new_multi_thread()
<a href=#196 id=196 data-nosnippet>196</a>/// .worker_threads(2)
<a href=#197 id=197 data-nosnippet>197</a>/// .enable_all()
<a href=#198 id=198 data-nosnippet>198</a>/// .build()
<a href=#199 id=199 data-nosnippet>199</a>/// .unwrap()
<a href=#200 id=200 data-nosnippet>200</a>/// .block_on(async {
<a href=#201 id=201 data-nosnippet>201</a>/// println!("Hello world");
<a href=#202 id=202 data-nosnippet>202</a>/// })
<a href=#203 id=203 data-nosnippet>203</a>/// }
<a href=#204 id=204 data-nosnippet>204</a>/// ```
<a href=#205 id=205 data-nosnippet>205</a>///
<a href=#206 id=206 data-nosnippet>206</a>/// ## Configure the runtime to start with time paused
<a href=#207 id=207 data-nosnippet>207</a>///
<a href=#208 id=208 data-nosnippet>208</a>/// ```rust
<a href=#209 id=209 data-nosnippet>209</a>/// #[tokio::main(flavor = "current_thread", start_paused = true)]
<a href=#210 id=210 data-nosnippet>210</a>/// async fn main() {
<a href=#211 id=211 data-nosnippet>211</a>/// println!("Hello world");
<a href=#212 id=212 data-nosnippet>212</a>/// }
<a href=#213 id=213 data-nosnippet>213</a>/// ```
<a href=#214 id=214 data-nosnippet>214</a>///
<a href=#215 id=215 data-nosnippet>215</a>/// Equivalent code not using `#[tokio::main]`
<a href=#216 id=216 data-nosnippet>216</a>///
<a href=#217 id=217 data-nosnippet>217</a>/// ```rust
<a href=#218 id=218 data-nosnippet>218</a>/// fn main() {
<a href=#219 id=219 data-nosnippet>219</a>/// tokio::runtime::Builder::new_current_thread()
<a href=#220 id=220 data-nosnippet>220</a>/// .enable_all()
<a href=#221 id=221 data-nosnippet>221</a>/// .start_paused(true)
<a href=#222 id=222 data-nosnippet>222</a>/// .build()
<a href=#223 id=223 data-nosnippet>223</a>/// .unwrap()
<a href=#224 id=224 data-nosnippet>224</a>/// .block_on(async {
<a href=#225 id=225 data-nosnippet>225</a>/// println!("Hello world");
<a href=#226 id=226 data-nosnippet>226</a>/// })
<a href=#227 id=227 data-nosnippet>227</a>/// }
<a href=#228 id=228 data-nosnippet>228</a>/// ```
<a href=#229 id=229 data-nosnippet>229</a>///
<a href=#230 id=230 data-nosnippet>230</a>/// Note that `start_paused` requires the `test-util` feature to be enabled.
<a href=#231 id=231 data-nosnippet>231</a>///
<a href=#232 id=232 data-nosnippet>232</a>/// ## Rename package
<a href=#233 id=233 data-nosnippet>233</a>///
<a href=#234 id=234 data-nosnippet>234</a>/// ```rust
<a href=#235 id=235 data-nosnippet>235</a>/// use tokio as tokio1;
<a href=#236 id=236 data-nosnippet>236</a>///
<a href=#237 id=237 data-nosnippet>237</a>/// #[tokio1::main(crate = "tokio1")]
<a href=#238 id=238 data-nosnippet>238</a>/// async fn main() {
<a href=#239 id=239 data-nosnippet>239</a>/// println!("Hello world");
<a href=#240 id=240 data-nosnippet>240</a>/// }
<a href=#241 id=241 data-nosnippet>241</a>/// ```
<a href=#242 id=242 data-nosnippet>242</a>///
<a href=#243 id=243 data-nosnippet>243</a>/// Equivalent code not using `#[tokio::main]`
<a href=#244 id=244 data-nosnippet>244</a>///
<a href=#245 id=245 data-nosnippet>245</a>/// ```rust
<a href=#246 id=246 data-nosnippet>246</a>/// use tokio as tokio1;
<a href=#247 id=247 data-nosnippet>247</a>///
<a href=#248 id=248 data-nosnippet>248</a>/// fn main() {
<a href=#249 id=249 data-nosnippet>249</a>/// tokio1::runtime::Builder::new_multi_thread()
<a href=#250 id=250 data-nosnippet>250</a>/// .enable_all()
<a href=#251 id=251 data-nosnippet>251</a>/// .build()
<a href=#252 id=252 data-nosnippet>252</a>/// .unwrap()
<a href=#253 id=253 data-nosnippet>253</a>/// .block_on(async {
<a href=#254 id=254 data-nosnippet>254</a>/// println!("Hello world");
<a href=#255 id=255 data-nosnippet>255</a>/// })
<a href=#256 id=256 data-nosnippet>256</a>/// }
<a href=#257 id=257 data-nosnippet>257</a>/// ```
<a href=#258 id=258 data-nosnippet>258</a>///
<a href=#259 id=259 data-nosnippet>259</a>/// ## Configure unhandled panic behavior
<a href=#260 id=260 data-nosnippet>260</a>///
<a href=#261 id=261 data-nosnippet>261</a>/// Available options are `shutdown_runtime` and `ignore`. For more details, see
<a href=#262 id=262 data-nosnippet>262</a>/// [`Builder::unhandled_panic`].
<a href=#263 id=263 data-nosnippet>263</a>///
<a href=#264 id=264 data-nosnippet>264</a>/// This option is only compatible with the `current_thread` runtime.
<a href=#265 id=265 data-nosnippet>265</a>///
<a href=#266 id=266 data-nosnippet>266</a>/// ```no_run
<a href=#267 id=267 data-nosnippet>267</a>/// #[cfg(tokio_unstable)]
<a href=#268 id=268 data-nosnippet>268</a>/// #[tokio::main(flavor = "current_thread", unhandled_panic = "shutdown_runtime")]
<a href=#269 id=269 data-nosnippet>269</a>/// async fn main() {
<a href=#270 id=270 data-nosnippet>270</a>/// let _ = tokio::spawn(async {
<a href=#271 id=271 data-nosnippet>271</a>/// panic!("This panic will shutdown the runtime.");
<a href=#272 id=272 data-nosnippet>272</a>/// }).await;
<a href=#273 id=273 data-nosnippet>273</a>/// }
<a href=#274 id=274 data-nosnippet>274</a>/// # #[cfg(not(tokio_unstable))]
<a href=#275 id=275 data-nosnippet>275</a>/// # fn main() { }
<a href=#276 id=276 data-nosnippet>276</a>/// ```
<a href=#277 id=277 data-nosnippet>277</a>///
<a href=#278 id=278 data-nosnippet>278</a>/// Equivalent code not using `#[tokio::main]`
<a href=#279 id=279 data-nosnippet>279</a>///
<a href=#280 id=280 data-nosnippet>280</a>/// ```no_run
<a href=#281 id=281 data-nosnippet>281</a>/// #[cfg(tokio_unstable)]
<a href=#282 id=282 data-nosnippet>282</a>/// fn main() {
<a href=#283 id=283 data-nosnippet>283</a>/// tokio::runtime::Builder::new_current_thread()
<a href=#284 id=284 data-nosnippet>284</a>/// .enable_all()
<a href=#285 id=285 data-nosnippet>285</a>/// .unhandled_panic(tokio::runtime::UnhandledPanic::ShutdownRuntime)
<a href=#286 id=286 data-nosnippet>286</a>/// .build()
<a href=#287 id=287 data-nosnippet>287</a>/// .unwrap()
<a href=#288 id=288 data-nosnippet>288</a>/// .block_on(async {
<a href=#289 id=289 data-nosnippet>289</a>/// let _ = tokio::spawn(async {
<a href=#290 id=290 data-nosnippet>290</a>/// panic!("This panic will shutdown the runtime.");
<a href=#291 id=291 data-nosnippet>291</a>/// }).await;
<a href=#292 id=292 data-nosnippet>292</a>/// })
<a href=#293 id=293 data-nosnippet>293</a>/// }
<a href=#294 id=294 data-nosnippet>294</a>/// # #[cfg(not(tokio_unstable))]
<a href=#295 id=295 data-nosnippet>295</a>/// # fn main() { }
<a href=#296 id=296 data-nosnippet>296</a>/// ```
<a href=#297 id=297 data-nosnippet>297</a>///
<a href=#298 id=298 data-nosnippet>298</a>/// **Note**: This option depends on Tokio's [unstable API][unstable]. See [the
<a href=#299 id=299 data-nosnippet>299</a>/// documentation on unstable features][unstable] for details on how to enable
<a href=#300 id=300 data-nosnippet>300</a>/// Tokio's unstable features.
<a href=#301 id=301 data-nosnippet>301</a>///
<a href=#302 id=302 data-nosnippet>302</a>/// [`Builder::unhandled_panic`]: ../tokio/runtime/struct.Builder.html#method.unhandled_panic
<a href=#303 id=303 data-nosnippet>303</a>/// [unstable]: ../tokio/index.html#unstable-features
<a href=#304 id=304 data-nosnippet>304</a>/// [local runtime]: ../tokio/runtime/struct.LocalRuntime.html
<a href=#305 id=305 data-nosnippet>305</a></span><span class="attr">#[proc_macro_attribute]
<a href=#306 id=306 data-nosnippet>306</a></span><span class="kw">pub fn </span>main(args: TokenStream, item: TokenStream) -&gt; TokenStream {
<a href=#307 id=307 data-nosnippet>307</a> entry::main(args.into(), item.into(), <span class="bool-val">true</span>).into()
<a href=#308 id=308 data-nosnippet>308</a>}
<a href=#309 id=309 data-nosnippet>309</a>
<a href=#310 id=310 data-nosnippet>310</a><span class="doccomment">/// Marks async function to be executed by selected runtime. This macro helps set up a `Runtime`
<a href=#311 id=311 data-nosnippet>311</a>/// without requiring the user to use [Runtime](../tokio/runtime/struct.Runtime.html) or
<a href=#312 id=312 data-nosnippet>312</a>/// [Builder](../tokio/runtime/struct.Builder.html) directly.
<a href=#313 id=313 data-nosnippet>313</a>///
<a href=#314 id=314 data-nosnippet>314</a>/// ## Function arguments:
<a href=#315 id=315 data-nosnippet>315</a>///
<a href=#316 id=316 data-nosnippet>316</a>/// Arguments are allowed for any functions aside from `main` which is special
<a href=#317 id=317 data-nosnippet>317</a>///
<a href=#318 id=318 data-nosnippet>318</a>/// ## Usage
<a href=#319 id=319 data-nosnippet>319</a>///
<a href=#320 id=320 data-nosnippet>320</a>/// ### Using default
<a href=#321 id=321 data-nosnippet>321</a>///
<a href=#322 id=322 data-nosnippet>322</a>/// ```rust
<a href=#323 id=323 data-nosnippet>323</a>/// #[tokio::main(flavor = "current_thread")]
<a href=#324 id=324 data-nosnippet>324</a>/// async fn main() {
<a href=#325 id=325 data-nosnippet>325</a>/// println!("Hello world");
<a href=#326 id=326 data-nosnippet>326</a>/// }
<a href=#327 id=327 data-nosnippet>327</a>/// ```
<a href=#328 id=328 data-nosnippet>328</a>///
<a href=#329 id=329 data-nosnippet>329</a>/// Equivalent code not using `#[tokio::main]`
<a href=#330 id=330 data-nosnippet>330</a>///
<a href=#331 id=331 data-nosnippet>331</a>/// ```rust
<a href=#332 id=332 data-nosnippet>332</a>/// fn main() {
<a href=#333 id=333 data-nosnippet>333</a>/// tokio::runtime::Builder::new_current_thread()
<a href=#334 id=334 data-nosnippet>334</a>/// .enable_all()
<a href=#335 id=335 data-nosnippet>335</a>/// .build()
<a href=#336 id=336 data-nosnippet>336</a>/// .unwrap()
<a href=#337 id=337 data-nosnippet>337</a>/// .block_on(async {
<a href=#338 id=338 data-nosnippet>338</a>/// println!("Hello world");
<a href=#339 id=339 data-nosnippet>339</a>/// })
<a href=#340 id=340 data-nosnippet>340</a>/// }
<a href=#341 id=341 data-nosnippet>341</a>/// ```
<a href=#342 id=342 data-nosnippet>342</a>///
<a href=#343 id=343 data-nosnippet>343</a>/// ### Rename package
<a href=#344 id=344 data-nosnippet>344</a>///
<a href=#345 id=345 data-nosnippet>345</a>/// ```rust
<a href=#346 id=346 data-nosnippet>346</a>/// use tokio as tokio1;
<a href=#347 id=347 data-nosnippet>347</a>///
<a href=#348 id=348 data-nosnippet>348</a>/// #[tokio1::main(crate = "tokio1")]
<a href=#349 id=349 data-nosnippet>349</a>/// async fn main() {
<a href=#350 id=350 data-nosnippet>350</a>/// println!("Hello world");
<a href=#351 id=351 data-nosnippet>351</a>/// }
<a href=#352 id=352 data-nosnippet>352</a>/// ```
<a href=#353 id=353 data-nosnippet>353</a>///
<a href=#354 id=354 data-nosnippet>354</a>/// Equivalent code not using `#[tokio::main]`
<a href=#355 id=355 data-nosnippet>355</a>///
<a href=#356 id=356 data-nosnippet>356</a>/// ```rust
<a href=#357 id=357 data-nosnippet>357</a>/// use tokio as tokio1;
<a href=#358 id=358 data-nosnippet>358</a>///
<a href=#359 id=359 data-nosnippet>359</a>/// fn main() {
<a href=#360 id=360 data-nosnippet>360</a>/// tokio1::runtime::Builder::new_multi_thread()
<a href=#361 id=361 data-nosnippet>361</a>/// .enable_all()
<a href=#362 id=362 data-nosnippet>362</a>/// .build()
<a href=#363 id=363 data-nosnippet>363</a>/// .unwrap()
<a href=#364 id=364 data-nosnippet>364</a>/// .block_on(async {
<a href=#365 id=365 data-nosnippet>365</a>/// println!("Hello world");
<a href=#366 id=366 data-nosnippet>366</a>/// })
<a href=#367 id=367 data-nosnippet>367</a>/// }
<a href=#368 id=368 data-nosnippet>368</a>/// ```
<a href=#369 id=369 data-nosnippet>369</a></span><span class="attr">#[proc_macro_attribute]
<a href=#370 id=370 data-nosnippet>370</a></span><span class="kw">pub fn </span>main_rt(args: TokenStream, item: TokenStream) -&gt; TokenStream {
<a href=#371 id=371 data-nosnippet>371</a> entry::main(args.into(), item.into(), <span class="bool-val">false</span>).into()
<a href=#372 id=372 data-nosnippet>372</a>}
<a href=#373 id=373 data-nosnippet>373</a>
<a href=#374 id=374 data-nosnippet>374</a><span class="doccomment">/// Marks async function to be executed by runtime, suitable to test environment.
<a href=#375 id=375 data-nosnippet>375</a>/// This macro helps set up a `Runtime` without requiring the user to use
<a href=#376 id=376 data-nosnippet>376</a>/// [Runtime](../tokio/runtime/struct.Runtime.html) or
<a href=#377 id=377 data-nosnippet>377</a>/// [Builder](../tokio/runtime/struct.Builder.html) directly.
<a href=#378 id=378 data-nosnippet>378</a>///
<a href=#379 id=379 data-nosnippet>379</a>/// Note: This macro is designed to be simplistic and targets applications that
<a href=#380 id=380 data-nosnippet>380</a>/// do not require a complex setup. If the provided functionality is not
<a href=#381 id=381 data-nosnippet>381</a>/// sufficient, you may be interested in using
<a href=#382 id=382 data-nosnippet>382</a>/// [Builder](../tokio/runtime/struct.Builder.html), which provides a more
<a href=#383 id=383 data-nosnippet>383</a>/// powerful interface.
<a href=#384 id=384 data-nosnippet>384</a>///
<a href=#385 id=385 data-nosnippet>385</a>/// # Multi-threaded runtime
<a href=#386 id=386 data-nosnippet>386</a>///
<a href=#387 id=387 data-nosnippet>387</a>/// To use the multi-threaded runtime, the macro can be configured using
<a href=#388 id=388 data-nosnippet>388</a>///
<a href=#389 id=389 data-nosnippet>389</a>/// ```no_run
<a href=#390 id=390 data-nosnippet>390</a>/// #[tokio::test(flavor = "multi_thread", worker_threads = 1)]
<a href=#391 id=391 data-nosnippet>391</a>/// async fn my_test() {
<a href=#392 id=392 data-nosnippet>392</a>/// assert!(true);
<a href=#393 id=393 data-nosnippet>393</a>/// }
<a href=#394 id=394 data-nosnippet>394</a>/// ```
<a href=#395 id=395 data-nosnippet>395</a>///
<a href=#396 id=396 data-nosnippet>396</a>/// The `worker_threads` option configures the number of worker threads, and
<a href=#397 id=397 data-nosnippet>397</a>/// defaults to the number of cpus on the system.
<a href=#398 id=398 data-nosnippet>398</a>///
<a href=#399 id=399 data-nosnippet>399</a>/// Note: The multi-threaded runtime requires the `rt-multi-thread` feature
<a href=#400 id=400 data-nosnippet>400</a>/// flag.
<a href=#401 id=401 data-nosnippet>401</a>///
<a href=#402 id=402 data-nosnippet>402</a>/// # Current thread runtime
<a href=#403 id=403 data-nosnippet>403</a>///
<a href=#404 id=404 data-nosnippet>404</a>/// The default test runtime is single-threaded. Each test gets a
<a href=#405 id=405 data-nosnippet>405</a>/// separate current-thread runtime.
<a href=#406 id=406 data-nosnippet>406</a>///
<a href=#407 id=407 data-nosnippet>407</a>/// ```no_run
<a href=#408 id=408 data-nosnippet>408</a>/// #[tokio::test]
<a href=#409 id=409 data-nosnippet>409</a>/// async fn my_test() {
<a href=#410 id=410 data-nosnippet>410</a>/// assert!(true);
<a href=#411 id=411 data-nosnippet>411</a>/// }
<a href=#412 id=412 data-nosnippet>412</a>/// ```
<a href=#413 id=413 data-nosnippet>413</a>///
<a href=#414 id=414 data-nosnippet>414</a>/// ## Usage
<a href=#415 id=415 data-nosnippet>415</a>///
<a href=#416 id=416 data-nosnippet>416</a>/// ### Using the multi-thread runtime
<a href=#417 id=417 data-nosnippet>417</a>///
<a href=#418 id=418 data-nosnippet>418</a>/// ```no_run
<a href=#419 id=419 data-nosnippet>419</a>/// #[tokio::test(flavor = "multi_thread")]
<a href=#420 id=420 data-nosnippet>420</a>/// async fn my_test() {
<a href=#421 id=421 data-nosnippet>421</a>/// assert!(true);
<a href=#422 id=422 data-nosnippet>422</a>/// }
<a href=#423 id=423 data-nosnippet>423</a>/// ```
<a href=#424 id=424 data-nosnippet>424</a>///
<a href=#425 id=425 data-nosnippet>425</a>/// Equivalent code not using `#[tokio::test]`
<a href=#426 id=426 data-nosnippet>426</a>///
<a href=#427 id=427 data-nosnippet>427</a>/// ```no_run
<a href=#428 id=428 data-nosnippet>428</a>/// #[test]
<a href=#429 id=429 data-nosnippet>429</a>/// fn my_test() {
<a href=#430 id=430 data-nosnippet>430</a>/// tokio::runtime::Builder::new_multi_thread()
<a href=#431 id=431 data-nosnippet>431</a>/// .enable_all()
<a href=#432 id=432 data-nosnippet>432</a>/// .build()
<a href=#433 id=433 data-nosnippet>433</a>/// .unwrap()
<a href=#434 id=434 data-nosnippet>434</a>/// .block_on(async {
<a href=#435 id=435 data-nosnippet>435</a>/// assert!(true);
<a href=#436 id=436 data-nosnippet>436</a>/// })
<a href=#437 id=437 data-nosnippet>437</a>/// }
<a href=#438 id=438 data-nosnippet>438</a>/// ```
<a href=#439 id=439 data-nosnippet>439</a>///
<a href=#440 id=440 data-nosnippet>440</a>/// ### Using current thread runtime
<a href=#441 id=441 data-nosnippet>441</a>///
<a href=#442 id=442 data-nosnippet>442</a>/// ```no_run
<a href=#443 id=443 data-nosnippet>443</a>/// #[tokio::test]
<a href=#444 id=444 data-nosnippet>444</a>/// async fn my_test() {
<a href=#445 id=445 data-nosnippet>445</a>/// assert!(true);
<a href=#446 id=446 data-nosnippet>446</a>/// }
<a href=#447 id=447 data-nosnippet>447</a>/// ```
<a href=#448 id=448 data-nosnippet>448</a>///
<a href=#449 id=449 data-nosnippet>449</a>/// Equivalent code not using `#[tokio::test]`
<a href=#450 id=450 data-nosnippet>450</a>///
<a href=#451 id=451 data-nosnippet>451</a>/// ```no_run
<a href=#452 id=452 data-nosnippet>452</a>/// #[test]
<a href=#453 id=453 data-nosnippet>453</a>/// fn my_test() {
<a href=#454 id=454 data-nosnippet>454</a>/// tokio::runtime::Builder::new_current_thread()
<a href=#455 id=455 data-nosnippet>455</a>/// .enable_all()
<a href=#456 id=456 data-nosnippet>456</a>/// .build()
<a href=#457 id=457 data-nosnippet>457</a>/// .unwrap()
<a href=#458 id=458 data-nosnippet>458</a>/// .block_on(async {
<a href=#459 id=459 data-nosnippet>459</a>/// assert!(true);
<a href=#460 id=460 data-nosnippet>460</a>/// })
<a href=#461 id=461 data-nosnippet>461</a>/// }
<a href=#462 id=462 data-nosnippet>462</a>/// ```
<a href=#463 id=463 data-nosnippet>463</a>///
<a href=#464 id=464 data-nosnippet>464</a>/// ### Set number of worker threads
<a href=#465 id=465 data-nosnippet>465</a>///
<a href=#466 id=466 data-nosnippet>466</a>/// ```no_run
<a href=#467 id=467 data-nosnippet>467</a>/// #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
<a href=#468 id=468 data-nosnippet>468</a>/// async fn my_test() {
<a href=#469 id=469 data-nosnippet>469</a>/// assert!(true);
<a href=#470 id=470 data-nosnippet>470</a>/// }
<a href=#471 id=471 data-nosnippet>471</a>/// ```
<a href=#472 id=472 data-nosnippet>472</a>///
<a href=#473 id=473 data-nosnippet>473</a>/// Equivalent code not using `#[tokio::test]`
<a href=#474 id=474 data-nosnippet>474</a>///
<a href=#475 id=475 data-nosnippet>475</a>/// ```no_run
<a href=#476 id=476 data-nosnippet>476</a>/// #[test]
<a href=#477 id=477 data-nosnippet>477</a>/// fn my_test() {
<a href=#478 id=478 data-nosnippet>478</a>/// tokio::runtime::Builder::new_multi_thread()
<a href=#479 id=479 data-nosnippet>479</a>/// .worker_threads(2)
<a href=#480 id=480 data-nosnippet>480</a>/// .enable_all()
<a href=#481 id=481 data-nosnippet>481</a>/// .build()
<a href=#482 id=482 data-nosnippet>482</a>/// .unwrap()
<a href=#483 id=483 data-nosnippet>483</a>/// .block_on(async {
<a href=#484 id=484 data-nosnippet>484</a>/// assert!(true);
<a href=#485 id=485 data-nosnippet>485</a>/// })
<a href=#486 id=486 data-nosnippet>486</a>/// }
<a href=#487 id=487 data-nosnippet>487</a>/// ```
<a href=#488 id=488 data-nosnippet>488</a>///
<a href=#489 id=489 data-nosnippet>489</a>/// ### Configure the runtime to start with time paused
<a href=#490 id=490 data-nosnippet>490</a>///
<a href=#491 id=491 data-nosnippet>491</a>/// ```no_run
<a href=#492 id=492 data-nosnippet>492</a>/// #[tokio::test(start_paused = true)]
<a href=#493 id=493 data-nosnippet>493</a>/// async fn my_test() {
<a href=#494 id=494 data-nosnippet>494</a>/// assert!(true);
<a href=#495 id=495 data-nosnippet>495</a>/// }
<a href=#496 id=496 data-nosnippet>496</a>/// ```
<a href=#497 id=497 data-nosnippet>497</a>///
<a href=#498 id=498 data-nosnippet>498</a>/// Equivalent code not using `#[tokio::test]`
<a href=#499 id=499 data-nosnippet>499</a>///
<a href=#500 id=500 data-nosnippet>500</a>/// ```no_run
<a href=#501 id=501 data-nosnippet>501</a>/// #[test]
<a href=#502 id=502 data-nosnippet>502</a>/// fn my_test() {
<a href=#503 id=503 data-nosnippet>503</a>/// tokio::runtime::Builder::new_current_thread()
<a href=#504 id=504 data-nosnippet>504</a>/// .enable_all()
<a href=#505 id=505 data-nosnippet>505</a>/// .start_paused(true)
<a href=#506 id=506 data-nosnippet>506</a>/// .build()
<a href=#507 id=507 data-nosnippet>507</a>/// .unwrap()
<a href=#508 id=508 data-nosnippet>508</a>/// .block_on(async {
<a href=#509 id=509 data-nosnippet>509</a>/// assert!(true);
<a href=#510 id=510 data-nosnippet>510</a>/// })
<a href=#511 id=511 data-nosnippet>511</a>/// }
<a href=#512 id=512 data-nosnippet>512</a>/// ```
<a href=#513 id=513 data-nosnippet>513</a>///
<a href=#514 id=514 data-nosnippet>514</a>/// Note that `start_paused` requires the `test-util` feature to be enabled.
<a href=#515 id=515 data-nosnippet>515</a>///
<a href=#516 id=516 data-nosnippet>516</a>/// ### Rename package
<a href=#517 id=517 data-nosnippet>517</a>///
<a href=#518 id=518 data-nosnippet>518</a>/// ```rust
<a href=#519 id=519 data-nosnippet>519</a>/// use tokio as tokio1;
<a href=#520 id=520 data-nosnippet>520</a>///
<a href=#521 id=521 data-nosnippet>521</a>/// #[tokio1::test(crate = "tokio1")]
<a href=#522 id=522 data-nosnippet>522</a>/// async fn my_test() {
<a href=#523 id=523 data-nosnippet>523</a>/// println!("Hello world");
<a href=#524 id=524 data-nosnippet>524</a>/// }
<a href=#525 id=525 data-nosnippet>525</a>/// ```
<a href=#526 id=526 data-nosnippet>526</a>///
<a href=#527 id=527 data-nosnippet>527</a>/// ### Configure unhandled panic behavior
<a href=#528 id=528 data-nosnippet>528</a>///
<a href=#529 id=529 data-nosnippet>529</a>/// Available options are `shutdown_runtime` and `ignore`. For more details, see
<a href=#530 id=530 data-nosnippet>530</a>/// [`Builder::unhandled_panic`].
<a href=#531 id=531 data-nosnippet>531</a>///
<a href=#532 id=532 data-nosnippet>532</a>/// This option is only compatible with the `current_thread` runtime.
<a href=#533 id=533 data-nosnippet>533</a>///
<a href=#534 id=534 data-nosnippet>534</a>/// ```no_run
<a href=#535 id=535 data-nosnippet>535</a>/// #[cfg(tokio_unstable)]
<a href=#536 id=536 data-nosnippet>536</a>/// #[tokio::test(flavor = "current_thread", unhandled_panic = "shutdown_runtime")]
<a href=#537 id=537 data-nosnippet>537</a>/// async fn my_test() {
<a href=#538 id=538 data-nosnippet>538</a>/// let _ = tokio::spawn(async {
<a href=#539 id=539 data-nosnippet>539</a>/// panic!("This panic will shutdown the runtime.");
<a href=#540 id=540 data-nosnippet>540</a>/// }).await;
<a href=#541 id=541 data-nosnippet>541</a>/// }
<a href=#542 id=542 data-nosnippet>542</a>///
<a href=#543 id=543 data-nosnippet>543</a>/// # fn main() { }
<a href=#544 id=544 data-nosnippet>544</a>/// ```
<a href=#545 id=545 data-nosnippet>545</a>///
<a href=#546 id=546 data-nosnippet>546</a>/// Equivalent code not using `#[tokio::test]`
<a href=#547 id=547 data-nosnippet>547</a>///
<a href=#548 id=548 data-nosnippet>548</a>/// ```no_run
<a href=#549 id=549 data-nosnippet>549</a>/// #[cfg(tokio_unstable)]
<a href=#550 id=550 data-nosnippet>550</a>/// #[test]
<a href=#551 id=551 data-nosnippet>551</a>/// fn my_test() {
<a href=#552 id=552 data-nosnippet>552</a>/// tokio::runtime::Builder::new_current_thread()
<a href=#553 id=553 data-nosnippet>553</a>/// .enable_all()
<a href=#554 id=554 data-nosnippet>554</a>/// .unhandled_panic(UnhandledPanic::ShutdownRuntime)
<a href=#555 id=555 data-nosnippet>555</a>/// .build()
<a href=#556 id=556 data-nosnippet>556</a>/// .unwrap()
<a href=#557 id=557 data-nosnippet>557</a>/// .block_on(async {
<a href=#558 id=558 data-nosnippet>558</a>/// let _ = tokio::spawn(async {
<a href=#559 id=559 data-nosnippet>559</a>/// panic!("This panic will shutdown the runtime.");
<a href=#560 id=560 data-nosnippet>560</a>/// }).await;
<a href=#561 id=561 data-nosnippet>561</a>/// })
<a href=#562 id=562 data-nosnippet>562</a>/// }
<a href=#563 id=563 data-nosnippet>563</a>///
<a href=#564 id=564 data-nosnippet>564</a>/// # fn main() { }
<a href=#565 id=565 data-nosnippet>565</a>/// ```
<a href=#566 id=566 data-nosnippet>566</a>///
<a href=#567 id=567 data-nosnippet>567</a>/// **Note**: This option depends on Tokio's [unstable API][unstable]. See [the
<a href=#568 id=568 data-nosnippet>568</a>/// documentation on unstable features][unstable] for details on how to enable
<a href=#569 id=569 data-nosnippet>569</a>/// Tokio's unstable features.
<a href=#570 id=570 data-nosnippet>570</a>///
<a href=#571 id=571 data-nosnippet>571</a>/// [`Builder::unhandled_panic`]: ../tokio/runtime/struct.Builder.html#method.unhandled_panic
<a href=#572 id=572 data-nosnippet>572</a>/// [unstable]: ../tokio/index.html#unstable-features
<a href=#573 id=573 data-nosnippet>573</a></span><span class="attr">#[proc_macro_attribute]
<a href=#574 id=574 data-nosnippet>574</a></span><span class="kw">pub fn </span>test(args: TokenStream, item: TokenStream) -&gt; TokenStream {
<a href=#575 id=575 data-nosnippet>575</a> entry::test(args.into(), item.into(), <span class="bool-val">true</span>).into()
<a href=#576 id=576 data-nosnippet>576</a>}
<a href=#577 id=577 data-nosnippet>577</a>
<a href=#578 id=578 data-nosnippet>578</a><span class="doccomment">/// Marks async function to be executed by runtime, suitable to test environment
<a href=#579 id=579 data-nosnippet>579</a>///
<a href=#580 id=580 data-nosnippet>580</a>/// ## Usage
<a href=#581 id=581 data-nosnippet>581</a>///
<a href=#582 id=582 data-nosnippet>582</a>/// ```no_run
<a href=#583 id=583 data-nosnippet>583</a>/// #[tokio::test]
<a href=#584 id=584 data-nosnippet>584</a>/// async fn my_test() {
<a href=#585 id=585 data-nosnippet>585</a>/// assert!(true);
<a href=#586 id=586 data-nosnippet>586</a>/// }
<a href=#587 id=587 data-nosnippet>587</a>/// ```
<a href=#588 id=588 data-nosnippet>588</a></span><span class="attr">#[proc_macro_attribute]
<a href=#589 id=589 data-nosnippet>589</a></span><span class="kw">pub fn </span>test_rt(args: TokenStream, item: TokenStream) -&gt; TokenStream {
<a href=#590 id=590 data-nosnippet>590</a> entry::test(args.into(), item.into(), <span class="bool-val">false</span>).into()
<a href=#591 id=591 data-nosnippet>591</a>}
<a href=#592 id=592 data-nosnippet>592</a>
<a href=#593 id=593 data-nosnippet>593</a><span class="doccomment">/// Always fails with the error message below.
<a href=#594 id=594 data-nosnippet>594</a>/// ```text
<a href=#595 id=595 data-nosnippet>595</a>/// The #[tokio::main] macro requires rt or rt-multi-thread.
<a href=#596 id=596 data-nosnippet>596</a>/// ```
<a href=#597 id=597 data-nosnippet>597</a></span><span class="attr">#[proc_macro_attribute]
<a href=#598 id=598 data-nosnippet>598</a></span><span class="kw">pub fn </span>main_fail(_args: TokenStream, _item: TokenStream) -&gt; TokenStream {
<a href=#599 id=599 data-nosnippet>599</a> syn::Error::new(
<a href=#600 id=600 data-nosnippet>600</a> proc_macro2::Span::call_site(),
<a href=#601 id=601 data-nosnippet>601</a> <span class="string">"The #[tokio::main] macro requires rt or rt-multi-thread."</span>,
<a href=#602 id=602 data-nosnippet>602</a> )
<a href=#603 id=603 data-nosnippet>603</a> .to_compile_error()
<a href=#604 id=604 data-nosnippet>604</a> .into()
<a href=#605 id=605 data-nosnippet>605</a>}
<a href=#606 id=606 data-nosnippet>606</a>
<a href=#607 id=607 data-nosnippet>607</a><span class="doccomment">/// Always fails with the error message below.
<a href=#608 id=608 data-nosnippet>608</a>/// ```text
<a href=#609 id=609 data-nosnippet>609</a>/// The #[tokio::test] macro requires rt or rt-multi-thread.
<a href=#610 id=610 data-nosnippet>610</a>/// ```
<a href=#611 id=611 data-nosnippet>611</a></span><span class="attr">#[proc_macro_attribute]
<a href=#612 id=612 data-nosnippet>612</a></span><span class="kw">pub fn </span>test_fail(_args: TokenStream, _item: TokenStream) -&gt; TokenStream {
<a href=#613 id=613 data-nosnippet>613</a> syn::Error::new(
<a href=#614 id=614 data-nosnippet>614</a> proc_macro2::Span::call_site(),
<a href=#615 id=615 data-nosnippet>615</a> <span class="string">"The #[tokio::test] macro requires rt or rt-multi-thread."</span>,
<a href=#616 id=616 data-nosnippet>616</a> )
<a href=#617 id=617 data-nosnippet>617</a> .to_compile_error()
<a href=#618 id=618 data-nosnippet>618</a> .into()
<a href=#619 id=619 data-nosnippet>619</a>}
<a href=#620 id=620 data-nosnippet>620</a>
<a href=#621 id=621 data-nosnippet>621</a><span class="doccomment">/// Implementation detail of the `select!` macro. This macro is **not** intended
<a href=#622 id=622 data-nosnippet>622</a>/// to be used as part of the public API and is permitted to change.
<a href=#623 id=623 data-nosnippet>623</a></span><span class="attr">#[proc_macro]
<a href=#624 id=624 data-nosnippet>624</a>#[doc(hidden)]
<a href=#625 id=625 data-nosnippet>625</a></span><span class="kw">pub fn </span>select_priv_declare_output_enum(input: TokenStream) -&gt; TokenStream {
<a href=#626 id=626 data-nosnippet>626</a> select::declare_output_enum(input)
<a href=#627 id=627 data-nosnippet>627</a>}
<a href=#628 id=628 data-nosnippet>628</a>
<a href=#629 id=629 data-nosnippet>629</a><span class="doccomment">/// Implementation detail of the `select!` macro. This macro is **not** intended
<a href=#630 id=630 data-nosnippet>630</a>/// to be used as part of the public API and is permitted to change.
<a href=#631 id=631 data-nosnippet>631</a></span><span class="attr">#[proc_macro]
<a href=#632 id=632 data-nosnippet>632</a>#[doc(hidden)]
<a href=#633 id=633 data-nosnippet>633</a></span><span class="kw">pub fn </span>select_priv_clean_pattern(input: TokenStream) -&gt; TokenStream {
<a href=#634 id=634 data-nosnippet>634</a> select::clean_pattern_macro(input)
<a href=#635 id=635 data-nosnippet>635</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,110 @@
<!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="Source of the Rust file `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/tokio-macros-2.6.0/src/select.rs`."><title>select.rs - source</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_macros" 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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[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="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">tokio_macros/</div>select.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>proc_macro::{TokenStream, TokenTree};
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>proc_macro2::Span;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>quote::quote;
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>syn::{parse::Parser, Ident};
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>declare_output_enum(input: TokenStream) -&gt; TokenStream {
<a href=#7 id=7 data-nosnippet>7</a> <span class="comment">// passed in is: `(_ _ _)` with one `_` per branch
<a href=#8 id=8 data-nosnippet>8</a> </span><span class="kw">let </span>branches = <span class="kw">match </span>input.into_iter().next() {
<a href=#9 id=9 data-nosnippet>9</a> <span class="prelude-val">Some</span>(TokenTree::Group(group)) =&gt; group.stream().into_iter().count(),
<a href=#10 id=10 data-nosnippet>10</a> <span class="kw">_ </span>=&gt; <span class="macro">panic!</span>(<span class="string">"unexpected macro input"</span>),
<a href=#11 id=11 data-nosnippet>11</a> };
<a href=#12 id=12 data-nosnippet>12</a>
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">let </span>variants = (<span class="number">0</span>..branches)
<a href=#14 id=14 data-nosnippet>14</a> .map(|num| Ident::new(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">"_{num}"</span>), Span::call_site()))
<a href=#15 id=15 data-nosnippet>15</a> .collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;();
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a> <span class="comment">// Use a bitfield to track which futures completed
<a href=#18 id=18 data-nosnippet>18</a> </span><span class="kw">let </span>mask = Ident::new(
<a href=#19 id=19 data-nosnippet>19</a> <span class="kw">if </span>branches &lt;= <span class="number">8 </span>{
<a href=#20 id=20 data-nosnippet>20</a> <span class="string">"u8"
<a href=#21 id=21 data-nosnippet>21</a> </span>} <span class="kw">else if </span>branches &lt;= <span class="number">16 </span>{
<a href=#22 id=22 data-nosnippet>22</a> <span class="string">"u16"
<a href=#23 id=23 data-nosnippet>23</a> </span>} <span class="kw">else if </span>branches &lt;= <span class="number">32 </span>{
<a href=#24 id=24 data-nosnippet>24</a> <span class="string">"u32"
<a href=#25 id=25 data-nosnippet>25</a> </span>} <span class="kw">else if </span>branches &lt;= <span class="number">64 </span>{
<a href=#26 id=26 data-nosnippet>26</a> <span class="string">"u64"
<a href=#27 id=27 data-nosnippet>27</a> </span>} <span class="kw">else </span>{
<a href=#28 id=28 data-nosnippet>28</a> <span class="macro">panic!</span>(<span class="string">"up to 64 branches supported"</span>);
<a href=#29 id=29 data-nosnippet>29</a> },
<a href=#30 id=30 data-nosnippet>30</a> Span::call_site(),
<a href=#31 id=31 data-nosnippet>31</a> );
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a> TokenStream::from(<span class="macro">quote!</span> {
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">enum </span>Out&lt;#( #variants ),<span class="kw-2">*</span>&gt; {
<a href=#35 id=35 data-nosnippet>35</a> #( #variants(#variants), )*
<a href=#36 id=36 data-nosnippet>36</a> <span class="comment">// Include a `Disabled` variant signifying that all select branches
<a href=#37 id=37 data-nosnippet>37</a> // failed to resolve.
<a href=#38 id=38 data-nosnippet>38</a> </span>Disabled,
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a> <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">type </span>Mask = #mask;
<a href=#42 id=42 data-nosnippet>42</a> })
<a href=#43 id=43 data-nosnippet>43</a>}
<a href=#44 id=44 data-nosnippet>44</a>
<a href=#45 id=45 data-nosnippet>45</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>clean_pattern_macro(input: TokenStream) -&gt; TokenStream {
<a href=#46 id=46 data-nosnippet>46</a> <span class="comment">// If this isn't a pattern, we return the token stream as-is. The select!
<a href=#47 id=47 data-nosnippet>47</a> // macro is using it in a location requiring a pattern, so an error will be
<a href=#48 id=48 data-nosnippet>48</a> // emitted there.
<a href=#49 id=49 data-nosnippet>49</a> </span><span class="kw">let </span><span class="kw-2">mut </span>input: syn::Pat = <span class="kw">match </span>syn::Pat::parse_single.parse(input.clone()) {
<a href=#50 id=50 data-nosnippet>50</a> <span class="prelude-val">Ok</span>(it) =&gt; it,
<a href=#51 id=51 data-nosnippet>51</a> <span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; <span class="kw">return </span>input,
<a href=#52 id=52 data-nosnippet>52</a> };
<a href=#53 id=53 data-nosnippet>53</a>
<a href=#54 id=54 data-nosnippet>54</a> clean_pattern(<span class="kw-2">&amp;mut </span>input);
<a href=#55 id=55 data-nosnippet>55</a> quote::ToTokens::into_token_stream(input).into()
<a href=#56 id=56 data-nosnippet>56</a>}
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a><span class="comment">// Removes any occurrences of ref or mut in the provided pattern.
<a href=#59 id=59 data-nosnippet>59</a></span><span class="kw">fn </span>clean_pattern(pat: <span class="kw-2">&amp;mut </span>syn::Pat) {
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">match </span>pat {
<a href=#61 id=61 data-nosnippet>61</a> syn::Pat::Lit(_literal) =&gt; {}
<a href=#62 id=62 data-nosnippet>62</a> syn::Pat::Macro(_macro) =&gt; {}
<a href=#63 id=63 data-nosnippet>63</a> syn::Pat::Path(_path) =&gt; {}
<a href=#64 id=64 data-nosnippet>64</a> syn::Pat::Range(_range) =&gt; {}
<a href=#65 id=65 data-nosnippet>65</a> syn::Pat::Rest(_rest) =&gt; {}
<a href=#66 id=66 data-nosnippet>66</a> syn::Pat::Verbatim(_tokens) =&gt; {}
<a href=#67 id=67 data-nosnippet>67</a> syn::Pat::Wild(_underscore) =&gt; {}
<a href=#68 id=68 data-nosnippet>68</a> syn::Pat::Ident(ident) =&gt; {
<a href=#69 id=69 data-nosnippet>69</a> ident.by_ref = <span class="prelude-val">None</span>;
<a href=#70 id=70 data-nosnippet>70</a> ident.mutability = <span class="prelude-val">None</span>;
<a href=#71 id=71 data-nosnippet>71</a> <span class="kw">if let </span><span class="prelude-val">Some</span>((_at, pat)) = <span class="kw-2">&amp;mut </span>ident.subpat {
<a href=#72 id=72 data-nosnippet>72</a> clean_pattern(<span class="kw-2">&amp;mut *</span>pat);
<a href=#73 id=73 data-nosnippet>73</a> }
<a href=#74 id=74 data-nosnippet>74</a> }
<a href=#75 id=75 data-nosnippet>75</a> syn::Pat::Or(or) =&gt; {
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">for </span>case <span class="kw">in </span><span class="kw-2">&amp;mut </span>or.cases {
<a href=#77 id=77 data-nosnippet>77</a> clean_pattern(case);
<a href=#78 id=78 data-nosnippet>78</a> }
<a href=#79 id=79 data-nosnippet>79</a> }
<a href=#80 id=80 data-nosnippet>80</a> syn::Pat::Slice(slice) =&gt; {
<a href=#81 id=81 data-nosnippet>81</a> <span class="kw">for </span>elem <span class="kw">in </span><span class="kw-2">&amp;mut </span>slice.elems {
<a href=#82 id=82 data-nosnippet>82</a> clean_pattern(elem);
<a href=#83 id=83 data-nosnippet>83</a> }
<a href=#84 id=84 data-nosnippet>84</a> }
<a href=#85 id=85 data-nosnippet>85</a> syn::Pat::Struct(struct_pat) =&gt; {
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">for </span>field <span class="kw">in </span><span class="kw-2">&amp;mut </span>struct_pat.fields {
<a href=#87 id=87 data-nosnippet>87</a> clean_pattern(<span class="kw-2">&amp;mut </span>field.pat);
<a href=#88 id=88 data-nosnippet>88</a> }
<a href=#89 id=89 data-nosnippet>89</a> }
<a href=#90 id=90 data-nosnippet>90</a> syn::Pat::Tuple(tuple) =&gt; {
<a href=#91 id=91 data-nosnippet>91</a> <span class="kw">for </span>elem <span class="kw">in </span><span class="kw-2">&amp;mut </span>tuple.elems {
<a href=#92 id=92 data-nosnippet>92</a> clean_pattern(elem);
<a href=#93 id=93 data-nosnippet>93</a> }
<a href=#94 id=94 data-nosnippet>94</a> }
<a href=#95 id=95 data-nosnippet>95</a> syn::Pat::TupleStruct(tuple) =&gt; {
<a href=#96 id=96 data-nosnippet>96</a> <span class="kw">for </span>elem <span class="kw">in </span><span class="kw-2">&amp;mut </span>tuple.elems {
<a href=#97 id=97 data-nosnippet>97</a> clean_pattern(elem);
<a href=#98 id=98 data-nosnippet>98</a> }
<a href=#99 id=99 data-nosnippet>99</a> }
<a href=#100 id=100 data-nosnippet>100</a> syn::Pat::Reference(reference) =&gt; {
<a href=#101 id=101 data-nosnippet>101</a> reference.mutability = <span class="prelude-val">None</span>;
<a href=#102 id=102 data-nosnippet>102</a> clean_pattern(<span class="kw-2">&amp;mut </span>reference.pat);
<a href=#103 id=103 data-nosnippet>103</a> }
<a href=#104 id=104 data-nosnippet>104</a> syn::Pat::Type(type_pat) =&gt; {
<a href=#105 id=105 data-nosnippet>105</a> clean_pattern(<span class="kw-2">&amp;mut </span>type_pat.pat);
<a href=#106 id=106 data-nosnippet>106</a> }
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">_ </span>=&gt; {}
<a href=#108 id=108 data-nosnippet>108</a> }
<a href=#109 id=109 data-nosnippet>109</a>}
</code></pre></div></section></main></body></html>