blob: 46b544578792724b6363b4c3dd39c9619697b4c3 [file] [log] [blame]
<!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/fail-0.5.1/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../fail/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../fail/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</span>
<span id="601">601</span>
<span id="602">602</span>
<span id="603">603</span>
<span id="604">604</span>
<span id="605">605</span>
<span id="606">606</span>
<span id="607">607</span>
<span id="608">608</span>
<span id="609">609</span>
<span id="610">610</span>
<span id="611">611</span>
<span id="612">612</span>
<span id="613">613</span>
<span id="614">614</span>
<span id="615">615</span>
<span id="616">616</span>
<span id="617">617</span>
<span id="618">618</span>
<span id="619">619</span>
<span id="620">620</span>
<span id="621">621</span>
<span id="622">622</span>
<span id="623">623</span>
<span id="624">624</span>
<span id="625">625</span>
<span id="626">626</span>
<span id="627">627</span>
<span id="628">628</span>
<span id="629">629</span>
<span id="630">630</span>
<span id="631">631</span>
<span id="632">632</span>
<span id="633">633</span>
<span id="634">634</span>
<span id="635">635</span>
<span id="636">636</span>
<span id="637">637</span>
<span id="638">638</span>
<span id="639">639</span>
<span id="640">640</span>
<span id="641">641</span>
<span id="642">642</span>
<span id="643">643</span>
<span id="644">644</span>
<span id="645">645</span>
<span id="646">646</span>
<span id="647">647</span>
<span id="648">648</span>
<span id="649">649</span>
<span id="650">650</span>
<span id="651">651</span>
<span id="652">652</span>
<span id="653">653</span>
<span id="654">654</span>
<span id="655">655</span>
<span id="656">656</span>
<span id="657">657</span>
<span id="658">658</span>
<span id="659">659</span>
<span id="660">660</span>
<span id="661">661</span>
<span id="662">662</span>
<span id="663">663</span>
<span id="664">664</span>
<span id="665">665</span>
<span id="666">666</span>
<span id="667">667</span>
<span id="668">668</span>
<span id="669">669</span>
<span id="670">670</span>
<span id="671">671</span>
<span id="672">672</span>
<span id="673">673</span>
<span id="674">674</span>
<span id="675">675</span>
<span id="676">676</span>
<span id="677">677</span>
<span id="678">678</span>
<span id="679">679</span>
<span id="680">680</span>
<span id="681">681</span>
<span id="682">682</span>
<span id="683">683</span>
<span id="684">684</span>
<span id="685">685</span>
<span id="686">686</span>
<span id="687">687</span>
<span id="688">688</span>
<span id="689">689</span>
<span id="690">690</span>
<span id="691">691</span>
<span id="692">692</span>
<span id="693">693</span>
<span id="694">694</span>
<span id="695">695</span>
<span id="696">696</span>
<span id="697">697</span>
<span id="698">698</span>
<span id="699">699</span>
<span id="700">700</span>
<span id="701">701</span>
<span id="702">702</span>
<span id="703">703</span>
<span id="704">704</span>
<span id="705">705</span>
<span id="706">706</span>
<span id="707">707</span>
<span id="708">708</span>
<span id="709">709</span>
<span id="710">710</span>
<span id="711">711</span>
<span id="712">712</span>
<span id="713">713</span>
<span id="714">714</span>
<span id="715">715</span>
<span id="716">716</span>
<span id="717">717</span>
<span id="718">718</span>
<span id="719">719</span>
<span id="720">720</span>
<span id="721">721</span>
<span id="722">722</span>
<span id="723">723</span>
<span id="724">724</span>
<span id="725">725</span>
<span id="726">726</span>
<span id="727">727</span>
<span id="728">728</span>
<span id="729">729</span>
<span id="730">730</span>
<span id="731">731</span>
<span id="732">732</span>
<span id="733">733</span>
<span id="734">734</span>
<span id="735">735</span>
<span id="736">736</span>
<span id="737">737</span>
<span id="738">738</span>
<span id="739">739</span>
<span id="740">740</span>
<span id="741">741</span>
<span id="742">742</span>
<span id="743">743</span>
<span id="744">744</span>
<span id="745">745</span>
<span id="746">746</span>
<span id="747">747</span>
<span id="748">748</span>
<span id="749">749</span>
<span id="750">750</span>
<span id="751">751</span>
<span id="752">752</span>
<span id="753">753</span>
<span id="754">754</span>
<span id="755">755</span>
<span id="756">756</span>
<span id="757">757</span>
<span id="758">758</span>
<span id="759">759</span>
<span id="760">760</span>
<span id="761">761</span>
<span id="762">762</span>
<span id="763">763</span>
<span id="764">764</span>
<span id="765">765</span>
<span id="766">766</span>
<span id="767">767</span>
<span id="768">768</span>
<span id="769">769</span>
<span id="770">770</span>
<span id="771">771</span>
<span id="772">772</span>
<span id="773">773</span>
<span id="774">774</span>
<span id="775">775</span>
<span id="776">776</span>
<span id="777">777</span>
<span id="778">778</span>
<span id="779">779</span>
<span id="780">780</span>
<span id="781">781</span>
<span id="782">782</span>
<span id="783">783</span>
<span id="784">784</span>
<span id="785">785</span>
<span id="786">786</span>
<span id="787">787</span>
<span id="788">788</span>
<span id="789">789</span>
<span id="790">790</span>
<span id="791">791</span>
<span id="792">792</span>
<span id="793">793</span>
<span id="794">794</span>
<span id="795">795</span>
<span id="796">796</span>
<span id="797">797</span>
<span id="798">798</span>
<span id="799">799</span>
<span id="800">800</span>
<span id="801">801</span>
<span id="802">802</span>
<span id="803">803</span>
<span id="804">804</span>
<span id="805">805</span>
<span id="806">806</span>
<span id="807">807</span>
<span id="808">808</span>
<span id="809">809</span>
<span id="810">810</span>
<span id="811">811</span>
<span id="812">812</span>
<span id="813">813</span>
<span id="814">814</span>
<span id="815">815</span>
<span id="816">816</span>
<span id="817">817</span>
<span id="818">818</span>
<span id="819">819</span>
<span id="820">820</span>
<span id="821">821</span>
<span id="822">822</span>
<span id="823">823</span>
<span id="824">824</span>
<span id="825">825</span>
<span id="826">826</span>
<span id="827">827</span>
<span id="828">828</span>
<span id="829">829</span>
<span id="830">830</span>
<span id="831">831</span>
<span id="832">832</span>
<span id="833">833</span>
<span id="834">834</span>
<span id="835">835</span>
<span id="836">836</span>
<span id="837">837</span>
<span id="838">838</span>
<span id="839">839</span>
<span id="840">840</span>
<span id="841">841</span>
<span id="842">842</span>
<span id="843">843</span>
<span id="844">844</span>
<span id="845">845</span>
<span id="846">846</span>
<span id="847">847</span>
<span id="848">848</span>
<span id="849">849</span>
<span id="850">850</span>
<span id="851">851</span>
<span id="852">852</span>
<span id="853">853</span>
<span id="854">854</span>
<span id="855">855</span>
<span id="856">856</span>
<span id="857">857</span>
<span id="858">858</span>
<span id="859">859</span>
<span id="860">860</span>
<span id="861">861</span>
<span id="862">862</span>
<span id="863">863</span>
<span id="864">864</span>
<span id="865">865</span>
<span id="866">866</span>
<span id="867">867</span>
<span id="868">868</span>
<span id="869">869</span>
<span id="870">870</span>
<span id="871">871</span>
<span id="872">872</span>
<span id="873">873</span>
<span id="874">874</span>
<span id="875">875</span>
<span id="876">876</span>
<span id="877">877</span>
<span id="878">878</span>
<span id="879">879</span>
<span id="880">880</span>
<span id="881">881</span>
<span id="882">882</span>
<span id="883">883</span>
<span id="884">884</span>
<span id="885">885</span>
<span id="886">886</span>
<span id="887">887</span>
<span id="888">888</span>
<span id="889">889</span>
<span id="890">890</span>
<span id="891">891</span>
<span id="892">892</span>
<span id="893">893</span>
<span id="894">894</span>
<span id="895">895</span>
<span id="896">896</span>
<span id="897">897</span>
<span id="898">898</span>
<span id="899">899</span>
<span id="900">900</span>
<span id="901">901</span>
<span id="902">902</span>
<span id="903">903</span>
<span id="904">904</span>
<span id="905">905</span>
<span id="906">906</span>
<span id="907">907</span>
<span id="908">908</span>
<span id="909">909</span>
<span id="910">910</span>
<span id="911">911</span>
<span id="912">912</span>
<span id="913">913</span>
<span id="914">914</span>
<span id="915">915</span>
<span id="916">916</span>
<span id="917">917</span>
<span id="918">918</span>
<span id="919">919</span>
<span id="920">920</span>
<span id="921">921</span>
<span id="922">922</span>
<span id="923">923</span>
<span id="924">924</span>
<span id="925">925</span>
<span id="926">926</span>
<span id="927">927</span>
<span id="928">928</span>
<span id="929">929</span>
<span id="930">930</span>
<span id="931">931</span>
<span id="932">932</span>
<span id="933">933</span>
<span id="934">934</span>
<span id="935">935</span>
<span id="936">936</span>
<span id="937">937</span>
<span id="938">938</span>
<span id="939">939</span>
<span id="940">940</span>
<span id="941">941</span>
<span id="942">942</span>
<span id="943">943</span>
<span id="944">944</span>
<span id="945">945</span>
<span id="946">946</span>
<span id="947">947</span>
<span id="948">948</span>
<span id="949">949</span>
<span id="950">950</span>
<span id="951">951</span>
<span id="952">952</span>
<span id="953">953</span>
<span id="954">954</span>
<span id="955">955</span>
<span id="956">956</span>
<span id="957">957</span>
<span id="958">958</span>
<span id="959">959</span>
<span id="960">960</span>
<span id="961">961</span>
<span id="962">962</span>
<span id="963">963</span>
<span id="964">964</span>
<span id="965">965</span>
<span id="966">966</span>
<span id="967">967</span>
<span id="968">968</span>
<span id="969">969</span>
<span id="970">970</span>
<span id="971">971</span>
<span id="972">972</span>
<span id="973">973</span>
<span id="974">974</span>
<span id="975">975</span>
<span id="976">976</span>
<span id="977">977</span>
<span id="978">978</span>
<span id="979">979</span>
<span id="980">980</span>
<span id="981">981</span>
<span id="982">982</span>
<span id="983">983</span>
<span id="984">984</span>
<span id="985">985</span>
<span id="986">986</span>
<span id="987">987</span>
<span id="988">988</span>
<span id="989">989</span>
<span id="990">990</span>
<span id="991">991</span>
<span id="992">992</span>
<span id="993">993</span>
<span id="994">994</span>
<span id="995">995</span>
<span id="996">996</span>
<span id="997">997</span>
<span id="998">998</span>
<span id="999">999</span>
<span id="1000">1000</span>
<span id="1001">1001</span>
<span id="1002">1002</span>
<span id="1003">1003</span>
<span id="1004">1004</span>
<span id="1005">1005</span>
<span id="1006">1006</span>
<span id="1007">1007</span>
<span id="1008">1008</span>
<span id="1009">1009</span>
<span id="1010">1010</span>
<span id="1011">1011</span>
<span id="1012">1012</span>
<span id="1013">1013</span>
<span id="1014">1014</span>
<span id="1015">1015</span>
<span id="1016">1016</span>
<span id="1017">1017</span>
<span id="1018">1018</span>
<span id="1019">1019</span>
<span id="1020">1020</span>
<span id="1021">1021</span>
<span id="1022">1022</span>
<span id="1023">1023</span>
<span id="1024">1024</span>
<span id="1025">1025</span>
<span id="1026">1026</span>
<span id="1027">1027</span>
<span id="1028">1028</span>
<span id="1029">1029</span>
<span id="1030">1030</span>
<span id="1031">1031</span>
<span id="1032">1032</span>
<span id="1033">1033</span>
<span id="1034">1034</span>
<span id="1035">1035</span>
<span id="1036">1036</span>
<span id="1037">1037</span>
<span id="1038">1038</span>
<span id="1039">1039</span>
<span id="1040">1040</span>
<span id="1041">1041</span>
<span id="1042">1042</span>
<span id="1043">1043</span>
<span id="1044">1044</span>
<span id="1045">1045</span>
<span id="1046">1046</span>
<span id="1047">1047</span>
<span id="1048">1048</span>
<span id="1049">1049</span>
<span id="1050">1050</span>
<span id="1051">1051</span>
<span id="1052">1052</span>
<span id="1053">1053</span>
<span id="1054">1054</span>
<span id="1055">1055</span>
<span id="1056">1056</span>
<span id="1057">1057</span>
<span id="1058">1058</span>
<span id="1059">1059</span>
<span id="1060">1060</span>
<span id="1061">1061</span>
<span id="1062">1062</span>
<span id="1063">1063</span>
<span id="1064">1064</span>
<span id="1065">1065</span>
</pre><pre class="rust"><code><span class="comment">// Copyright 2019 TiKV Project Authors. Licensed under Apache-2.0.
</span><span class="doccomment">//! A fail point implementation for Rust.
//!
//! Fail points are code instrumentations that allow errors and other behavior
//! to be injected dynamically at runtime, primarily for testing purposes. Fail
//! points are flexible and can be configured to exhibit a variety of behavior,
//! including panics, early returns, and sleeping. They can be controlled both
//! programmatically and via the environment, and can be triggered
//! conditionally and probabilistically.
//!
//! This crate is inspired by FreeBSD&#39;s
//! [failpoints](https://freebsd.org/cgi/man.cgi?query=fail).
//!
//! ## Usage
//!
//! First, add this to your `Cargo.toml`:
//!
//! ```toml
//! [dependencies]
//! fail = &quot;0.5&quot;
//! ```
//!
//! Now you can import the `fail_point!` macro from the `fail` crate and use it
//! to inject dynamic failures.
//!
//! As an example, here&#39;s a simple program that uses a fail point to simulate an
//! I/O panic:
//!
//! ```rust
//! use fail::{fail_point, FailScenario};
//!
//! fn do_fallible_work() {
//! fail_point!(&quot;read-dir&quot;);
//! let _dir: Vec&lt;_&gt; = std::fs::read_dir(&quot;.&quot;).unwrap().collect();
//! // ... do some work on the directory ...
//! }
//!
//! let scenario = FailScenario::setup();
//! do_fallible_work();
//! scenario.teardown();
//! println!(&quot;done&quot;);
//! ```
//!
//! Here, the program calls `unwrap` on the result of `read_dir`, a function
//! that returns a `Result`. In other words, this particular program expects
//! this call to `read_dir` to always succeed. And in practice it almost always
//! will, which makes the behavior of this program when `read_dir` fails
//! difficult to test. By instrumenting the program with a fail point we can
//! pretend that `read_dir` failed, causing the subsequent `unwrap` to panic,
//! and allowing us to observe the program&#39;s behavior under failure conditions.
//!
//! When the program is run normally it just prints &quot;done&quot;:
//!
//! ```sh
//! $ cargo run --features fail/failpoints
//! Finished dev [unoptimized + debuginfo] target(s) in 0.01s
//! Running `target/debug/failpointtest`
//! done
//! ```
//!
//! But now, by setting the `FAILPOINTS` variable we can see what happens if the
//! `read_dir` fails:
//!
//! ```sh
//! FAILPOINTS=read-dir=panic cargo run --features fail/failpoints
//! Finished dev [unoptimized + debuginfo] target(s) in 0.01s
//! Running `target/debug/failpointtest`
//! thread &#39;main&#39; panicked at &#39;failpoint read-dir panic&#39;, /home/ubuntu/.cargo/registry/src/github.com-1ecc6299db9ec823/fail-0.2.0/src/lib.rs:286:25
//! note: Run with `RUST_BACKTRACE=1` for a backtrace.
//! ```
//!
//! ## Usage in tests
//!
//! The previous example triggers a fail point by modifying the `FAILPOINT`
//! environment variable. In practice, you&#39;ll often want to trigger fail points
//! programmatically, in unit tests.
//! Fail points are global resources, and Rust tests run in parallel,
//! so tests that exercise fail points generally need to hold a lock to
//! avoid interfering with each other. This is accomplished by `FailScenario`.
//!
//! Here&#39;s a basic pattern for writing unit tests tests with fail points:
//!
//! ```rust
//! use fail::{fail_point, FailScenario};
//!
//! fn do_fallible_work() {
//! fail_point!(&quot;read-dir&quot;);
//! let _dir: Vec&lt;_&gt; = std::fs::read_dir(&quot;.&quot;).unwrap().collect();
//! // ... do some work on the directory ...
//! }
//!
//! #[test]
//! #[should_panic]
//! fn test_fallible_work() {
//! let scenario = FailScenario::setup();
//! fail::cfg(&quot;read-dir&quot;, &quot;panic&quot;).unwrap();
//!
//! do_fallible_work();
//!
//! scenario.teardown();
//! }
//! ```
//!
//! Even if a test does not itself turn on any fail points, code that it runs
//! could trigger a fail point that was configured by another thread. Because of
//! this it is a best practice to put all fail point unit tests into their own
//! binary. Here&#39;s an example of a snippet from `Cargo.toml` that creates a
//! fail-point-specific test binary:
//!
//! ```toml
//! [[test]]
//! name = &quot;failpoints&quot;
//! path = &quot;tests/failpoints/mod.rs&quot;
//! required-features = [&quot;fail/failpoints&quot;]
//! ```
//!
//!
//! ## Early return
//!
//! The previous examples illustrate injecting panics via fail points, but
//! panics aren&#39;t the only &amp;mdash; or even the most common &amp;mdash; error pattern
//! in Rust. The more common type of error is propagated by `Result` return
//! values, and fail points can inject those as well with &quot;early returns&quot;. That
//! is, when configuring a fail point as &quot;return&quot; (as opposed to &quot;panic&quot;), the
//! fail point will immediately return from the function, optionally with a
//! configurable value.
//!
//! The setup for early return requires a slightly diferent invocation of the
//! `fail_point!` macro. To illustrate this, let&#39;s modify the `do_fallible_work`
//! function we used earlier to return a `Result`:
//!
//! ```rust
//! use fail::{fail_point, FailScenario};
//! use std::io;
//!
//! fn do_fallible_work() -&gt; io::Result&lt;()&gt; {
//! fail_point!(&quot;read-dir&quot;);
//! let _dir: Vec&lt;_&gt; = std::fs::read_dir(&quot;.&quot;)?.collect();
//! // ... do some work on the directory ...
//! Ok(())
//! }
//!
//! fn main() -&gt; io::Result&lt;()&gt; {
//! let scenario = FailScenario::setup();
//! do_fallible_work()?;
//! scenario.teardown();
//! println!(&quot;done&quot;);
//! Ok(())
//! }
//! ```
//!
//! This example has more proper Rust error handling, with no unwraps
//! anywhere. Instead it uses `?` to propagate errors via the `Result` type
//! return values. This is more realistic Rust code.
//!
//! The &quot;read-dir&quot; fail point though is not yet configured to support early
//! return, so if we attempt to configure it to &quot;return&quot;, we&#39;ll see an error
//! like
//!
//! ```sh
//! $ FAILPOINTS=read-dir=return cargo run --features fail/failpoints
//! Finished dev [unoptimized + debuginfo] target(s) in 0.13s
//! Running `target/debug/failpointtest`
//! thread &#39;main&#39; panicked at &#39;Return is not supported for the fail point &quot;read-dir&quot;&#39;, src/main.rs:7:5
//! note: Run with `RUST_BACKTRACE=1` for a backtrace.
//! ```
//!
//! This error tells us that the &quot;read-dir&quot; fail point is not defined correctly
//! to support early return, and gives us the line number of that fail point.
//! What we&#39;re missing in the fail point definition is code describring _how_ to
//! return an error value, and the way we do this is by passing `fail_point!` a
//! closure that returns the same type as the enclosing function.
//!
//! Here&#39;s a variation that does so:
//!
//! ```rust
//! # use std::io;
//! fn do_fallible_work() -&gt; io::Result&lt;()&gt; {
//! fail::fail_point!(&quot;read-dir&quot;, |_| {
//! Err(io::Error::new(io::ErrorKind::PermissionDenied, &quot;error&quot;))
//! });
//! let _dir: Vec&lt;_&gt; = std::fs::read_dir(&quot;.&quot;)?.collect();
//! // ... do some work on the directory ...
//! Ok(())
//! }
//! ```
//!
//! And now if the &quot;read-dir&quot; fail point is configured to &quot;return&quot; we get a
//! different result:
//!
//! ```sh
//! $ FAILPOINTS=read-dir=return cargo run --features fail/failpoints
//! Compiling failpointtest v0.1.0
//! Finished dev [unoptimized + debuginfo] target(s) in 2.38s
//! Running `target/debug/failpointtest`
//! Error: Custom { kind: PermissionDenied, error: StringError(&quot;error&quot;) }
//! ```
//!
//! This time, `do_fallible_work` returned the error defined in our closure,
//! which propagated all the way up and out of main.
//!
//! ## Advanced usage
//!
//! That&#39;s the basics of fail points: defining them with `fail_point!`,
//! configuring them with `FAILPOINTS` and `fail::cfg`, and configuring them to
//! panic and return early. But that&#39;s not all they can do. To learn more see
//! the documentation for [`cfg`](fn.cfg.html),
//! [`cfg_callback`](fn.cfg_callback.html) and
//! [`fail_point!`](macro.fail_point.html).
//!
//!
//! ## Usage considerations
//!
//! For most effective fail point usage, keep in mind the following:
//!
//! - Fail points are disabled by default and can be enabled via the `failpoints`
//! feature. When failpoints are disabled, no code is generated by the macro.
//! - Carefully consider complex, concurrent, non-deterministic combinations of
//! fail points. Put test cases exercising fail points into their own test
//! crate.
//! - Fail points might have the same name, in which case they take the
//! same actions. Be careful about duplicating fail point names, either within
//! a single crate, or across multiple crates.
</span><span class="attribute">#![deny(missing_docs, missing_debug_implementations)]
</span><span class="kw">use </span>std::collections::HashMap;
<span class="kw">use </span>std::env::VarError;
<span class="kw">use </span>std::fmt::Debug;
<span class="kw">use </span>std::str::FromStr;
<span class="kw">use </span>std::sync::atomic::{AtomicUsize, Ordering};
<span class="kw">use </span>std::sync::{Arc, Condvar, Mutex, MutexGuard, RwLock, TryLockError};
<span class="kw">use </span>std::time::{Duration, Instant};
<span class="kw">use </span>std::{env, thread};
<span class="attribute">#[derive(Clone)]
</span><span class="kw">struct </span>SyncCallback(Arc&lt;<span class="kw">dyn </span>Fn() + Send + Sync&gt;);
<span class="kw">impl </span>Debug <span class="kw">for </span>SyncCallback {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>std::fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; std::fmt::Result {
f.write_str(<span class="string">&quot;SyncCallback()&quot;</span>)
}
}
<span class="kw">impl </span>PartialEq <span class="kw">for </span>SyncCallback {
<span class="attribute">#[allow(clippy::vtable_address_comparisons)]
</span><span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span><span class="self">Self</span>) -&gt; bool {
Arc::ptr_eq(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, <span class="kw-2">&amp;</span>other.<span class="number">0</span>)
}
}
<span class="kw">impl </span>SyncCallback {
<span class="kw">fn </span>new(f: <span class="kw">impl </span>Fn() + Send + Sync + <span class="lifetime">&#39;static</span>) -&gt; SyncCallback {
SyncCallback(Arc::new(f))
}
<span class="kw">fn </span>run(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="kw">let </span>callback = <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>;
callback();
}
}
<span class="doccomment">/// Supported tasks.
</span><span class="attribute">#[derive(Clone, Debug, PartialEq)]
</span><span class="kw">enum </span>Task {
<span class="doccomment">/// Do nothing.
</span>Off,
<span class="doccomment">/// Return the value.
</span>Return(<span class="prelude-ty">Option</span>&lt;String&gt;),
<span class="doccomment">/// Sleep for some milliseconds.
</span>Sleep(u64),
<span class="doccomment">/// Panic with the message.
</span>Panic(<span class="prelude-ty">Option</span>&lt;String&gt;),
<span class="doccomment">/// Print the message.
</span>Print(<span class="prelude-ty">Option</span>&lt;String&gt;),
<span class="doccomment">/// Sleep until other action is set.
</span>Pause,
<span class="doccomment">/// Yield the CPU.
</span>Yield,
<span class="doccomment">/// Busy waiting for some milliseconds.
</span>Delay(u64),
<span class="doccomment">/// Call callback function.
</span>Callback(SyncCallback),
}
<span class="attribute">#[derive(Debug)]
</span><span class="kw">struct </span>Action {
task: Task,
freq: f32,
count: <span class="prelude-ty">Option</span>&lt;AtomicUsize&gt;,
}
<span class="kw">impl </span>PartialEq <span class="kw">for </span>Action {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, hs: <span class="kw-2">&amp;</span>Action) -&gt; bool {
<span class="kw">if </span><span class="self">self</span>.task != hs.task || <span class="self">self</span>.freq != hs.freq {
<span class="kw">return </span><span class="bool-val">false</span>;
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>lhs) = <span class="self">self</span>.count {
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>rhs) = hs.count {
<span class="kw">return </span>lhs.load(Ordering::Relaxed) == rhs.load(Ordering::Relaxed);
}
} <span class="kw">else if </span>hs.count.is_none() {
<span class="kw">return </span><span class="bool-val">true</span>;
}
<span class="bool-val">false
</span>}
}
<span class="kw">impl </span>Action {
<span class="kw">fn </span>new(task: Task, freq: f32, max_cnt: <span class="prelude-ty">Option</span>&lt;usize&gt;) -&gt; Action {
Action {
task,
freq,
count: max_cnt.map(AtomicUsize::new),
}
}
<span class="kw">fn </span>from_callback(f: <span class="kw">impl </span>Fn() + Send + Sync + <span class="lifetime">&#39;static</span>) -&gt; Action {
<span class="kw">let </span>task = Task::Callback(SyncCallback::new(f));
Action {
task,
freq: <span class="number">1.0</span>,
count: <span class="prelude-val">None</span>,
}
}
<span class="kw">fn </span>get_task(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Task&gt; {
<span class="kw">use </span>rand::Rng;
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>cnt) = <span class="self">self</span>.count {
<span class="kw">let </span>c = cnt.load(Ordering::Acquire);
<span class="kw">if </span>c == <span class="number">0 </span>{
<span class="kw">return </span><span class="prelude-val">None</span>;
}
}
<span class="kw">if </span><span class="self">self</span>.freq &lt; <span class="number">1f32 </span>&amp;&amp; !rand::thread_rng().gen_bool(f64::from(<span class="self">self</span>.freq)) {
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>ref_cnt) = <span class="self">self</span>.count {
<span class="kw">let </span><span class="kw-2">mut </span>cnt = ref_cnt.load(Ordering::Acquire);
<span class="kw">loop </span>{
<span class="kw">if </span>cnt == <span class="number">0 </span>{
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="kw">let </span>new_cnt = cnt - <span class="number">1</span>;
<span class="kw">match </span>ref_cnt.compare_exchange_weak(
cnt,
new_cnt,
Ordering::AcqRel,
Ordering::Acquire,
) {
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="kw">break</span>,
<span class="prelude-val">Err</span>(c) =&gt; cnt = c,
}
}
}
<span class="prelude-val">Some</span>(<span class="self">self</span>.task.clone())
}
}
<span class="kw">fn </span>partition(s: <span class="kw-2">&amp;</span>str, pattern: char) -&gt; (<span class="kw-2">&amp;</span>str, <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;) {
<span class="kw">let </span><span class="kw-2">mut </span>splits = s.splitn(<span class="number">2</span>, pattern);
(splits.next().unwrap(), splits.next())
}
<span class="kw">impl </span>FromStr <span class="kw">for </span>Action {
<span class="kw">type </span><span class="prelude-val">Err </span>= String;
<span class="doccomment">/// Parse an action.
///
/// `s` should be in the format `[p%][cnt*]task[(args)]`, `p%` is the frequency,
/// `cnt` is the max times the action can be triggered.
</span><span class="kw">fn </span>from_str(s: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;Action, String&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>remain = s.trim();
<span class="kw">let </span><span class="kw-2">mut </span>args = <span class="prelude-val">None</span>;
<span class="comment">// in case there is &#39;%&#39; in args, we need to parse it first.
</span><span class="kw">let </span>(first, second) = partition(remain, <span class="string">&#39;(&#39;</span>);
<span class="kw">if let </span><span class="prelude-val">Some</span>(second) = second {
remain = first;
<span class="kw">if </span>!second.ends_with(<span class="string">&#39;)&#39;</span>) {
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="string">&quot;parentheses do not match&quot;</span>.to_owned());
}
args = <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>second[..second.len() - <span class="number">1</span>]);
}
<span class="kw">let </span><span class="kw-2">mut </span>frequency = <span class="number">1f32</span>;
<span class="kw">let </span>(first, second) = partition(remain, <span class="string">&#39;%&#39;</span>);
<span class="kw">if let </span><span class="prelude-val">Some</span>(second) = second {
remain = second;
<span class="kw">match </span>first.parse::&lt;f32&gt;() {
<span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">&quot;failed to parse frequency: {}&quot;</span>, e)),
<span class="prelude-val">Ok</span>(freq) =&gt; frequency = freq / <span class="number">100.0</span>,
}
}
<span class="kw">let </span><span class="kw-2">mut </span>max_cnt = <span class="prelude-val">None</span>;
<span class="kw">let </span>(first, second) = partition(remain, <span class="string">&#39;*&#39;</span>);
<span class="kw">if let </span><span class="prelude-val">Some</span>(second) = second {
remain = second;
<span class="kw">match </span>first.parse() {
<span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">&quot;failed to parse count: {}&quot;</span>, e)),
<span class="prelude-val">Ok</span>(cnt) =&gt; max_cnt = <span class="prelude-val">Some</span>(cnt),
}
}
<span class="kw">let </span>parse_timeout = || <span class="kw">match </span>args {
<span class="prelude-val">None </span>=&gt; <span class="prelude-val">Err</span>(<span class="string">&quot;sleep require timeout&quot;</span>.to_owned()),
<span class="prelude-val">Some</span>(timeout_str) =&gt; <span class="kw">match </span>timeout_str.parse() {
<span class="prelude-val">Err</span>(e) =&gt; <span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">&quot;failed to parse timeout: {}&quot;</span>, e)),
<span class="prelude-val">Ok</span>(timeout) =&gt; <span class="prelude-val">Ok</span>(timeout),
},
};
<span class="kw">let </span>task = <span class="kw">match </span>remain {
<span class="string">&quot;off&quot; </span>=&gt; Task::Off,
<span class="string">&quot;return&quot; </span>=&gt; Task::Return(args.map(str::to_owned)),
<span class="string">&quot;sleep&quot; </span>=&gt; Task::Sleep(parse_timeout()<span class="question-mark">?</span>),
<span class="string">&quot;panic&quot; </span>=&gt; Task::Panic(args.map(str::to_owned)),
<span class="string">&quot;print&quot; </span>=&gt; Task::Print(args.map(str::to_owned)),
<span class="string">&quot;pause&quot; </span>=&gt; Task::Pause,
<span class="string">&quot;yield&quot; </span>=&gt; Task::Yield,
<span class="string">&quot;delay&quot; </span>=&gt; Task::Delay(parse_timeout()<span class="question-mark">?</span>),
<span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">&quot;unrecognized command {:?}&quot;</span>, remain)),
};
<span class="prelude-val">Ok</span>(Action::new(task, frequency, max_cnt))
}
}
<span class="attribute">#[cfg_attr(feature = <span class="string">&quot;cargo-clippy&quot;</span>, allow(clippy::mutex_atomic))]
#[derive(Debug)]
</span><span class="kw">struct </span>FailPoint {
pause: Mutex&lt;bool&gt;,
pause_notifier: Condvar,
actions: RwLock&lt;Vec&lt;Action&gt;&gt;,
actions_str: RwLock&lt;String&gt;,
}
<span class="attribute">#[cfg_attr(feature = <span class="string">&quot;cargo-clippy&quot;</span>, allow(clippy::mutex_atomic))]
</span><span class="kw">impl </span>FailPoint {
<span class="kw">fn </span>new() -&gt; FailPoint {
FailPoint {
pause: Mutex::new(<span class="bool-val">false</span>),
pause_notifier: Condvar::new(),
actions: RwLock::default(),
actions_str: RwLock::default(),
}
}
<span class="kw">fn </span>set_actions(<span class="kw-2">&amp;</span><span class="self">self</span>, actions_str: <span class="kw-2">&amp;</span>str, actions: Vec&lt;Action&gt;) {
<span class="kw">loop </span>{
<span class="comment">// TODO: maybe busy waiting here.
</span><span class="kw">match </span><span class="self">self</span>.actions.try_write() {
<span class="prelude-val">Err</span>(TryLockError::WouldBlock) =&gt; {}
<span class="prelude-val">Ok</span>(<span class="kw-2">mut </span>guard) =&gt; {
<span class="kw-2">*</span>guard = actions;
<span class="kw-2">*</span><span class="self">self</span>.actions_str.write().unwrap() = actions_str.to_string();
<span class="kw">return</span>;
}
<span class="prelude-val">Err</span>(e) =&gt; <span class="macro">panic!</span>(<span class="string">&quot;unexpected poison: {:?}&quot;</span>, e),
}
<span class="kw">let </span><span class="kw-2">mut </span>guard = <span class="self">self</span>.pause.lock().unwrap();
<span class="kw-2">*</span>guard = <span class="bool-val">false</span>;
<span class="self">self</span>.pause_notifier.notify_all();
}
}
<span class="attribute">#[cfg_attr(feature = <span class="string">&quot;cargo-clippy&quot;</span>, allow(clippy::option_option))]
</span><span class="kw">fn </span>eval(<span class="kw-2">&amp;</span><span class="self">self</span>, name: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="prelude-ty">Option</span>&lt;String&gt;&gt; {
<span class="kw">let </span>task = {
<span class="kw">let </span>actions = <span class="self">self</span>.actions.read().unwrap();
<span class="kw">match </span>actions.iter().filter_map(Action::get_task).next() {
<span class="prelude-val">Some</span>(Task::Pause) =&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>guard = <span class="self">self</span>.pause.lock().unwrap();
<span class="kw-2">*</span>guard = <span class="bool-val">true</span>;
<span class="kw">loop </span>{
guard = <span class="self">self</span>.pause_notifier.wait(guard).unwrap();
<span class="kw">if </span>!<span class="kw-2">*</span>guard {
<span class="kw">break</span>;
}
}
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="prelude-val">Some</span>(t) =&gt; t,
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">None</span>,
}
};
<span class="kw">match </span>task {
Task::Off =&gt; {}
Task::Return(s) =&gt; <span class="kw">return </span><span class="prelude-val">Some</span>(s),
Task::Sleep(t) =&gt; thread::sleep(Duration::from_millis(t)),
Task::Panic(msg) =&gt; <span class="kw">match </span>msg {
<span class="prelude-val">Some</span>(<span class="kw-2">ref </span>msg) =&gt; <span class="macro">panic!</span>(<span class="string">&quot;{}&quot;</span>, msg),
<span class="prelude-val">None </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;failpoint {} panic&quot;</span>, name),
},
Task::Print(msg) =&gt; <span class="kw">match </span>msg {
<span class="prelude-val">Some</span>(<span class="kw-2">ref </span>msg) =&gt; <span class="macro">log::info!</span>(<span class="string">&quot;{}&quot;</span>, msg),
<span class="prelude-val">None </span>=&gt; <span class="macro">log::info!</span>(<span class="string">&quot;failpoint {} executed.&quot;</span>, name),
},
Task::Pause =&gt; <span class="macro">unreachable!</span>(),
Task::Yield =&gt; thread::yield_now(),
Task::Delay(t) =&gt; {
<span class="kw">let </span>timer = Instant::now();
<span class="kw">let </span>timeout = Duration::from_millis(t);
<span class="kw">while </span>timer.elapsed() &lt; timeout {}
}
Task::Callback(f) =&gt; {
f.run();
}
}
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Registry with failpoints configuration.
</span><span class="kw">type </span>Registry = HashMap&lt;String, Arc&lt;FailPoint&gt;&gt;;
<span class="attribute">#[derive(Debug, Default)]
</span><span class="kw">struct </span>FailPointRegistry {
<span class="comment">// TODO: remove rwlock or store *mut FailPoint
</span>registry: RwLock&lt;Registry&gt;,
}
<span class="kw">use </span>once_cell::sync::Lazy;
<span class="kw">static </span>REGISTRY: Lazy&lt;FailPointRegistry&gt; = Lazy::new(FailPointRegistry::default);
<span class="kw">static </span>SCENARIO: Lazy&lt;Mutex&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>FailPointRegistry&gt;&gt; = Lazy::new(|| Mutex::new(<span class="kw-2">&amp;</span>REGISTRY));
<span class="doccomment">/// Test scenario with configured fail points.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>FailScenario&lt;<span class="lifetime">&#39;a</span>&gt; {
scenario_guard: MutexGuard&lt;<span class="lifetime">&#39;a</span>, <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>FailPointRegistry&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; FailScenario&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// Set up the system for a fail points scenario.
///
/// Configures all fail points specified in the `FAILPOINTS` environment variable.
/// It does not otherwise change any existing fail point configuration.
///
/// The format of `FAILPOINTS` is `failpoint=actions;...`, where
/// `failpoint` is the name of the fail point. For more information
/// about fail point actions see the [`cfg`](fn.cfg.html) function and
/// the [`fail_point`](macro.fail_point.html) macro.
///
/// `FAILPOINTS` may configure fail points that are not actually defined. In
/// this case the configuration has no effect.
///
/// This function should generally be called prior to running a test with fail
/// points, and afterward paired with [`teardown`](#method.teardown).
///
/// # Panics
///
/// Panics if an action is not formatted correctly.
</span><span class="kw">pub fn </span>setup() -&gt; <span class="self">Self </span>{
<span class="comment">// Cleanup first, in case of previous failed/panic&#39;ed test scenarios.
</span><span class="kw">let </span>scenario_guard = SCENARIO.lock().unwrap_or_else(|e| e.into_inner());
<span class="kw">let </span><span class="kw-2">mut </span>registry = scenario_guard.registry.write().unwrap();
<span class="self">Self</span>::cleanup(<span class="kw-2">&amp;mut </span>registry);
<span class="kw">let </span>failpoints = <span class="kw">match </span>env::var(<span class="string">&quot;FAILPOINTS&quot;</span>) {
<span class="prelude-val">Ok</span>(s) =&gt; s,
<span class="prelude-val">Err</span>(VarError::NotPresent) =&gt; <span class="kw">return </span><span class="self">Self </span>{ scenario_guard },
<span class="prelude-val">Err</span>(e) =&gt; <span class="macro">panic!</span>(<span class="string">&quot;invalid failpoints: {:?}&quot;</span>, e),
};
<span class="kw">for </span><span class="kw-2">mut </span>cfg <span class="kw">in </span>failpoints.trim().split(<span class="string">&#39;;&#39;</span>) {
cfg = cfg.trim();
<span class="kw">if </span>cfg.is_empty() {
<span class="kw">continue</span>;
}
<span class="kw">let </span>(name, order) = partition(cfg, <span class="string">&#39;=&#39;</span>);
<span class="kw">match </span>order {
<span class="prelude-val">None </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;invalid failpoint: {:?}&quot;</span>, cfg),
<span class="prelude-val">Some</span>(order) =&gt; {
<span class="kw">if let </span><span class="prelude-val">Err</span>(e) = set(<span class="kw-2">&amp;mut </span>registry, name.to_owned(), order) {
<span class="macro">panic!</span>(<span class="string">&quot;unable to configure failpoint \&quot;{}\&quot;: {}&quot;</span>, name, e);
}
}
}
}
<span class="self">Self </span>{ scenario_guard }
}
<span class="doccomment">/// Tear down the fail point system.
///
/// Clears the configuration of all fail points. Any paused fail
/// points will be notified before they are deactivated.
///
/// This function should generally be called after running a test with fail points.
/// Calling `teardown` without previously calling `setup` results in a no-op.
</span><span class="kw">pub fn </span>teardown(<span class="self">self</span>) {
drop(<span class="self">self</span>)
}
<span class="doccomment">/// Clean all registered fail points.
</span><span class="kw">fn </span>cleanup(registry: <span class="kw-2">&amp;mut </span>std::sync::RwLockWriteGuard&lt;<span class="lifetime">&#39;a</span>, Registry&gt;) {
<span class="kw">for </span>p <span class="kw">in </span>registry.values() {
<span class="comment">// wake up all pause failpoint.
</span>p.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[]);
}
registry.clear();
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Drop <span class="kw">for </span>FailScenario&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">let </span><span class="kw-2">mut </span>registry = <span class="self">self</span>.scenario_guard.registry.write().unwrap();
<span class="self">Self</span>::cleanup(<span class="kw-2">&amp;mut </span>registry)
}
}
<span class="doccomment">/// Returns whether code generation for failpoints is enabled.
///
/// This function allows consumers to check (at runtime) whether the library
/// was compiled with the (buildtime) `failpoints` feature, which enables
/// code generation for failpoints.
</span><span class="kw">pub const fn </span>has_failpoints() -&gt; bool {
<span class="macro">cfg!</span>(feature = <span class="string">&quot;failpoints&quot;</span>)
}
<span class="doccomment">/// Get all registered fail points.
///
/// Return a vector of `(name, actions)` pairs.
</span><span class="kw">pub fn </span>list() -&gt; Vec&lt;(String, String)&gt; {
<span class="kw">let </span>registry = REGISTRY.registry.read().unwrap();
registry
.iter()
.map(|(name, fp)| (name.to_string(), fp.actions_str.read().unwrap().clone()))
.collect()
}
<span class="attribute">#[doc(hidden)]
</span><span class="kw">pub fn </span>eval&lt;R, F: FnOnce(<span class="prelude-ty">Option</span>&lt;String&gt;) -&gt; R&gt;(name: <span class="kw-2">&amp;</span>str, f: F) -&gt; <span class="prelude-ty">Option</span>&lt;R&gt; {
<span class="kw">let </span>p = {
<span class="kw">let </span>registry = REGISTRY.registry.read().unwrap();
<span class="kw">match </span>registry.get(name) {
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">None</span>,
<span class="prelude-val">Some</span>(p) =&gt; p.clone(),
}
};
p.eval(name).map(f)
}
<span class="doccomment">/// Configure the actions for a fail point at runtime.
///
/// Each fail point can be configured with a series of actions, specified by the
/// `actions` argument. The format of `actions` is `action[-&gt;action...]`. When
/// multiple actions are specified, an action will be checked only when its
/// former action is not triggered.
///
/// The format of a single action is `[p%][cnt*]task[(arg)]`. `p%` is the
/// expected probability that the action is triggered, and `cnt*` is the max
/// times the action can be triggered. The supported values of `task` are:
///
/// - `off`, the fail point will do nothing.
/// - `return(arg)`, return early when the fail point is triggered. `arg` is passed to `$e` (
/// defined via the `fail_point!` macro) as a string.
/// - `sleep(milliseconds)`, sleep for the specified time.
/// - `panic(msg)`, panic with the message.
/// - `print(msg)`, log the message, using the `log` crate, at the `info` level.
/// - `pause`, sleep until other action is set to the fail point.
/// - `yield`, yield the CPU.
/// - `delay(milliseconds)`, busy waiting for the specified time.
///
/// For example, `20%3*print(still alive!)-&gt;panic` means the fail point has 20% chance to print a
/// message &quot;still alive!&quot; and 80% chance to panic. And the message will be printed at most 3
/// times.
///
/// The `FAILPOINTS` environment variable accepts this same syntax for its fail
/// point actions.
///
/// A call to `cfg` with a particular fail point name overwrites any existing actions for
/// that fail point, including those set via the `FAILPOINTS` environment variable.
</span><span class="kw">pub fn </span>cfg&lt;S: Into&lt;String&gt;&gt;(name: S, actions: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;(), String&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>registry = REGISTRY.registry.write().unwrap();
set(<span class="kw-2">&amp;mut </span>registry, name.into(), actions)
}
<span class="doccomment">/// Configure the actions for a fail point at runtime.
///
/// Each fail point can be configured by a callback. Process will call this callback function
/// when it meet this fail-point.
</span><span class="kw">pub fn </span>cfg_callback&lt;S, F&gt;(name: S, f: F) -&gt; <span class="prelude-ty">Result</span>&lt;(), String&gt;
<span class="kw">where
</span>S: Into&lt;String&gt;,
F: Fn() + Send + Sync + <span class="lifetime">&#39;static</span>,
{
<span class="kw">let </span><span class="kw-2">mut </span>registry = REGISTRY.registry.write().unwrap();
<span class="kw">let </span>p = registry
.entry(name.into())
.or_insert_with(|| Arc::new(FailPoint::new()));
<span class="kw">let </span>action = Action::from_callback(f);
<span class="kw">let </span>actions = <span class="macro">vec!</span>[action];
p.set_actions(<span class="string">&quot;callback&quot;</span>, actions);
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Remove a fail point.
///
/// If the fail point doesn&#39;t exist, nothing will happen.
</span><span class="kw">pub fn </span>remove&lt;S: AsRef&lt;str&gt;&gt;(name: S) {
<span class="kw">let </span><span class="kw-2">mut </span>registry = REGISTRY.registry.write().unwrap();
<span class="kw">if let </span><span class="prelude-val">Some</span>(p) = registry.remove(name.as_ref()) {
<span class="comment">// wake up all pause failpoint.
</span>p.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[]);
}
}
<span class="doccomment">/// Configure fail point in RAII style.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>FailGuard(String);
<span class="kw">impl </span>Drop <span class="kw">for </span>FailGuard {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
remove(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>);
}
}
<span class="kw">impl </span>FailGuard {
<span class="doccomment">/// Configure the actions for a fail point during the lifetime of the returning `FailGuard`.
///
/// Read documentation of [`cfg`] for more details.
</span><span class="kw">pub fn </span>new&lt;S: Into&lt;String&gt;&gt;(name: S, actions: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;FailGuard, String&gt; {
<span class="kw">let </span>name = name.into();
cfg(<span class="kw-2">&amp;</span>name, actions)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(FailGuard(name))
}
<span class="doccomment">/// Configure the actions for a fail point during the lifetime of the returning `FailGuard`.
///
/// Read documentation of [`cfg_callback`] for more details.
</span><span class="kw">pub fn </span>with_callback&lt;S, F&gt;(name: S, f: F) -&gt; <span class="prelude-ty">Result</span>&lt;FailGuard, String&gt;
<span class="kw">where
</span>S: Into&lt;String&gt;,
F: Fn() + Send + Sync + <span class="lifetime">&#39;static</span>,
{
<span class="kw">let </span>name = name.into();
cfg_callback(<span class="kw-2">&amp;</span>name, f)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(FailGuard(name))
}
}
<span class="kw">fn </span>set(
registry: <span class="kw-2">&amp;mut </span>HashMap&lt;String, Arc&lt;FailPoint&gt;&gt;,
name: String,
actions: <span class="kw-2">&amp;</span>str,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), String&gt; {
<span class="kw">let </span>actions_str = actions;
<span class="comment">// `actions` are in the format of `failpoint[-&gt;failpoint...]`.
</span><span class="kw">let </span>actions = actions
.split(<span class="string">&quot;-&gt;&quot;</span>)
.map(Action::from_str)
.collect::&lt;<span class="prelude-ty">Result</span>&lt;<span class="kw">_</span>, <span class="kw">_</span>&gt;&gt;()<span class="question-mark">?</span>;
<span class="comment">// Please note that we can&#39;t figure out whether there is a failpoint named `name`,
// so we may insert a failpoint that doesn&#39;t exist at all.
</span><span class="kw">let </span>p = registry
.entry(name)
.or_insert_with(|| Arc::new(FailPoint::new()));
p.set_actions(actions_str, actions);
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Define a fail point (requires `failpoints` feature).
///
/// The `fail_point!` macro has three forms, and they all take a name as the
/// first argument. The simplest form takes only a name and is suitable for
/// executing most fail point behavior, including panicking, but not for early
/// return or conditional execution based on a local flag.
///
/// The three forms of fail points look as follows.
///
/// 1. A basic fail point:
///
/// ```rust
/// # #[macro_use] extern crate fail;
/// fn function_return_unit() {
/// fail_point!(&quot;fail-point-1&quot;);
/// }
/// ```
///
/// This form of fail point can be configured to panic, print, sleep, pause, etc., but
/// not to return from the function early.
///
/// 2. A fail point that may return early:
///
/// ```rust
/// # #[macro_use] extern crate fail;
/// fn function_return_value() -&gt; u64 {
/// fail_point!(&quot;fail-point-2&quot;, |r| r.map_or(2, |e| e.parse().unwrap()));
/// 0
/// }
/// ```
///
/// This form of fail point can additionally be configured to return early from
/// the enclosing function. It accepts a closure, which itself accepts an
/// `Option&lt;String&gt;`, and is expected to transform that argument into the early
/// return value. The argument string is sourced from the fail point
/// configuration string. For example configuring this &quot;fail-point-2&quot; as
/// &quot;return(100)&quot; will execute the fail point closure, passing it a `Some` value
/// containing a `String` equal to &quot;100&quot;; the closure then parses it into the
/// return value.
///
/// 3. A fail point with conditional execution:
///
/// ```rust
/// # #[macro_use] extern crate fail;
/// fn function_conditional(enable: bool) {
/// fail_point!(&quot;fail-point-3&quot;, enable, |_| {});
/// }
/// ```
///
/// In this final form, the second argument is a local boolean expression that
/// must evaluate to `true` before the fail point is evaluated. The third
/// argument is again an early-return closure.
///
/// The three macro arguments (or &quot;designators&quot;) are called `$name`, `$cond`,
/// and `$e`. `$name` must be `&amp;str`, `$cond` must be a boolean expression,
/// and`$e` must be a function or closure that accepts an `Option&lt;String&gt;` and
/// returns the same type as the enclosing function.
///
/// For more examples see the [crate documentation](index.html). For more
/// information about controlling fail points see the [`cfg`](fn.cfg.html)
/// function.
</span><span class="attribute">#[macro_export]
#[cfg(feature = <span class="string">&quot;failpoints&quot;</span>)]
</span><span class="macro">macro_rules! </span>fail_point {
(<span class="macro-nonterminal">$name</span>:expr) =&gt; {{
<span class="macro-nonterminal">$crate::eval</span>(<span class="macro-nonterminal">$name</span>, |<span class="kw">_</span>| {
<span class="macro">panic!</span>(<span class="string">&quot;Return is not supported for the fail point \&quot;{}\&quot;&quot;</span>, <span class="macro-nonterminal">$name</span>);
});
}};
(<span class="macro-nonterminal">$name</span>:expr, <span class="macro-nonterminal">$e</span>:expr) =&gt; {{
<span class="kw">if let </span><span class="prelude-val">Some</span>(res) = <span class="macro-nonterminal">$crate::eval</span>(<span class="macro-nonterminal">$name</span>, <span class="macro-nonterminal">$e</span>) {
<span class="kw">return </span>res;
}
}};
(<span class="macro-nonterminal">$name</span>:expr, <span class="macro-nonterminal">$cond</span>:expr, <span class="macro-nonterminal">$e</span>:expr) =&gt; {{
<span class="kw">if </span><span class="macro-nonterminal">$cond </span>{
<span class="macro-nonterminal">$</span><span class="macro">crate::fail_point!</span>(<span class="macro-nonterminal">$name</span>, <span class="macro-nonterminal">$e</span>);
}
}};
}
<span class="doccomment">/// Define a fail point (disabled, see `failpoints` feature).
</span><span class="attribute">#[macro_export]
#[cfg(not(feature = <span class="string">&quot;failpoints&quot;</span>))]
</span><span class="macro">macro_rules! </span>fail_point {
(<span class="macro-nonterminal">$name</span>:expr, <span class="macro-nonterminal">$e</span>:expr) =&gt; {{}};
(<span class="macro-nonterminal">$name</span>:expr) =&gt; {{}};
(<span class="macro-nonterminal">$name</span>:expr, <span class="macro-nonterminal">$cond</span>:expr, <span class="macro-nonterminal">$e</span>:expr) =&gt; {{}};
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span>std::sync::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_has_failpoints() {
<span class="macro">assert_eq!</span>(<span class="macro">cfg!</span>(feature = <span class="string">&quot;failpoints&quot;</span>), has_failpoints());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_off() {
<span class="kw">let </span>point = FailPoint::new();
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Off, <span class="number">1.0</span>, <span class="prelude-val">None</span>)]);
<span class="macro">assert!</span>(point.eval(<span class="string">&quot;test_fail_point_off&quot;</span>).is_none());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_return() {
<span class="kw">let </span>point = FailPoint::new();
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Return(<span class="prelude-val">None</span>), <span class="number">1.0</span>, <span class="prelude-val">None</span>)]);
<span class="kw">let </span>res = point.eval(<span class="string">&quot;test_fail_point_return&quot;</span>);
<span class="macro">assert_eq!</span>(res, <span class="prelude-val">Some</span>(<span class="prelude-val">None</span>));
<span class="kw">let </span>ret = <span class="prelude-val">Some</span>(<span class="string">&quot;test&quot;</span>.to_owned());
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Return(ret.clone()), <span class="number">1.0</span>, <span class="prelude-val">None</span>)]);
<span class="kw">let </span>res = point.eval(<span class="string">&quot;test_fail_point_return&quot;</span>);
<span class="macro">assert_eq!</span>(res, <span class="prelude-val">Some</span>(ret));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_sleep() {
<span class="kw">let </span>point = FailPoint::new();
<span class="kw">let </span>timer = Instant::now();
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Sleep(<span class="number">1000</span>), <span class="number">1.0</span>, <span class="prelude-val">None</span>)]);
<span class="macro">assert!</span>(point.eval(<span class="string">&quot;test_fail_point_sleep&quot;</span>).is_none());
<span class="macro">assert!</span>(timer.elapsed() &gt; Duration::from_millis(<span class="number">1000</span>));
}
<span class="attribute">#[should_panic]
#[test]
</span><span class="kw">fn </span>test_panic() {
<span class="kw">let </span>point = FailPoint::new();
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Panic(<span class="prelude-val">None</span>), <span class="number">1.0</span>, <span class="prelude-val">None</span>)]);
point.eval(<span class="string">&quot;test_fail_point_panic&quot;</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_print() {
<span class="kw">struct </span>LogCollector(Arc&lt;Mutex&lt;Vec&lt;String&gt;&gt;&gt;);
<span class="kw">impl </span>log::Log <span class="kw">for </span>LogCollector {
<span class="kw">fn </span>enabled(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&amp;</span>log::Metadata) -&gt; bool {
<span class="bool-val">true
</span>}
<span class="kw">fn </span>log(<span class="kw-2">&amp;</span><span class="self">self</span>, record: <span class="kw-2">&amp;</span>log::Record) {
<span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="self">self</span>.<span class="number">0</span>.lock().unwrap();
buf.push(<span class="macro">format!</span>(<span class="string">&quot;{}&quot;</span>, record.args()));
}
<span class="kw">fn </span>flush(<span class="kw-2">&amp;</span><span class="self">self</span>) {}
}
<span class="kw">let </span>buffer = Arc::new(Mutex::new(<span class="macro">vec!</span>[]));
<span class="kw">let </span>collector = LogCollector(buffer.clone());
log::set_max_level(log::LevelFilter::Info);
log::set_boxed_logger(Box::new(collector)).unwrap();
<span class="kw">let </span>point = FailPoint::new();
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Print(<span class="prelude-val">None</span>), <span class="number">1.0</span>, <span class="prelude-val">None</span>)]);
<span class="macro">assert!</span>(point.eval(<span class="string">&quot;test_fail_point_print&quot;</span>).is_none());
<span class="kw">let </span>msg = buffer.lock().unwrap().pop().unwrap();
<span class="macro">assert_eq!</span>(msg, <span class="string">&quot;failpoint test_fail_point_print executed.&quot;</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_pause() {
<span class="kw">let </span>point = Arc::new(FailPoint::new());
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Pause, <span class="number">1.0</span>, <span class="prelude-val">None</span>)]);
<span class="kw">let </span>p = point.clone();
<span class="kw">let </span>(tx, rx) = mpsc::channel();
thread::spawn(<span class="kw">move </span>|| {
<span class="macro">assert_eq!</span>(p.eval(<span class="string">&quot;test_fail_point_pause&quot;</span>), <span class="prelude-val">None</span>);
tx.send(()).unwrap();
});
<span class="macro">assert!</span>(rx.recv_timeout(Duration::from_secs(<span class="number">1</span>)).is_err());
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Off, <span class="number">1.0</span>, <span class="prelude-val">None</span>)]);
rx.recv_timeout(Duration::from_secs(<span class="number">1</span>)).unwrap();
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_yield() {
<span class="kw">let </span>point = FailPoint::new();
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Yield, <span class="number">1.0</span>, <span class="prelude-val">None</span>)]);
<span class="macro">assert!</span>(point.eval(<span class="string">&quot;test_fail_point_yield&quot;</span>).is_none());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_delay() {
<span class="kw">let </span>point = FailPoint::new();
<span class="kw">let </span>timer = Instant::now();
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Delay(<span class="number">1000</span>), <span class="number">1.0</span>, <span class="prelude-val">None</span>)]);
<span class="macro">assert!</span>(point.eval(<span class="string">&quot;test_fail_point_delay&quot;</span>).is_none());
<span class="macro">assert!</span>(timer.elapsed() &gt; Duration::from_millis(<span class="number">1000</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_frequency_and_count() {
<span class="kw">let </span>point = FailPoint::new();
point.set_actions(<span class="string">&quot;&quot;</span>, <span class="macro">vec!</span>[Action::new(Task::Return(<span class="prelude-val">None</span>), <span class="number">0.8</span>, <span class="prelude-val">Some</span>(<span class="number">100</span>))]);
<span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">0</span>;
<span class="kw">let </span><span class="kw-2">mut </span>times = <span class="number">0f64</span>;
<span class="kw">while </span>count &lt; <span class="number">100 </span>{
<span class="kw">if </span>point.eval(<span class="string">&quot;test_fail_point_frequency&quot;</span>).is_some() {
count += <span class="number">1</span>;
}
times += <span class="number">1f64</span>;
}
<span class="macro">assert!</span>(<span class="number">100.0 </span>/ <span class="number">0.9 </span>&lt; times &amp;&amp; times &lt; <span class="number">100.0 </span>/ <span class="number">0.7</span>, <span class="string">&quot;{}&quot;</span>, times);
<span class="kw">for _ in </span><span class="number">0</span>..times <span class="kw">as </span>u64 {
<span class="macro">assert!</span>(point.eval(<span class="string">&quot;test_fail_point_frequency&quot;</span>).is_none());
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_parse() {
<span class="kw">let </span>cases = <span class="macro">vec!</span>[
(<span class="string">&quot;return&quot;</span>, Action::new(Task::Return(<span class="prelude-val">None</span>), <span class="number">1.0</span>, <span class="prelude-val">None</span>)),
(
<span class="string">&quot;return(64)&quot;</span>,
Action::new(Task::Return(<span class="prelude-val">Some</span>(<span class="string">&quot;64&quot;</span>.to_owned())), <span class="number">1.0</span>, <span class="prelude-val">None</span>),
),
(<span class="string">&quot;5*return&quot;</span>, Action::new(Task::Return(<span class="prelude-val">None</span>), <span class="number">1.0</span>, <span class="prelude-val">Some</span>(<span class="number">5</span>))),
(<span class="string">&quot;25%return&quot;</span>, Action::new(Task::Return(<span class="prelude-val">None</span>), <span class="number">0.25</span>, <span class="prelude-val">None</span>)),
(
<span class="string">&quot;125%2*return&quot;</span>,
Action::new(Task::Return(<span class="prelude-val">None</span>), <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>)),
),
(
<span class="string">&quot;return(2%5)&quot;</span>,
Action::new(Task::Return(<span class="prelude-val">Some</span>(<span class="string">&quot;2%5&quot;</span>.to_owned())), <span class="number">1.0</span>, <span class="prelude-val">None</span>),
),
(<span class="string">&quot;125%2*off&quot;</span>, Action::new(Task::Off, <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>))),
(
<span class="string">&quot;125%2*sleep(100)&quot;</span>,
Action::new(Task::Sleep(<span class="number">100</span>), <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>)),
),
(<span class="string">&quot; 125%2*off &quot;</span>, Action::new(Task::Off, <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>))),
(<span class="string">&quot;125%2*panic&quot;</span>, Action::new(Task::Panic(<span class="prelude-val">None</span>), <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>))),
(
<span class="string">&quot;125%2*panic(msg)&quot;</span>,
Action::new(Task::Panic(<span class="prelude-val">Some</span>(<span class="string">&quot;msg&quot;</span>.to_owned())), <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>)),
),
(<span class="string">&quot;125%2*print&quot;</span>, Action::new(Task::Print(<span class="prelude-val">None</span>), <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>))),
(
<span class="string">&quot;125%2*print(msg)&quot;</span>,
Action::new(Task::Print(<span class="prelude-val">Some</span>(<span class="string">&quot;msg&quot;</span>.to_owned())), <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>)),
),
(<span class="string">&quot;125%2*pause&quot;</span>, Action::new(Task::Pause, <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>))),
(<span class="string">&quot;125%2*yield&quot;</span>, Action::new(Task::Yield, <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>))),
(<span class="string">&quot;125%2*delay(2)&quot;</span>, Action::new(Task::Delay(<span class="number">2</span>), <span class="number">1.25</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>))),
];
<span class="kw">for </span>(expr, exp) <span class="kw">in </span>cases {
<span class="kw">let </span>res: Action = expr.parse().unwrap();
<span class="macro">assert_eq!</span>(res, exp);
}
<span class="kw">let </span>fail_cases = <span class="macro">vec!</span>[
<span class="string">&quot;delay&quot;</span>,
<span class="string">&quot;sleep&quot;</span>,
<span class="string">&quot;Return&quot;</span>,
<span class="string">&quot;ab%return&quot;</span>,
<span class="string">&quot;ab*return&quot;</span>,
<span class="string">&quot;return(msg&quot;</span>,
<span class="string">&quot;unknown&quot;</span>,
];
<span class="kw">for </span>case <span class="kw">in </span>fail_cases {
<span class="macro">assert!</span>(case.parse::&lt;Action&gt;().is_err());
}
}
<span class="comment">// This case should be tested as integration case, but when calling `teardown` other cases
// like `test_pause` maybe also affected, so it&#39;s better keep it here.
</span><span class="attribute">#[test]
#[cfg_attr(not(feature = <span class="string">&quot;failpoints&quot;</span>), ignore)]
</span><span class="kw">fn </span>test_setup_and_teardown() {
<span class="kw">let </span>f1 = || {
<span class="macro">fail_point!</span>(<span class="string">&quot;setup_and_teardown1&quot;</span>, |<span class="kw">_</span>| <span class="number">1</span>);
<span class="number">0
</span>};
<span class="kw">let </span>f2 = || {
<span class="macro">fail_point!</span>(<span class="string">&quot;setup_and_teardown2&quot;</span>, |<span class="kw">_</span>| <span class="number">2</span>);
<span class="number">0
</span>};
env::set_var(
<span class="string">&quot;FAILPOINTS&quot;</span>,
<span class="string">&quot;setup_and_teardown1=return;setup_and_teardown2=pause;&quot;</span>,
);
<span class="kw">let </span>scenario = FailScenario::setup();
<span class="macro">assert_eq!</span>(f1(), <span class="number">1</span>);
<span class="kw">let </span>(tx, rx) = mpsc::channel();
thread::spawn(<span class="kw">move </span>|| {
tx.send(f2()).unwrap();
});
<span class="macro">assert!</span>(rx.recv_timeout(Duration::from_millis(<span class="number">500</span>)).is_err());
scenario.teardown();
<span class="macro">assert_eq!</span>(rx.recv_timeout(Duration::from_millis(<span class="number">500</span>)).unwrap(), <span class="number">0</span>);
<span class="macro">assert_eq!</span>(f1(), <span class="number">0</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="fail" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>