| <!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.9.3/src/fmt/writer/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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> |
| </pre><pre class="rust"><code><span class="kw">mod </span>atty; |
| <span class="kw">mod </span>termcolor; |
| |
| <span class="kw">use </span><span class="self">self</span>::atty::{is_stderr, is_stdout}; |
| <span class="kw">use </span><span class="self">self</span>::termcolor::BufferWriter; |
| <span class="kw">use </span>std::{fmt, io, mem, sync::Mutex}; |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">mod </span>glob { |
| <span class="kw">pub use </span><span class="kw">super</span>::termcolor::glob::<span class="kw-2">*</span>; |
| <span class="kw">pub use super</span>::<span class="kw-2">*</span>; |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">use </span><span class="self">self</span>::termcolor::Buffer; |
| |
| <span class="doccomment">/// Log target, either `stdout`, `stderr` or a custom pipe. |
| </span><span class="attribute">#[non_exhaustive] |
| </span><span class="kw">pub enum </span>Target { |
| <span class="doccomment">/// Logs will be sent to standard output. |
| </span>Stdout, |
| <span class="doccomment">/// Logs will be sent to standard error. |
| </span>Stderr, |
| <span class="doccomment">/// Logs will be sent to a custom pipe. |
| </span>Pipe(Box<<span class="kw">dyn </span>io::Write + Send + <span class="lifetime">'static</span>>), |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>Target { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| Target::Stderr |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Target { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="macro">write!</span>( |
| f, |
| <span class="string">"{}"</span>, |
| <span class="kw">match </span><span class="self">self </span>{ |
| <span class="self">Self</span>::Stdout => <span class="string">"stdout"</span>, |
| <span class="self">Self</span>::Stderr => <span class="string">"stderr"</span>, |
| <span class="self">Self</span>::Pipe(<span class="kw">_</span>) => <span class="string">"pipe"</span>, |
| } |
| ) |
| } |
| } |
| |
| <span class="doccomment">/// Log target, either `stdout`, `stderr` or a custom pipe. |
| /// |
| /// Same as `Target`, except the pipe is wrapped in a mutex for interior mutability. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">enum </span>WritableTarget { |
| <span class="doccomment">/// Logs will be sent to standard output. |
| </span>Stdout, |
| <span class="doccomment">/// Logs will be sent to standard error. |
| </span>Stderr, |
| <span class="doccomment">/// Logs will be sent to a custom pipe. |
| </span>Pipe(Box<Mutex<<span class="kw">dyn </span>io::Write + Send + <span class="lifetime">'static</span>>>), |
| } |
| |
| <span class="kw">impl </span>From<Target> <span class="kw">for </span>WritableTarget { |
| <span class="kw">fn </span>from(target: Target) -> <span class="self">Self </span>{ |
| <span class="kw">match </span>target { |
| Target::Stdout => <span class="self">Self</span>::Stdout, |
| Target::Stderr => <span class="self">Self</span>::Stderr, |
| Target::Pipe(pipe) => <span class="self">Self</span>::Pipe(Box::new(Mutex::new(pipe))), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>WritableTarget { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::from(Target::default()) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>WritableTarget { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="macro">write!</span>( |
| f, |
| <span class="string">"{}"</span>, |
| <span class="kw">match </span><span class="self">self </span>{ |
| <span class="self">Self</span>::Stdout => <span class="string">"stdout"</span>, |
| <span class="self">Self</span>::Stderr => <span class="string">"stderr"</span>, |
| <span class="self">Self</span>::Pipe(<span class="kw">_</span>) => <span class="string">"pipe"</span>, |
| } |
| ) |
| } |
| } |
| <span class="doccomment">/// Whether or not to print styles to the target. |
| </span><span class="attribute">#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] |
| </span><span class="kw">pub enum </span>WriteStyle { |
| <span class="doccomment">/// Try to print styles, but don't force the issue. |
| </span>Auto, |
| <span class="doccomment">/// Try very hard to print styles. |
| </span>Always, |
| <span class="doccomment">/// Never print styles. |
| </span>Never, |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>WriteStyle { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| WriteStyle::Auto |
| } |
| } |
| |
| <span class="doccomment">/// A terminal target with color awareness. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Writer { |
| inner: BufferWriter, |
| write_style: WriteStyle, |
| } |
| |
| <span class="kw">impl </span>Writer { |
| <span class="kw">pub fn </span>write_style(<span class="kw-2">&</span><span class="self">self</span>) -> WriteStyle { |
| <span class="self">self</span>.write_style |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>buffer(<span class="kw-2">&</span><span class="self">self</span>) -> Buffer { |
| <span class="self">self</span>.inner.buffer() |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>print(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&</span>Buffer) -> io::Result<()> { |
| <span class="self">self</span>.inner.print(buf) |
| } |
| } |
| |
| <span class="doccomment">/// A builder for a terminal writer. |
| /// |
| /// The target and style choice can be configured before building. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Builder { |
| target: WritableTarget, |
| write_style: WriteStyle, |
| is_test: bool, |
| built: bool, |
| } |
| |
| <span class="kw">impl </span>Builder { |
| <span class="doccomment">/// Initialize the writer builder with defaults. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new() -> <span class="self">Self </span>{ |
| Builder { |
| target: Default::default(), |
| write_style: Default::default(), |
| is_test: <span class="bool-val">false</span>, |
| built: <span class="bool-val">false</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Set the target to write to. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>target(<span class="kw-2">&mut </span><span class="self">self</span>, target: Target) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="self">self</span>.target = target.into(); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Parses a style choice string. |
| /// |
| /// See the [Disabling colors] section for more details. |
| /// |
| /// [Disabling colors]: ../index.html#disabling-colors |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>parse_write_style(<span class="kw-2">&mut </span><span class="self">self</span>, write_style: <span class="kw-2">&</span>str) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="self">self</span>.write_style(parse_write_style(write_style)) |
| } |
| |
| <span class="doccomment">/// Whether or not to print style characters when writing. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>write_style(<span class="kw-2">&mut </span><span class="self">self</span>, write_style: WriteStyle) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="self">self</span>.write_style = write_style; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Whether or not to capture logs for `cargo test`. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_test(<span class="kw-2">&mut </span><span class="self">self</span>, is_test: bool) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="self">self</span>.is_test = is_test; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Build a terminal writer. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>build(<span class="kw-2">&mut </span><span class="self">self</span>) -> Writer { |
| <span class="macro">assert!</span>(!<span class="self">self</span>.built, <span class="string">"attempt to re-use consumed builder"</span>); |
| <span class="self">self</span>.built = <span class="bool-val">true</span>; |
| |
| <span class="kw">let </span>color_choice = <span class="kw">match </span><span class="self">self</span>.write_style { |
| WriteStyle::Auto => { |
| <span class="kw">if match </span><span class="kw-2">&</span><span class="self">self</span>.target { |
| WritableTarget::Stderr => is_stderr(), |
| WritableTarget::Stdout => is_stdout(), |
| WritableTarget::Pipe(<span class="kw">_</span>) => <span class="bool-val">false</span>, |
| } { |
| WriteStyle::Auto |
| } <span class="kw">else </span>{ |
| WriteStyle::Never |
| } |
| } |
| color_choice => color_choice, |
| }; |
| |
| <span class="kw">let </span>writer = <span class="kw">match </span>mem::take(<span class="kw-2">&mut </span><span class="self">self</span>.target) { |
| WritableTarget::Stderr => BufferWriter::stderr(<span class="self">self</span>.is_test, color_choice), |
| WritableTarget::Stdout => BufferWriter::stdout(<span class="self">self</span>.is_test, color_choice), |
| WritableTarget::Pipe(pipe) => BufferWriter::pipe(color_choice, pipe), |
| }; |
| |
| Writer { |
| inner: writer, |
| write_style: <span class="self">self</span>.write_style, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>Builder { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| Builder::new() |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Writer { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| f.debug_struct(<span class="string">"Writer"</span>).finish() |
| } |
| } |
| |
| <span class="kw">fn </span>parse_write_style(spec: <span class="kw-2">&</span>str) -> WriteStyle { |
| <span class="kw">match </span>spec { |
| <span class="string">"auto" </span>=> WriteStyle::Auto, |
| <span class="string">"always" </span>=> WriteStyle::Always, |
| <span class="string">"never" </span>=> WriteStyle::Never, |
| <span class="kw">_ </span>=> Default::default(), |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>parse_write_style_valid() { |
| <span class="kw">let </span>inputs = <span class="macro">vec!</span>[ |
| (<span class="string">"auto"</span>, WriteStyle::Auto), |
| (<span class="string">"always"</span>, WriteStyle::Always), |
| (<span class="string">"never"</span>, WriteStyle::Never), |
| ]; |
| |
| <span class="kw">for </span>(input, expected) <span class="kw">in </span>inputs { |
| <span class="macro">assert_eq!</span>(expected, parse_write_style(input)); |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>parse_write_style_invalid() { |
| <span class="kw">let </span>inputs = <span class="macro">vec!</span>[<span class="string">""</span>, <span class="string">"true"</span>, <span class="string">"false"</span>, <span class="string">"NEVER!!"</span>]; |
| |
| <span class="kw">for </span>input <span class="kw">in </span>inputs { |
| <span class="macro">assert_eq!</span>(WriteStyle::Auto, parse_write_style(input)); |
| } |
| } |
| } |
| </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> |
