diff options
Diffstat (limited to 'src/log/lib.rs.html')
| -rw-r--r-- | src/log/lib.rs.html | 1643 |
1 files changed, 1643 insertions, 0 deletions
diff --git a/src/log/lib.rs.html b/src/log/lib.rs.html new file mode 100644 index 0000000..78cbf86 --- /dev/null +++ b/src/log/lib.rs.html @@ -0,0 +1,1643 @@ +<!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 to the Rust file `/home/travis/.cargo/registry/src/github.com-0a35038f75765ae4/log-0.3.1/src/lib.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>lib.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../main.css"> + + <link rel="shortcut icon" href="http://www.rust-lang.org/favicon.ico"> + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <section class="sidebar"> + <a href='../../log/index.html'><img src='http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='' width='100'></a> + + </section> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press 'S' to search, '?' for more options..." + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><pre class="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> +</pre><pre class='rust '> +<span class='comment'>// Copyright 2015 The Rust Project Developers. See the COPYRIGHT</span> +<span class='comment'>// file at the top-level directory of this distribution and at</span> +<span class='comment'>// http://rust-lang.org/COPYRIGHT.</span> +<span class='comment'>//</span> +<span class='comment'>// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span> +<span class='comment'>// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span> +<span class='comment'>// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span> +<span class='comment'>// option. This file may not be copied, modified, or distributed</span> +<span class='comment'>// except according to those terms.</span> + +<span class='doccomment'>//! A lightweight logging facade.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! A logging facade provides a single logging API that abstracts over the</span> +<span class='doccomment'>//! actual logging implementation. Libraries can use the logging API provided</span> +<span class='doccomment'>//! by this crate, and the consumer of those libraries can choose the logging</span> +<span class='doccomment'>//! framework that is most suitable for its use case.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! If no logging implementation is selected, the facade falls back to a "noop"</span> +<span class='doccomment'>//! implementation that ignores all log messages. The overhead in this case</span> +<span class='doccomment'>//! is very small - just an integer load, comparison and jump.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! A log request consists of a target, a level, and a body. A target is a</span> +<span class='doccomment'>//! string which defaults to the module path of the location of the log</span> +<span class='doccomment'>//! request, though that default may be overridden. Logger implementations</span> +<span class='doccomment'>//! typically use the target to filter requests based on some user</span> +<span class='doccomment'>//! configuration.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! # Use</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ## In libraries</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Libraries should link only to the `log` crate, and use the provided</span> +<span class='doccomment'>//! macros to log whatever information will be useful to downstream consumers.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ### Examples</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ```rust</span> +<span class='doccomment'>//! # #![allow(unstable)]</span> +<span class='doccomment'>//! #[macro_use]</span> +<span class='doccomment'>//! extern crate log;</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! # #[derive(Debug)] pub struct Yak(String);</span> +<span class='doccomment'>//! # impl Yak { fn shave(&self, _: u32) {} }</span> +<span class='doccomment'>//! # fn find_a_razor() -> Result<u32, u32> { Ok(1) }</span> +<span class='doccomment'>//! pub fn shave_the_yak(yak: &Yak) {</span> +<span class='doccomment'>//! info!(target: "yak_events", "Commencing yak shaving for {:?}", yak);</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! loop {</span> +<span class='doccomment'>//! match find_a_razor() {</span> +<span class='doccomment'>//! Ok(razor) => {</span> +<span class='doccomment'>//! info!("Razor located: {}", razor);</span> +<span class='doccomment'>//! yak.shave(razor);</span> +<span class='doccomment'>//! break;</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//! Err(err) => {</span> +<span class='doccomment'>//! warn!("Unable to locate a razor: {}, retrying", err);</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//! # fn main() {}</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ## In executables</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Executables should chose a logging framework and initialize it early in the</span> +<span class='doccomment'>//! runtime of the program. Logging frameworks will typically include a</span> +<span class='doccomment'>//! function to do this. Any log messages generated before the framework is</span> +<span class='doccomment'>//! initialized will be ignored.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! The executable itself may use the `log` crate to log as well.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ### Warning</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! The logging system may only be initialized once.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ### Examples</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ```rust,ignore</span> +<span class='doccomment'>//! #[macro_use]</span> +<span class='doccomment'>//! extern crate log;</span> +<span class='doccomment'>//! extern crate my_logger;</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! fn main() {</span> +<span class='doccomment'>//! my_logger::init();</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! info!("starting up");</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! // ...</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! # Logger implementations</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Loggers implement the `Log` trait. Here's a very basic example that simply</span> +<span class='doccomment'>//! logs all messages at the `Error`, `Warn` or `Info` levels to stdout:</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ```rust</span> +<span class='doccomment'>//! extern crate log;</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! use log::{LogRecord, LogLevel, LogMetadata};</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! struct SimpleLogger;</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! impl log::Log for SimpleLogger {</span> +<span class='doccomment'>//! fn enabled(&self, metadata: &LogMetadata) -> bool {</span> +<span class='doccomment'>//! metadata.level() <= LogLevel::Info</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! fn log(&self, record: &LogRecord) {</span> +<span class='doccomment'>//! if self.enabled(record.metadata()) {</span> +<span class='doccomment'>//! println!("{} - {}", record.level(), record.args());</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! # fn main() {}</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Loggers are installed by calling the `set_logger` function. It takes a</span> +<span class='doccomment'>//! closure which is provided a `MaxLogLevel` token and returns a `Log` trait</span> +<span class='doccomment'>//! object. The `MaxLogLevel` token controls the global maximum log level. The</span> +<span class='doccomment'>//! logging facade uses this as an optimization to improve performance of log</span> +<span class='doccomment'>//! messages at levels that are disabled. In the case of our example logger,</span> +<span class='doccomment'>//! we'll want to set the maximum log level to `Info`, since we ignore any</span> +<span class='doccomment'>//! `Debug` or `Trace` level log messages. A logging framework should provide a</span> +<span class='doccomment'>//! function that wraps a call to `set_logger`, handling initialization of the</span> +<span class='doccomment'>//! logger:</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ```rust</span> +<span class='doccomment'>//! # extern crate log;</span> +<span class='doccomment'>//! # use log::{LogLevel, LogLevelFilter, SetLoggerError, LogMetadata};</span> +<span class='doccomment'>//! # struct SimpleLogger;</span> +<span class='doccomment'>//! # impl log::Log for SimpleLogger {</span> +<span class='doccomment'>//! # fn enabled(&self, _: &LogMetadata) -> bool { false }</span> +<span class='doccomment'>//! # fn log(&self, _: &log::LogRecord) {}</span> +<span class='doccomment'>//! # }</span> +<span class='doccomment'>//! # fn main() {}</span> +<span class='doccomment'>//! pub fn init() -> Result<(), SetLoggerError> {</span> +<span class='doccomment'>//! log::set_logger(|max_log_level| {</span> +<span class='doccomment'>//! max_log_level.set(LogLevelFilter::Info);</span> +<span class='doccomment'>//! Box::new(SimpleLogger)</span> +<span class='doccomment'>//! })</span> +<span class='doccomment'>//! }</span> +<span class='doccomment'>//! ```</span> + +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>doc</span>(<span class='ident'>html_logo_url</span> <span class='op'>=</span> <span class='string'>"http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png"</span>, + <span class='ident'>html_favicon_url</span> <span class='op'>=</span> <span class='string'>"http://www.rust-lang.org/favicon.ico"</span>, + <span class='ident'>html_root_url</span> <span class='op'>=</span> <span class='string'>"http://doc.rust-lang.org/log/"</span>)]</span> +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>warn</span>(<span class='ident'>missing_docs</span>)]</span> + +<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>libc</span>; + +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ascii</span>::<span class='ident'>AsciiExt</span>; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>cmp</span>; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>error</span>; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>fmt</span>; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>mem</span>; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>Deref</span>; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>str</span>::<span class='ident'>FromStr</span>; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::<span class='ident'>atomic</span>::{<span class='ident'>AtomicUsize</span>, <span class='ident'>ATOMIC_USIZE_INIT</span>, <span class='ident'>Ordering</span>}; +<span class='kw'>mod</span> <span class='ident'>macros</span>; + +<span class='comment'>// The setup here is a bit weird to make at_exit work.</span> +<span class='comment'>//</span> +<span class='comment'>// There are four different states that we care about: the logger's</span> +<span class='comment'>// uninitialized, the logger's initializing (set_logger's been called but</span> +<span class='comment'>// LOGGER hasn't actually been set yet), the logger's active, or the logger's</span> +<span class='comment'>// shutting down inside of at_exit.</span> +<span class='comment'>//</span> +<span class='comment'>// The LOGGER static is normally a Box<Box<Log>> with some special possible</span> +<span class='comment'>// values as well. The uninitialized and initializing states are represented by</span> +<span class='comment'>// the values 0 and 1 respectively. The shutting down state is also represented</span> +<span class='comment'>// by 1. Any other value is a valid pointer to the logger.</span> +<span class='comment'>//</span> +<span class='comment'>// The at_exit routine needs to make sure that no threads are actively logging</span> +<span class='comment'>// when it deallocates the logger. The number of actively logging threads is</span> +<span class='comment'>// tracked in the REFCOUNT static. The routine first sets LOGGER back to 1.</span> +<span class='comment'>// All logging calls past that point will immediately return without accessing</span> +<span class='comment'>// the logger. At that point, the at_exit routine just waits for the refcount</span> +<span class='comment'>// to reach 0 before deallocating the logger. Note that the refcount does not</span> +<span class='comment'>// necessarily monotonically decrease at this point, as new log calls still</span> +<span class='comment'>// increment and decrement it, but the interval in between is small enough that</span> +<span class='comment'>// the wait is really just for the active log calls to finish.</span> +<span class='kw'>static</span> <span class='ident'>LOGGER</span>: <span class='ident'>AtomicUsize</span> <span class='op'>=</span> <span class='ident'>ATOMIC_USIZE_INIT</span>; +<span class='kw'>static</span> <span class='ident'>REFCOUNT</span>: <span class='ident'>AtomicUsize</span> <span class='op'>=</span> <span class='ident'>ATOMIC_USIZE_INIT</span>; + +<span class='kw'>const</span> <span class='ident'>UNINITIALIZED</span>: <span class='ident'>usize</span> <span class='op'>=</span> <span class='number'>0</span>; +<span class='kw'>const</span> <span class='ident'>INITIALIZING</span>: <span class='ident'>usize</span> <span class='op'>=</span> <span class='number'>1</span>; + +<span class='kw'>static</span> <span class='ident'>MAX_LOG_LEVEL_FILTER</span>: <span class='ident'>AtomicUsize</span> <span class='op'>=</span> <span class='ident'>ATOMIC_USIZE_INIT</span>; + +<span class='kw'>static</span> <span class='ident'>LOG_LEVEL_NAMES</span>: [<span class='kw-2'>&</span><span class='lifetime'>'static</span> <span class='ident'>str</span>; <span class='number'>6</span>] <span class='op'>=</span> [<span class='string'>"OFF"</span>, <span class='string'>"ERROR"</span>, <span class='string'>"WARN"</span>, <span class='string'>"INFO"</span>, + <span class='string'>"DEBUG"</span>, <span class='string'>"TRACE"</span>]; + +<span class='doccomment'>/// An enum representing the available verbosity levels of the logging framework</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// A `LogLevel` may be compared directly to a `LogLevelFilter`.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>usize</span>)]</span> +<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Copy</span>, <span class='ident'>Eq</span>, <span class='ident'>Debug</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>LogLevel</span> { + <span class='doccomment'>/// The "error" level.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Designates very serious errors.</span> + <span class='ident'>Error</span> <span class='op'>=</span> <span class='number'>1</span>, <span class='comment'>// This way these line up with the discriminants for LogLevelFilter below</span> + <span class='doccomment'>/// The "warn" level.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Designates hazardous situations.</span> + <span class='ident'>Warn</span>, + <span class='doccomment'>/// The "info" level.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Designates useful information.</span> + <span class='ident'>Info</span>, + <span class='doccomment'>/// The "debug" level.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Designates lower priority information.</span> + <span class='ident'>Debug</span>, + <span class='doccomment'>/// The "trace" level.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Designates very low priority, often extremely verbose, information.</span> + <span class='ident'>Trace</span>, +} + +<span class='kw'>impl</span> <span class='ident'>Clone</span> <span class='kw'>for</span> <span class='ident'>LogLevel</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>clone</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>LogLevel</span> { + <span class='op'>*</span><span class='self'>self</span> + } +} + +<span class='kw'>impl</span> <span class='ident'>PartialEq</span> <span class='kw'>for</span> <span class='ident'>LogLevel</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>eq</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>LogLevel</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>usize</span> <span class='op'>==</span> <span class='op'>*</span><span class='ident'>other</span> <span class='kw'>as</span> <span class='ident'>usize</span> + } +} + +<span class='kw'>impl</span> <span class='ident'>PartialEq</span><span class='op'><</span><span class='ident'>LogLevelFilter</span><span class='op'>></span> <span class='kw'>for</span> <span class='ident'>LogLevel</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>eq</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>LogLevelFilter</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>usize</span> <span class='op'>==</span> <span class='op'>*</span><span class='ident'>other</span> <span class='kw'>as</span> <span class='ident'>usize</span> + } +} + +<span class='kw'>impl</span> <span class='ident'>PartialOrd</span> <span class='kw'>for</span> <span class='ident'>LogLevel</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>partial_cmp</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>LogLevel</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>cmp</span>::<span class='ident'>Ordering</span><span class='op'>></span> { + <span class='prelude-val'>Some</span>(<span class='self'>self</span>.<span class='ident'>cmp</span>(<span class='ident'>other</span>)) + } +} + +<span class='kw'>impl</span> <span class='ident'>PartialOrd</span><span class='op'><</span><span class='ident'>LogLevelFilter</span><span class='op'>></span> <span class='kw'>for</span> <span class='ident'>LogLevel</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>partial_cmp</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>LogLevelFilter</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>cmp</span>::<span class='ident'>Ordering</span><span class='op'>></span> { + <span class='prelude-val'>Some</span>((<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>usize</span>).<span class='ident'>cmp</span>(<span class='kw-2'>&</span>(<span class='op'>*</span><span class='ident'>other</span> <span class='kw'>as</span> <span class='ident'>usize</span>))) + } +} + +<span class='kw'>impl</span> <span class='ident'>Ord</span> <span class='kw'>for</span> <span class='ident'>LogLevel</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>cmp</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>LogLevel</span>) <span class='op'>-></span> <span class='ident'>cmp</span>::<span class='ident'>Ordering</span> { + (<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>usize</span>).<span class='ident'>cmp</span>(<span class='kw-2'>&</span>(<span class='op'>*</span><span class='ident'>other</span> <span class='kw'>as</span> <span class='ident'>usize</span>)) + } +} + +<span class='kw'>fn</span> <span class='ident'>ok_or</span><span class='op'><</span><span class='ident'>T</span>, <span class='ident'>E</span><span class='op'>></span>(<span class='ident'>t</span>: <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span>, <span class='ident'>e</span>: <span class='ident'>E</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>T</span>, <span class='ident'>E</span><span class='op'>></span> { + <span class='kw'>match</span> <span class='ident'>t</span> { + <span class='prelude-val'>Some</span>(<span class='ident'>t</span>) <span class='op'>=></span> <span class='prelude-val'>Ok</span>(<span class='ident'>t</span>), + <span class='prelude-val'>None</span> <span class='op'>=></span> <span class='prelude-val'>Err</span>(<span class='ident'>e</span>), + } +} + +<span class='kw'>impl</span> <span class='ident'>FromStr</span> <span class='kw'>for</span> <span class='ident'>LogLevel</span> { + <span class='kw'>type</span> <span class='prelude-val'>Err</span> <span class='op'>=</span> (); + <span class='kw'>fn</span> <span class='ident'>from_str</span>(<span class='ident'>level</span>: <span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>LogLevel</span>, ()<span class='op'>></span> { + <span class='ident'>ok_or</span>(<span class='ident'>LOG_LEVEL_NAMES</span>.<span class='ident'>iter</span>() + .<span class='ident'>position</span>(<span class='op'>|</span><span class='kw-2'>&</span><span class='ident'>name</span><span class='op'>|</span> <span class='ident'>name</span>.<span class='ident'>eq_ignore_ascii_case</span>(<span class='ident'>level</span>)) + .<span class='ident'>into_iter</span>() + .<span class='ident'>filter</span>(<span class='op'>|</span><span class='kw-2'>&</span><span class='ident'>idx</span><span class='op'>|</span> <span class='ident'>idx</span> <span class='op'>!=</span> <span class='number'>0</span>) + .<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>idx</span><span class='op'>|</span> <span class='ident'>LogLevel</span>::<span class='ident'>from_usize</span>(<span class='ident'>idx</span>).<span class='ident'>unwrap</span>()) + .<span class='ident'>next</span>(), ()) + } +} + +<span class='kw'>impl</span> <span class='ident'>fmt</span>::<span class='ident'>Display</span> <span class='kw'>for</span> <span class='ident'>LogLevel</span> { + <span class='kw'>fn</span> <span class='ident'>fmt</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>fmt</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>fmt</span>::<span class='ident'>Formatter</span>) <span class='op'>-></span> <span class='ident'>fmt</span>::<span class='prelude-ty'>Result</span> { + <span class='ident'>fmt</span>.<span class='ident'>pad</span>(<span class='ident'>LOG_LEVEL_NAMES</span>[<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>usize</span>]) + } +} + +<span class='kw'>impl</span> <span class='ident'>LogLevel</span> { + <span class='kw'>fn</span> <span class='ident'>from_usize</span>(<span class='ident'>u</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>LogLevel</span><span class='op'>></span> { + <span class='kw'>match</span> <span class='ident'>u</span> { + <span class='number'>1</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Error</span>), + <span class='number'>2</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Warn</span>), + <span class='number'>3</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Info</span>), + <span class='number'>4</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Debug</span>), + <span class='number'>5</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Trace</span>), + _ <span class='op'>=></span> <span class='prelude-val'>None</span> + } + } + + <span class='doccomment'>/// Returns the most verbose logging level.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>max</span>() <span class='op'>-></span> <span class='ident'>LogLevel</span> { + <span class='ident'>LogLevel</span>::<span class='ident'>Trace</span> + } + + <span class='doccomment'>/// Converts the `LogLevel` to the equivalent `LogLevelFilter`.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>to_log_level_filter</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>LogLevelFilter</span> { + <span class='ident'>LogLevelFilter</span>::<span class='ident'>from_usize</span>(<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>usize</span>).<span class='ident'>unwrap</span>() + } +} + +<span class='doccomment'>/// An enum representing the available verbosity level filters of the logging</span> +<span class='doccomment'>/// framework.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// A `LogLevelFilter` may be compared directly to a `LogLevel`.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>usize</span>)]</span> +<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Copy</span>, <span class='ident'>Eq</span>, <span class='ident'>Debug</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>LogLevelFilter</span> { + <span class='doccomment'>/// A level lower than all log levels.</span> + <span class='ident'>Off</span>, + <span class='doccomment'>/// Corresponds to the `Error` log level.</span> + <span class='ident'>Error</span>, + <span class='doccomment'>/// Corresponds to the `Warn` log level.</span> + <span class='ident'>Warn</span>, + <span class='doccomment'>/// Corresponds to the `Trace` log level.</span> + <span class='ident'>Info</span>, + <span class='doccomment'>/// Corresponds to the `Debug` log level.</span> + <span class='ident'>Debug</span>, + <span class='doccomment'>/// Corresponds to the `Trace` log level.</span> + <span class='ident'>Trace</span>, +} + +<span class='comment'>// Deriving generates terrible impls of these traits</span> + +<span class='kw'>impl</span> <span class='ident'>Clone</span> <span class='kw'>for</span> <span class='ident'>LogLevelFilter</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>clone</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>LogLevelFilter</span> { + <span class='op'>*</span><span class='self'>self</span> + } +} + +<span class='kw'>impl</span> <span class='ident'>PartialEq</span> <span class='kw'>for</span> <span class='ident'>LogLevelFilter</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>eq</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>LogLevelFilter</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>usize</span> <span class='op'>==</span> <span class='op'>*</span><span class='ident'>other</span> <span class='kw'>as</span> <span class='ident'>usize</span> + } +} + +<span class='kw'>impl</span> <span class='ident'>PartialEq</span><span class='op'><</span><span class='ident'>LogLevel</span><span class='op'>></span> <span class='kw'>for</span> <span class='ident'>LogLevelFilter</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>eq</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>LogLevel</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='ident'>other</span>.<span class='ident'>eq</span>(<span class='self'>self</span>) + } +} + +<span class='kw'>impl</span> <span class='ident'>PartialOrd</span> <span class='kw'>for</span> <span class='ident'>LogLevelFilter</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>partial_cmp</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>LogLevelFilter</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>cmp</span>::<span class='ident'>Ordering</span><span class='op'>></span> { + <span class='prelude-val'>Some</span>(<span class='self'>self</span>.<span class='ident'>cmp</span>(<span class='ident'>other</span>)) + } +} + +<span class='kw'>impl</span> <span class='ident'>PartialOrd</span><span class='op'><</span><span class='ident'>LogLevel</span><span class='op'>></span> <span class='kw'>for</span> <span class='ident'>LogLevelFilter</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>partial_cmp</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>LogLevel</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>cmp</span>::<span class='ident'>Ordering</span><span class='op'>></span> { + <span class='ident'>other</span>.<span class='ident'>partial_cmp</span>(<span class='self'>self</span>).<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>x</span><span class='op'>|</span> <span class='ident'>x</span>.<span class='ident'>reverse</span>()) + } +} + +<span class='kw'>impl</span> <span class='ident'>Ord</span> <span class='kw'>for</span> <span class='ident'>LogLevelFilter</span> { + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>cmp</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>LogLevelFilter</span>) <span class='op'>-></span> <span class='ident'>cmp</span>::<span class='ident'>Ordering</span> { + (<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>usize</span>).<span class='ident'>cmp</span>(<span class='kw-2'>&</span>(<span class='op'>*</span><span class='ident'>other</span> <span class='kw'>as</span> <span class='ident'>usize</span>)) + } +} + +<span class='kw'>impl</span> <span class='ident'>FromStr</span> <span class='kw'>for</span> <span class='ident'>LogLevelFilter</span> { + <span class='kw'>type</span> <span class='prelude-val'>Err</span> <span class='op'>=</span> (); + <span class='kw'>fn</span> <span class='ident'>from_str</span>(<span class='ident'>level</span>: <span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>LogLevelFilter</span>, ()<span class='op'>></span> { + <span class='ident'>ok_or</span>(<span class='ident'>LOG_LEVEL_NAMES</span>.<span class='ident'>iter</span>() + .<span class='ident'>position</span>(<span class='op'>|</span><span class='kw-2'>&</span><span class='ident'>name</span><span class='op'>|</span> <span class='ident'>name</span>.<span class='ident'>eq_ignore_ascii_case</span>(<span class='ident'>level</span>)) + .<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>p</span><span class='op'>|</span> <span class='ident'>LogLevelFilter</span>::<span class='ident'>from_usize</span>(<span class='ident'>p</span>).<span class='ident'>unwrap</span>()), ()) + } +} + +<span class='kw'>impl</span> <span class='ident'>fmt</span>::<span class='ident'>Display</span> <span class='kw'>for</span> <span class='ident'>LogLevelFilter</span> { + <span class='kw'>fn</span> <span class='ident'>fmt</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>fmt</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>fmt</span>::<span class='ident'>Formatter</span>) <span class='op'>-></span> <span class='ident'>fmt</span>::<span class='prelude-ty'>Result</span> { + <span class='macro'>write</span><span class='macro'>!</span>(<span class='ident'>fmt</span>, <span class='string'>"{}"</span>, <span class='ident'>LOG_LEVEL_NAMES</span>[<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>usize</span>]) + } +} + +<span class='kw'>impl</span> <span class='ident'>LogLevelFilter</span> { + <span class='kw'>fn</span> <span class='ident'>from_usize</span>(<span class='ident'>u</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>LogLevelFilter</span><span class='op'>></span> { + <span class='kw'>match</span> <span class='ident'>u</span> { + <span class='number'>0</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Off</span>), + <span class='number'>1</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Error</span>), + <span class='number'>2</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Warn</span>), + <span class='number'>3</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Info</span>), + <span class='number'>4</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Debug</span>), + <span class='number'>5</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Trace</span>), + _ <span class='op'>=></span> <span class='prelude-val'>None</span> + } + } + <span class='doccomment'>/// Returns the most verbose logging level filter.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>max</span>() <span class='op'>-></span> <span class='ident'>LogLevelFilter</span> { + <span class='ident'>LogLevelFilter</span>::<span class='ident'>Trace</span> + } + + <span class='doccomment'>/// Converts `self` to the equivalent `LogLevel`.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Returns `None` if `self` is `LogLevelFilter::Off`.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>to_log_level</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>LogLevel</span><span class='op'>></span> { + <span class='ident'>LogLevel</span>::<span class='ident'>from_usize</span>(<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>usize</span>) + } +} + +<span class='doccomment'>/// The "payload" of a log message.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>LogRecord</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> { + <span class='ident'>metadata</span>: <span class='ident'>LogMetadata</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span>, + <span class='ident'>location</span>: <span class='kw-2'>&</span><span class='lifetime'>'a</span> <span class='ident'>LogLocation</span>, + <span class='ident'>args</span>: <span class='ident'>fmt</span>::<span class='ident'>Arguments</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span>, +} + +<span class='kw'>impl</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> <span class='ident'>LogRecord</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> { + <span class='doccomment'>/// The message body.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>args</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>fmt</span>::<span class='ident'>Arguments</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> { + <span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>args</span> + } + + <span class='doccomment'>/// Metadata about the log directive.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>metadata</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>LogMetadata</span> { + <span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>metadata</span> + } + + <span class='doccomment'>/// The location of the log directive.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>location</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>LogLocation</span> { + <span class='self'>self</span>.<span class='ident'>location</span> + } + + <span class='doccomment'>/// The verbosity level of the message.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>level</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>LogLevel</span> { + <span class='self'>self</span>.<span class='ident'>metadata</span>.<span class='ident'>level</span>() + } + + <span class='doccomment'>/// The name of the target of the directive.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>target</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>str</span> { + <span class='self'>self</span>.<span class='ident'>metadata</span>.<span class='ident'>target</span>() + } +} + +<span class='doccomment'>/// Metadata about a log message.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>LogMetadata</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> { + <span class='ident'>level</span>: <span class='ident'>LogLevel</span>, + <span class='ident'>target</span>: <span class='kw-2'>&</span><span class='lifetime'>'a</span> <span class='ident'>str</span>, +} + +<span class='kw'>impl</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> <span class='ident'>LogMetadata</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> { + <span class='doccomment'>/// The verbosity level of the message.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>level</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>LogLevel</span> { + <span class='self'>self</span>.<span class='ident'>level</span> + } + + <span class='doccomment'>/// The name of the target of the directive.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>target</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>str</span> { + <span class='self'>self</span>.<span class='ident'>target</span> + } +} + +<span class='doccomment'>/// A trait encapsulating the operations required of a logger</span> +<span class='kw'>pub</span> <span class='kw'>trait</span> <span class='ident'>Log</span>: <span class='ident'>Sync</span><span class='op'>+</span><span class='ident'>Send</span> { + <span class='doccomment'>/// Determines if a log message with the specified metadata would be</span> + <span class='doccomment'>/// logged.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// This is used by the `log_enabled!` macro to allow callers to avoid</span> + <span class='doccomment'>/// expensive computation of log message arguments if the message would be</span> + <span class='doccomment'>/// discarded anyway.</span> + <span class='kw'>fn</span> <span class='ident'>enabled</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>metadata</span>: <span class='kw-2'>&</span><span class='ident'>LogMetadata</span>) <span class='op'>-></span> <span class='ident'>bool</span>; + + <span class='doccomment'>/// Logs the `LogRecord`.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Note that `enabled` is *not* necessarily called before this method.</span> + <span class='doccomment'>/// Implementations of `log` should perform all necessary filtering</span> + <span class='doccomment'>/// internally.</span> + <span class='kw'>fn</span> <span class='ident'>log</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>record</span>: <span class='kw-2'>&</span><span class='ident'>LogRecord</span>); +} + +<span class='doccomment'>/// The location of a log message.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Warning</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// The fields of this struct are public so that they may be initialized by the</span> +<span class='doccomment'>/// `log!` macro. They are subject to change at any time and should never be</span> +<span class='doccomment'>/// accessed directly.</span> +<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Copy</span>, <span class='ident'>Clone</span>, <span class='ident'>Debug</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>LogLocation</span> { + <span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> + <span class='kw'>pub</span> <span class='ident'>__module_path</span>: <span class='kw-2'>&</span><span class='lifetime'>'static</span> <span class='ident'>str</span>, + <span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> + <span class='kw'>pub</span> <span class='ident'>__file</span>: <span class='kw-2'>&</span><span class='lifetime'>'static</span> <span class='ident'>str</span>, + <span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> + <span class='kw'>pub</span> <span class='ident'>__line</span>: <span class='ident'>u32</span>, +} + +<span class='kw'>impl</span> <span class='ident'>LogLocation</span> { + <span class='doccomment'>/// The module path of the message.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>module_path</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>str</span> { + <span class='self'>self</span>.<span class='ident'>__module_path</span> + } + + <span class='doccomment'>/// The source file containing the message.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>file</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>str</span> { + <span class='self'>self</span>.<span class='ident'>__file</span> + } + + <span class='doccomment'>/// The line containing the message.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>line</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>u32</span> { + <span class='self'>self</span>.<span class='ident'>__line</span> + } +} + +<span class='doccomment'>/// A token providing read and write access to the global maximum log level</span> +<span class='doccomment'>/// filter.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// The maximum log level is used as an optimization to avoid evaluating log</span> +<span class='doccomment'>/// messages that will be ignored by the logger. Any message with a level</span> +<span class='doccomment'>/// higher than the maximum log level filter will be ignored. A logger should</span> +<span class='doccomment'>/// make sure to keep the maximum log level filter in sync with its current</span> +<span class='doccomment'>/// configuration.</span> +<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>missing_copy_implementations</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>MaxLogLevelFilter</span>(()); + +<span class='kw'>impl</span> <span class='ident'>fmt</span>::<span class='ident'>Debug</span> <span class='kw'>for</span> <span class='ident'>MaxLogLevelFilter</span> { + <span class='kw'>fn</span> <span class='ident'>fmt</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>fmt</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>fmt</span>::<span class='ident'>Formatter</span>) <span class='op'>-></span> <span class='ident'>fmt</span>::<span class='prelude-ty'>Result</span> { + <span class='macro'>write</span><span class='macro'>!</span>(<span class='ident'>fmt</span>, <span class='string'>"MaxLogLevelFilter"</span>) + } +} + +<span class='kw'>impl</span> <span class='ident'>MaxLogLevelFilter</span> { + <span class='doccomment'>/// Gets the current maximum log level filter.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>get</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>LogLevelFilter</span> { + <span class='ident'>max_log_level</span>() + } + + <span class='doccomment'>/// Sets the maximum log level.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>set</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>level</span>: <span class='ident'>LogLevelFilter</span>) { + <span class='ident'>MAX_LOG_LEVEL_FILTER</span>.<span class='ident'>store</span>(<span class='ident'>level</span> <span class='kw'>as</span> <span class='ident'>usize</span>, <span class='ident'>Ordering</span>::<span class='ident'>SeqCst</span>) + } +} + +<span class='doccomment'>/// Returns the current maximum log level.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// The `log!`, `error!`, `warn!`, `info!`, `debug!`, and `trace!` macros check</span> +<span class='doccomment'>/// this value and discard any message logged at a higher level. The maximum</span> +<span class='doccomment'>/// log level is set by the `MaxLogLevel` token passed to loggers.</span> +<span class='attribute'>#[<span class='ident'>inline</span>(<span class='ident'>always</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>max_log_level</span>() <span class='op'>-></span> <span class='ident'>LogLevelFilter</span> { + <span class='kw'>unsafe</span> { <span class='ident'>mem</span>::<span class='ident'>transmute</span>(<span class='ident'>MAX_LOG_LEVEL_FILTER</span>.<span class='ident'>load</span>(<span class='ident'>Ordering</span>::<span class='ident'>Relaxed</span>)) } +} + +<span class='doccomment'>/// Sets the global logger.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// The `make_logger` closure is passed a `MaxLogLevel` object, which the</span> +<span class='doccomment'>/// logger should use to keep the global maximum log level in sync with the</span> +<span class='doccomment'>/// highest log level that the logger will not ignore.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// This function may only be called once in the lifetime of a program. Any log</span> +<span class='doccomment'>/// events that occur before the call to `set_logger` completes will be</span> +<span class='doccomment'>/// ignored.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// This function does not typically need to be called manually. Logger</span> +<span class='doccomment'>/// implementations should provide an initialization method that calls</span> +<span class='doccomment'>/// `set_logger` internally.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>set_logger</span><span class='op'><</span><span class='ident'>M</span><span class='op'>></span>(<span class='ident'>make_logger</span>: <span class='ident'>M</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span>(), <span class='ident'>SetLoggerError</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>M</span>: <span class='ident'>FnOnce</span>(<span class='ident'>MaxLogLevelFilter</span>) <span class='op'>-></span> <span class='ident'>Box</span><span class='op'><</span><span class='ident'>Log</span><span class='op'>></span> { + <span class='kw'>if</span> <span class='ident'>LOGGER</span>.<span class='ident'>compare_and_swap</span>(<span class='ident'>UNINITIALIZED</span>, <span class='ident'>INITIALIZING</span>, + <span class='ident'>Ordering</span>::<span class='ident'>SeqCst</span>) <span class='op'>!=</span> <span class='ident'>UNINITIALIZED</span> { + <span class='kw'>return</span> <span class='prelude-val'>Err</span>(<span class='ident'>SetLoggerError</span>(())); + } + + <span class='kw'>let</span> <span class='ident'>logger</span> <span class='op'>=</span> <span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='ident'>make_logger</span>(<span class='ident'>MaxLogLevelFilter</span>(()))); + <span class='kw'>let</span> <span class='ident'>logger</span> <span class='op'>=</span> <span class='kw'>unsafe</span> { <span class='ident'>mem</span>::<span class='ident'>transmute</span>::<span class='op'><</span><span class='ident'>Box</span><span class='op'><</span><span class='ident'>Box</span><span class='op'><</span><span class='ident'>Log</span><span class='op'>>></span>, <span class='ident'>usize</span><span class='op'>></span>(<span class='ident'>logger</span>) }; + <span class='ident'>LOGGER</span>.<span class='ident'>store</span>(<span class='ident'>logger</span>, <span class='ident'>Ordering</span>::<span class='ident'>SeqCst</span>); + + <span class='kw'>unsafe</span> { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>libc</span>::<span class='ident'>atexit</span>(<span class='ident'>shutdown</span>), <span class='number'>0</span>); + } + <span class='kw'>return</span> <span class='prelude-val'>Ok</span>(()); + + <span class='kw'>extern</span> <span class='kw'>fn</span> <span class='ident'>shutdown</span>() { + <span class='comment'>// Set to INITIALIZING to prevent re-initialization after</span> + <span class='kw'>let</span> <span class='ident'>logger</span> <span class='op'>=</span> <span class='ident'>LOGGER</span>.<span class='ident'>swap</span>(<span class='ident'>INITIALIZING</span>, <span class='ident'>Ordering</span>::<span class='ident'>SeqCst</span>); + + <span class='kw'>while</span> <span class='ident'>REFCOUNT</span>.<span class='ident'>load</span>(<span class='ident'>Ordering</span>::<span class='ident'>SeqCst</span>) <span class='op'>!=</span> <span class='number'>0</span> { + <span class='comment'>// FIXME add a sleep here when it doesn't involve timers</span> + } + + <span class='kw'>unsafe</span> { <span class='ident'>mem</span>::<span class='ident'>transmute</span>::<span class='op'><</span><span class='ident'>usize</span>, <span class='ident'>Box</span><span class='op'><</span><span class='ident'>Box</span><span class='op'><</span><span class='ident'>Log</span><span class='op'>>></span><span class='op'>></span>(<span class='ident'>logger</span>); } + } +} + +<span class='doccomment'>/// The type returned by `set_logger` if `set_logger` has already been called.</span> +<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>missing_copy_implementations</span>)]</span> +<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Debug</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>SetLoggerError</span>(()); + +<span class='kw'>impl</span> <span class='ident'>fmt</span>::<span class='ident'>Display</span> <span class='kw'>for</span> <span class='ident'>SetLoggerError</span> { + <span class='kw'>fn</span> <span class='ident'>fmt</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>fmt</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>fmt</span>::<span class='ident'>Formatter</span>) <span class='op'>-></span> <span class='ident'>fmt</span>::<span class='prelude-ty'>Result</span> { + <span class='macro'>write</span><span class='macro'>!</span>(<span class='ident'>fmt</span>, <span class='string'>"attempted to set a logger after the logging system \ + was already initialized"</span>) + } +} + +<span class='kw'>impl</span> <span class='ident'>error</span>::<span class='ident'>Error</span> <span class='kw'>for</span> <span class='ident'>SetLoggerError</span> { + <span class='kw'>fn</span> <span class='ident'>description</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>str</span> { <span class='string'>"set_logger() called multiple times"</span> } +} + +<span class='kw'>struct</span> <span class='ident'>LoggerGuard</span>(<span class='ident'>usize</span>); + +<span class='kw'>impl</span> <span class='ident'>Drop</span> <span class='kw'>for</span> <span class='ident'>LoggerGuard</span> { + <span class='kw'>fn</span> <span class='ident'>drop</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) { + <span class='ident'>REFCOUNT</span>.<span class='ident'>fetch_sub</span>(<span class='number'>1</span>, <span class='ident'>Ordering</span>::<span class='ident'>SeqCst</span>); + } +} + +<span class='kw'>impl</span> <span class='ident'>Deref</span> <span class='kw'>for</span> <span class='ident'>LoggerGuard</span> { + <span class='kw'>type</span> <span class='ident'>Target</span> <span class='op'>=</span> <span class='ident'>Box</span><span class='op'><</span><span class='ident'>Log</span><span class='op'>></span>; + + <span class='kw'>fn</span> <span class='ident'>deref</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>Box</span><span class='op'><</span><span class='ident'>Log</span><span class='op'>+</span><span class='lifetime'>'static</span><span class='op'>></span> { + <span class='kw'>unsafe</span> { <span class='ident'>mem</span>::<span class='ident'>transmute</span>(<span class='self'>self</span>.<span class='number'>0</span>) } + } +} + +<span class='kw'>fn</span> <span class='ident'>logger</span>() <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>LoggerGuard</span><span class='op'>></span> { + <span class='ident'>REFCOUNT</span>.<span class='ident'>fetch_add</span>(<span class='number'>1</span>, <span class='ident'>Ordering</span>::<span class='ident'>SeqCst</span>); + <span class='kw'>let</span> <span class='ident'>logger</span> <span class='op'>=</span> <span class='ident'>LOGGER</span>.<span class='ident'>load</span>(<span class='ident'>Ordering</span>::<span class='ident'>SeqCst</span>); + <span class='kw'>if</span> <span class='ident'>logger</span> <span class='op'>==</span> <span class='ident'>UNINITIALIZED</span> <span class='op'>||</span> <span class='ident'>logger</span> <span class='op'>==</span> <span class='ident'>INITIALIZING</span> { + <span class='ident'>REFCOUNT</span>.<span class='ident'>fetch_sub</span>(<span class='number'>1</span>, <span class='ident'>Ordering</span>::<span class='ident'>SeqCst</span>); + <span class='prelude-val'>None</span> + } <span class='kw'>else</span> { + <span class='prelude-val'>Some</span>(<span class='ident'>LoggerGuard</span>(<span class='ident'>logger</span>)) + } +} + +<span class='comment'>// WARNING</span> +<span class='comment'>// This is not considered part of the crate's public API. It is subject to</span> +<span class='comment'>// change at any time.</span> +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>__enabled</span>(<span class='ident'>level</span>: <span class='ident'>LogLevel</span>, <span class='ident'>target</span>: <span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>if</span> <span class='kw'>let</span> <span class='prelude-val'>Some</span>(<span class='ident'>logger</span>) <span class='op'>=</span> <span class='ident'>logger</span>() { + <span class='ident'>logger</span>.<span class='ident'>enabled</span>(<span class='kw-2'>&</span><span class='ident'>LogMetadata</span> { <span class='ident'>level</span>: <span class='ident'>level</span>, <span class='ident'>target</span>: <span class='ident'>target</span> }) + } <span class='kw'>else</span> { + <span class='boolval'>false</span> + } +} + +<span class='comment'>// WARNING</span> +<span class='comment'>// This is not considered part of the crate's public API. It is subject to</span> +<span class='comment'>// change at any time.</span> +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>__log</span>(<span class='ident'>level</span>: <span class='ident'>LogLevel</span>, <span class='ident'>target</span>: <span class='kw-2'>&</span><span class='ident'>str</span>, <span class='ident'>loc</span>: <span class='kw-2'>&</span><span class='ident'>LogLocation</span>, + <span class='ident'>args</span>: <span class='ident'>fmt</span>::<span class='ident'>Arguments</span>) { + <span class='kw'>if</span> <span class='kw'>let</span> <span class='prelude-val'>Some</span>(<span class='ident'>logger</span>) <span class='op'>=</span> <span class='ident'>logger</span>() { + <span class='kw'>let</span> <span class='ident'>record</span> <span class='op'>=</span> <span class='ident'>LogRecord</span> { + <span class='ident'>metadata</span>: <span class='ident'>LogMetadata</span> { + <span class='ident'>level</span>: <span class='ident'>level</span>, + <span class='ident'>target</span>: <span class='ident'>target</span>, + }, + <span class='ident'>location</span>: <span class='ident'>loc</span>, + <span class='ident'>args</span>: <span class='ident'>args</span> + }; + <span class='ident'>logger</span>.<span class='ident'>log</span>(<span class='kw-2'>&</span><span class='ident'>record</span>) + } +} + +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>mod</span> <span class='ident'>tests</span> { + <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>error</span>::<span class='ident'>Error</span>; + <span class='kw'>use</span> <span class='ident'>super</span>::{<span class='ident'>LogLevel</span>, <span class='ident'>LogLevelFilter</span>, <span class='ident'>SetLoggerError</span>}; + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_loglevelfilter_from_str</span>() { + <span class='kw'>let</span> <span class='ident'>tests</span> <span class='op'>=</span> [ + (<span class='string'>"off"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Off</span>)), + (<span class='string'>"error"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Error</span>)), + (<span class='string'>"warn"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Warn</span>)), + (<span class='string'>"info"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Info</span>)), + (<span class='string'>"debug"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Debug</span>)), + (<span class='string'>"trace"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Trace</span>)), + (<span class='string'>"OFF"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Off</span>)), + (<span class='string'>"ERROR"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Error</span>)), + (<span class='string'>"WARN"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Warn</span>)), + (<span class='string'>"INFO"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Info</span>)), + (<span class='string'>"DEBUG"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Debug</span>)), + (<span class='string'>"TRACE"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Trace</span>)), + (<span class='string'>"asdf"</span>, <span class='prelude-val'>Err</span>(())), + ]; + <span class='kw'>for</span> <span class='kw-2'>&</span>(<span class='ident'>s</span>, <span class='kw-2'>ref</span> <span class='ident'>expected</span>) <span class='kw'>in</span> <span class='kw-2'>&</span><span class='ident'>tests</span> { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>expected</span>, <span class='kw-2'>&</span><span class='ident'>s</span>.<span class='ident'>parse</span>()); + } + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_loglevel_from_str</span>() { + <span class='kw'>let</span> <span class='ident'>tests</span> <span class='op'>=</span> [ + (<span class='string'>"OFF"</span>, <span class='prelude-val'>Err</span>(())), + (<span class='string'>"error"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Error</span>)), + (<span class='string'>"warn"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Warn</span>)), + (<span class='string'>"info"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Info</span>)), + (<span class='string'>"debug"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Debug</span>)), + (<span class='string'>"trace"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Trace</span>)), + (<span class='string'>"ERROR"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Error</span>)), + (<span class='string'>"WARN"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Warn</span>)), + (<span class='string'>"INFO"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Info</span>)), + (<span class='string'>"DEBUG"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Debug</span>)), + (<span class='string'>"TRACE"</span>, <span class='prelude-val'>Ok</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Trace</span>)), + (<span class='string'>"asdf"</span>, <span class='prelude-val'>Err</span>(())), + ]; + <span class='kw'>for</span> <span class='kw-2'>&</span>(<span class='ident'>s</span>, <span class='kw-2'>ref</span> <span class='ident'>expected</span>) <span class='kw'>in</span> <span class='kw-2'>&</span><span class='ident'>tests</span> { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>expected</span>, <span class='kw-2'>&</span><span class='ident'>s</span>.<span class='ident'>parse</span>()); + } + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_loglevel_show</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>"INFO"</span>, <span class='ident'>LogLevel</span>::<span class='ident'>Info</span>.<span class='ident'>to_string</span>()); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>"ERROR"</span>, <span class='ident'>LogLevel</span>::<span class='ident'>Error</span>.<span class='ident'>to_string</span>()); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_loglevelfilter_show</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>"OFF"</span>, <span class='ident'>LogLevelFilter</span>::<span class='ident'>Off</span>.<span class='ident'>to_string</span>()); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>"ERROR"</span>, <span class='ident'>LogLevelFilter</span>::<span class='ident'>Error</span>.<span class='ident'>to_string</span>()); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_cross_cmp</span>() { + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Debug</span> <span class='op'>></span> <span class='ident'>LogLevelFilter</span>::<span class='ident'>Error</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Warn</span> <span class='op'><</span> <span class='ident'>LogLevel</span>::<span class='ident'>Trace</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Off</span> <span class='op'><</span> <span class='ident'>LogLevel</span>::<span class='ident'>Error</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_cross_eq</span>() { + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Error</span> <span class='op'>==</span> <span class='ident'>LogLevelFilter</span>::<span class='ident'>Error</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Off</span> <span class='op'>!=</span> <span class='ident'>LogLevel</span>::<span class='ident'>Error</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Trace</span> <span class='op'>==</span> <span class='ident'>LogLevelFilter</span>::<span class='ident'>Trace</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_to_log_level</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='prelude-val'>Some</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Error</span>), <span class='ident'>LogLevelFilter</span>::<span class='ident'>Error</span>.<span class='ident'>to_log_level</span>()); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='prelude-val'>None</span>, <span class='ident'>LogLevelFilter</span>::<span class='ident'>Off</span>.<span class='ident'>to_log_level</span>()); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='prelude-val'>Some</span>(<span class='ident'>LogLevel</span>::<span class='ident'>Debug</span>), <span class='ident'>LogLevelFilter</span>::<span class='ident'>Debug</span>.<span class='ident'>to_log_level</span>()); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_to_log_level_filter</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Error</span>, <span class='ident'>LogLevel</span>::<span class='ident'>Error</span>.<span class='ident'>to_log_level_filter</span>()); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>LogLevelFilter</span>::<span class='ident'>Trace</span>, <span class='ident'>LogLevel</span>::<span class='ident'>Trace</span>.<span class='ident'>to_log_level_filter</span>()); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_error_trait</span>() { + <span class='kw'>let</span> <span class='ident'>e</span> <span class='op'>=</span> <span class='ident'>SetLoggerError</span>(()); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>e</span>.<span class='ident'>description</span>(), <span class='string'>"set_logger() called multiple times"</span>); + } +} +</pre> +</section> + <section id='search' class="content hidden"></section> + + <section class="footer"></section> + + <div id="help" class="hidden"> + <div class="shortcuts"> + <h1>Keyboard shortcuts</h1> + <dl> + <dt>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</dd> + </dl> + </div> + <div class="infos"> + <h1>Search tricks</h1> + <p> + Prefix searches with a type followed by a colon (e.g. + <code>fn:</code>) to restrict the search to a given type. + </p> + <p> + Accepted types are: <code>fn</code>, <code>mod</code>, + <code>struct</code>, <code>enum</code>, + <code>trait</code>, <code>typedef</code> (or + <code>tdef</code>). + </p> + <p> + Search functions by type signature (e.g. + <code>vec -> usize</code>) + </p> + </div> + </div> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "log"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script async src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file |