Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / env_logger / fmt / writer / termcolor / extern_impl.rs.html
blob: 95430917c07d438378e98108203db14f2b688b2f [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/env_logger-0.7.1/src/fmt/writer/termcolor/extern_impl.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>extern_impl.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../../../normalize.css"><link rel="stylesheet" href="../../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../../../ayu.css" disabled><link rel="stylesheet" href="../../../../../dark.css" disabled><link rel="stylesheet" href="../../../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../../../storage.js"></script><script defer src="../../../../../source-script.js"></script><script defer src="../../../../../source-files.js"></script><script defer src="../../../../../main.js"></script><noscript><link rel="stylesheet" href="../../../../../noscript.css"></noscript><link rel="icon" href="https://www.rust-lang.org/static/images/favicon.ico"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../../../env_logger/index.html"><div class="logo-container">
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../../env_logger/index.html">
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::borrow::Cow;
<span class="kw">use </span>std::cell::RefCell;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::io::{<span class="self">self</span>, Write};
<span class="kw">use </span>std::rc::Rc;
<span class="kw">use </span>log::Level;
<span class="kw">use </span>termcolor::{<span class="self">self</span>, ColorChoice, ColorSpec, WriteColor};
<span class="kw">use </span><span class="kw">crate</span>::fmt::{Formatter, Target, WriteStyle};
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt::writer) <span class="kw">mod </span>glob {
<span class="kw">pub use super</span>::<span class="kw-2">*</span>;
}
<span class="kw">impl </span>Formatter {
<span class="doccomment">/// Begin a new [`Style`].
///
/// # Examples
///
/// Create a bold, red colored style and use it to print the log level:
///
/// ```
/// use std::io::Write;
/// use env_logger::fmt::Color;
///
/// let mut builder = env_logger::Builder::new();
///
/// builder.format(|buf, record| {
/// let mut level_style = buf.style();
///
/// level_style.set_color(Color::Red).set_bold(true);
///
/// writeln!(buf, &quot;{}: {}&quot;,
/// level_style.value(record.level()),
/// record.args())
/// });
/// ```
///
/// [`Style`]: struct.Style.html
</span><span class="kw">pub fn </span>style(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Style {
Style {
buf: <span class="self">self</span>.buf.clone(),
spec: ColorSpec::new(),
}
}
<span class="doccomment">/// Get the default [`Style`] for the given level.
///
/// The style can be used to print other values besides the level.
</span><span class="kw">pub fn </span>default_level_style(<span class="kw-2">&amp;</span><span class="self">self</span>, level: Level) -&gt; Style {
<span class="kw">let </span><span class="kw-2">mut </span>level_style = <span class="self">self</span>.style();
<span class="kw">match </span>level {
Level::Trace =&gt; level_style.set_color(Color::Black).set_intense(<span class="bool-val">true</span>),
Level::Debug =&gt; level_style.set_color(Color::White),
Level::Info =&gt; level_style.set_color(Color::Green),
Level::Warn =&gt; level_style.set_color(Color::Yellow),
Level::Error =&gt; level_style.set_color(Color::Red).set_bold(<span class="bool-val">true</span>),
};
level_style
}
<span class="doccomment">/// Get a printable [`Style`] for the given level.
///
/// The style can only be used to print the level.
</span><span class="kw">pub fn </span>default_styled_level(<span class="kw-2">&amp;</span><span class="self">self</span>, level: Level) -&gt; StyledValue&lt;<span class="lifetime">&#39;static</span>, Level&gt; {
<span class="self">self</span>.default_level_style(level).into_value(level)
}
}
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt::writer) <span class="kw">struct </span>BufferWriter {
inner: termcolor::BufferWriter,
test_target: <span class="prelude-ty">Option</span>&lt;Target&gt;,
}
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt) <span class="kw">struct </span>Buffer {
inner: termcolor::Buffer,
test_target: <span class="prelude-ty">Option</span>&lt;Target&gt;,
}
<span class="kw">impl </span>BufferWriter {
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt::writer) <span class="kw">fn </span>stderr(is_test: bool, write_style: WriteStyle) -&gt; <span class="self">Self </span>{
BufferWriter {
inner: termcolor::BufferWriter::stderr(write_style.into_color_choice()),
test_target: <span class="kw">if </span>is_test { <span class="prelude-val">Some</span>(Target::Stderr) } <span class="kw">else </span>{ <span class="prelude-val">None </span>},
}
}
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt::writer) <span class="kw">fn </span>stdout(is_test: bool, write_style: WriteStyle) -&gt; <span class="self">Self </span>{
BufferWriter {
inner: termcolor::BufferWriter::stdout(write_style.into_color_choice()),
test_target: <span class="kw">if </span>is_test { <span class="prelude-val">Some</span>(Target::Stdout) } <span class="kw">else </span>{ <span class="prelude-val">None </span>},
}
}
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt::writer) <span class="kw">fn </span>buffer(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Buffer {
Buffer {
inner: <span class="self">self</span>.inner.buffer(),
test_target: <span class="self">self</span>.test_target,
}
}
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt::writer) <span class="kw">fn </span>print(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>Buffer) -&gt; io::Result&lt;()&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(target) = <span class="self">self</span>.test_target {
<span class="comment">// This impl uses the `eprint` and `print` macros
// instead of `termcolor`&#39;s buffer.
// This is so their output can be captured by `cargo test`
</span><span class="kw">let </span>log = String::from_utf8_lossy(buf.bytes());
<span class="kw">match </span>target {
Target::Stderr =&gt; <span class="macro">eprint!</span>(<span class="string">&quot;{}&quot;</span>, log),
Target::Stdout =&gt; <span class="macro">print!</span>(<span class="string">&quot;{}&quot;</span>, log),
}
<span class="prelude-val">Ok</span>(())
} <span class="kw">else </span>{
<span class="self">self</span>.inner.print(<span class="kw-2">&amp;</span>buf.inner)
}
}
}
<span class="kw">impl </span>Buffer {
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt) <span class="kw">fn </span>clear(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.inner.clear()
}
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt) <span class="kw">fn </span>write(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<span class="self">self</span>.inner.write(buf)
}
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt) <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.inner.flush()
}
<span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::fmt) <span class="kw">fn </span>bytes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[u8] {
<span class="self">self</span>.inner.as_slice()
}
<span class="kw">fn </span>set_color(<span class="kw-2">&amp;mut </span><span class="self">self</span>, spec: <span class="kw-2">&amp;</span>ColorSpec) -&gt; io::Result&lt;()&gt; {
<span class="comment">// Ignore styles for test captured logs because they can&#39;t be printed
</span><span class="kw">if </span><span class="self">self</span>.test_target.is_none() {
<span class="self">self</span>.inner.set_color(spec)
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">fn </span>reset(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<span class="comment">// Ignore styles for test captured logs because they can&#39;t be printed
</span><span class="kw">if </span><span class="self">self</span>.test_target.is_none() {
<span class="self">self</span>.inner.reset()
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(())
}
}
}
<span class="kw">impl </span>WriteStyle {
<span class="kw">fn </span>into_color_choice(<span class="self">self</span>) -&gt; ColorChoice {
<span class="kw">match </span><span class="self">self </span>{
WriteStyle::Always =&gt; ColorChoice::Always,
WriteStyle::Auto =&gt; ColorChoice::Auto,
WriteStyle::Never =&gt; ColorChoice::Never,
}
}
}
<span class="doccomment">/// A set of styles to apply to the terminal output.
///
/// Call [`Formatter::style`] to get a `Style` and use the builder methods to
/// set styling properties, like [color] and [weight].
/// To print a value using the style, wrap it in a call to [`value`] when the log
/// record is formatted.
///
/// # Examples
///
/// Create a bold, red colored style and use it to print the log level:
///
/// ```
/// use std::io::Write;
/// use env_logger::fmt::Color;
///
/// let mut builder = env_logger::Builder::new();
///
/// builder.format(|buf, record| {
/// let mut level_style = buf.style();
///
/// level_style.set_color(Color::Red).set_bold(true);
///
/// writeln!(buf, &quot;{}: {}&quot;,
/// level_style.value(record.level()),
/// record.args())
/// });
/// ```
///
/// Styles can be re-used to output multiple values:
///
/// ```
/// use std::io::Write;
/// use env_logger::fmt::Color;
///
/// let mut builder = env_logger::Builder::new();
///
/// builder.format(|buf, record| {
/// let mut bold = buf.style();
///
/// bold.set_bold(true);
///
/// writeln!(buf, &quot;{}: {} {}&quot;,
/// bold.value(record.level()),
/// bold.value(&quot;some bold text&quot;),
/// record.args())
/// });
/// ```
///
/// [`Formatter::style`]: struct.Formatter.html#method.style
/// [color]: #method.set_color
/// [weight]: #method.set_bold
/// [`value`]: #method.value
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>Style {
buf: Rc&lt;RefCell&lt;Buffer&gt;&gt;,
spec: ColorSpec,
}
<span class="doccomment">/// A value that can be printed using the given styles.
///
/// It is the result of calling [`Style::value`].
///
/// [`Style::value`]: struct.Style.html#method.value
</span><span class="kw">pub struct </span>StyledValue&lt;<span class="lifetime">&#39;a</span>, T&gt; {
style: Cow&lt;<span class="lifetime">&#39;a</span>, Style&gt;,
value: T,
}
<span class="kw">impl </span>Style {
<span class="doccomment">/// Set the text color.
///
/// # Examples
///
/// Create a style with red text:
///
/// ```
/// use std::io::Write;
/// use env_logger::fmt::Color;
///
/// let mut builder = env_logger::Builder::new();
///
/// builder.format(|buf, record| {
/// let mut style = buf.style();
///
/// style.set_color(Color::Red);
///
/// writeln!(buf, &quot;{}&quot;, style.value(record.args()))
/// });
/// ```
</span><span class="kw">pub fn </span>set_color(<span class="kw-2">&amp;mut </span><span class="self">self</span>, color: Color) -&gt; <span class="kw-2">&amp;mut </span>Style {
<span class="self">self</span>.spec.set_fg(color.into_termcolor());
<span class="self">self
</span>}
<span class="doccomment">/// Set the text weight.
///
/// If `yes` is true then text will be written in bold.
/// If `yes` is false then text will be written in the default weight.
///
/// # Examples
///
/// Create a style with bold text:
///
/// ```
/// use std::io::Write;
///
/// let mut builder = env_logger::Builder::new();
///
/// builder.format(|buf, record| {
/// let mut style = buf.style();
///
/// style.set_bold(true);
///
/// writeln!(buf, &quot;{}&quot;, style.value(record.args()))
/// });
/// ```
</span><span class="kw">pub fn </span>set_bold(<span class="kw-2">&amp;mut </span><span class="self">self</span>, yes: bool) -&gt; <span class="kw-2">&amp;mut </span>Style {
<span class="self">self</span>.spec.set_bold(yes);
<span class="self">self
</span>}
<span class="doccomment">/// Set the text intensity.
///
/// If `yes` is true then text will be written in a brighter color.
/// If `yes` is false then text will be written in the default color.
///
/// # Examples
///
/// Create a style with intense text:
///
/// ```
/// use std::io::Write;
///
/// let mut builder = env_logger::Builder::new();
///
/// builder.format(|buf, record| {
/// let mut style = buf.style();
///
/// style.set_intense(true);
///
/// writeln!(buf, &quot;{}&quot;, style.value(record.args()))
/// });
/// ```
</span><span class="kw">pub fn </span>set_intense(<span class="kw-2">&amp;mut </span><span class="self">self</span>, yes: bool) -&gt; <span class="kw-2">&amp;mut </span>Style {
<span class="self">self</span>.spec.set_intense(yes);
<span class="self">self
</span>}
<span class="doccomment">/// Set the background color.
///
/// # Examples
///
/// Create a style with a yellow background:
///
/// ```
/// use std::io::Write;
/// use env_logger::fmt::Color;
///
/// let mut builder = env_logger::Builder::new();
///
/// builder.format(|buf, record| {
/// let mut style = buf.style();
///
/// style.set_bg(Color::Yellow);
///
/// writeln!(buf, &quot;{}&quot;, style.value(record.args()))
/// });
/// ```
</span><span class="kw">pub fn </span>set_bg(<span class="kw-2">&amp;mut </span><span class="self">self</span>, color: Color) -&gt; <span class="kw-2">&amp;mut </span>Style {
<span class="self">self</span>.spec.set_bg(color.into_termcolor());
<span class="self">self
</span>}
<span class="doccomment">/// Wrap a value in the style.
///
/// The same `Style` can be used to print multiple different values.
///
/// # Examples
///
/// Create a bold, red colored style and use it to print the log level:
///
/// ```
/// use std::io::Write;
/// use env_logger::fmt::Color;
///
/// let mut builder = env_logger::Builder::new();
///
/// builder.format(|buf, record| {
/// let mut style = buf.style();
///
/// style.set_color(Color::Red).set_bold(true);
///
/// writeln!(buf, &quot;{}: {}&quot;,
/// style.value(record.level()),
/// record.args())
/// });
/// ```
</span><span class="kw">pub fn </span>value&lt;T&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, value: T) -&gt; StyledValue&lt;T&gt; {
StyledValue {
style: Cow::Borrowed(<span class="self">self</span>),
value,
}
}
<span class="doccomment">/// Wrap a value in the style by taking ownership of it.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>into_value&lt;T&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, value: T) -&gt; StyledValue&lt;<span class="lifetime">&#39;static</span>, T&gt; {
StyledValue {
style: Cow::Owned(<span class="self">self</span>.clone()),
value,
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T&gt; StyledValue&lt;<span class="lifetime">&#39;a</span>, T&gt; {
<span class="kw">fn </span>write_fmt&lt;F&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: F) -&gt; fmt::Result
<span class="kw">where
</span>F: FnOnce() -&gt; fmt::Result,
{
<span class="self">self</span>.style
.buf
.borrow_mut()
.set_color(<span class="kw-2">&amp;</span><span class="self">self</span>.style.spec)
.map_err(|<span class="kw">_</span>| fmt::Error)<span class="question-mark">?</span>;
<span class="comment">// Always try to reset the terminal style, even if writing failed
</span><span class="kw">let </span>write = f();
<span class="kw">let </span>reset = <span class="self">self</span>.style.buf.borrow_mut().reset().map_err(|<span class="kw">_</span>| fmt::Error);
write.and(reset)
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Style {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
f.debug_struct(<span class="string">&quot;Style&quot;</span>).field(<span class="string">&quot;spec&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.spec).finish()
}
}
<span class="macro">macro_rules! </span>impl_styled_value_fmt {
($(<span class="macro-nonterminal">$fmt_trait</span>:path),<span class="kw-2">*</span>) =&gt; {
$(
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: <span class="macro-nonterminal">$fmt_trait</span>&gt; <span class="macro-nonterminal">$fmt_trait </span><span class="kw">for </span>StyledValue&lt;<span class="lifetime">&#39;a</span>, T&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter)-&gt;fmt::Result {
<span class="self">self</span>.write_fmt(|| T::fmt(<span class="kw-2">&amp;</span><span class="self">self</span>.value, f))
}
}
)*
};
}
<span class="macro">impl_styled_value_fmt!</span>(
fmt::Debug,
fmt::Display,
fmt::Pointer,
fmt::Octal,
fmt::Binary,
fmt::UpperHex,
fmt::LowerHex,
fmt::UpperExp,
fmt::LowerExp
);
<span class="comment">// The `Color` type is copied from https://github.com/BurntSushi/ripgrep/tree/master/termcolor
</span><span class="doccomment">/// The set of available colors for the terminal foreground/background.
///
/// The `Ansi256` and `Rgb` colors will only output the correct codes when
/// paired with the `Ansi` `WriteColor` implementation.
///
/// The `Ansi256` and `Rgb` color types are not supported when writing colors
/// on Windows using the console. If they are used on Windows, then they are
/// silently ignored and no colors will be emitted.
///
/// This set may expand over time.
///
/// This type has a `FromStr` impl that can parse colors from their human
/// readable form. The format is as follows:
///
/// 1. Any of the explicitly listed colors in English. They are matched
/// case insensitively.
/// 2. A single 8-bit integer, in either decimal or hexadecimal format.
/// 3. A triple of 8-bit integers separated by a comma, where each integer is
/// in decimal or hexadecimal format.
///
/// Hexadecimal numbers are written with a `0x` prefix.
</span><span class="attribute">#[allow(missing_docs)]
#[derive(Clone, Debug, Eq, PartialEq)]
</span><span class="kw">pub enum </span>Color {
Black,
Blue,
Green,
Red,
Cyan,
Magenta,
Yellow,
White,
Ansi256(u8),
Rgb(u8, u8, u8),
<span class="attribute">#[doc(hidden)]
</span>__Nonexhaustive,
}
<span class="kw">impl </span>Color {
<span class="kw">fn </span>into_termcolor(<span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;termcolor::Color&gt; {
<span class="kw">match </span><span class="self">self </span>{
Color::Black =&gt; <span class="prelude-val">Some</span>(termcolor::Color::Black),
Color::Blue =&gt; <span class="prelude-val">Some</span>(termcolor::Color::Blue),
Color::Green =&gt; <span class="prelude-val">Some</span>(termcolor::Color::Green),
Color::Red =&gt; <span class="prelude-val">Some</span>(termcolor::Color::Red),
Color::Cyan =&gt; <span class="prelude-val">Some</span>(termcolor::Color::Cyan),
Color::Magenta =&gt; <span class="prelude-val">Some</span>(termcolor::Color::Magenta),
Color::Yellow =&gt; <span class="prelude-val">Some</span>(termcolor::Color::Yellow),
Color::White =&gt; <span class="prelude-val">Some</span>(termcolor::Color::White),
Color::Ansi256(value) =&gt; <span class="prelude-val">Some</span>(termcolor::Color::Ansi256(value)),
Color::Rgb(r, g, b) =&gt; <span class="prelude-val">Some</span>(termcolor::Color::Rgb(r, g, b)),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="env_logger" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>