| <!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/ansi_term-0.12.1/src/ansi.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ansi.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../ansi_term/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../ansi_term/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>style::{Colour, Style}; |
| |
| <span class="kw">use </span>std::fmt; |
| |
| <span class="kw">use </span>write::AnyWrite; |
| |
| |
| <span class="comment">// ---- generating ANSI codes ---- |
| |
| </span><span class="kw">impl </span>Style { |
| |
| <span class="doccomment">/// Write any bytes that go *before* a piece of text to the given writer. |
| </span><span class="kw">fn </span>write_prefix<W: AnyWrite + <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>W) -> <span class="prelude-ty">Result</span><(), W::Error> { |
| |
| <span class="comment">// If there are actually no styles here, then don’t write *any* codes |
| // as the prefix. An empty ANSI code may not affect the terminal |
| // output at all, but a user may just want a code-free string. |
| </span><span class="kw">if </span><span class="self">self</span>.is_plain() { |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(()); |
| } |
| |
| <span class="comment">// Write the codes’ prefix, then write numbers, separated by |
| // semicolons, for each text style we want to apply. |
| </span><span class="macro">write!</span>(f, <span class="string">"\x1B["</span>)<span class="question-mark">?</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>written_anything = <span class="bool-val">false</span>; |
| |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>write_char = |c| { |
| <span class="kw">if </span>written_anything { <span class="macro">write!</span>(f, <span class="string">";"</span>)<span class="question-mark">?</span>; } |
| written_anything = <span class="bool-val">true</span>; |
| <span class="macro">write!</span>(f, <span class="string">"{}"</span>, c)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| }; |
| |
| <span class="kw">if </span><span class="self">self</span>.is_bold { write_char(<span class="string">'1'</span>)<span class="question-mark">? </span>} |
| <span class="kw">if </span><span class="self">self</span>.is_dimmed { write_char(<span class="string">'2'</span>)<span class="question-mark">? </span>} |
| <span class="kw">if </span><span class="self">self</span>.is_italic { write_char(<span class="string">'3'</span>)<span class="question-mark">? </span>} |
| <span class="kw">if </span><span class="self">self</span>.is_underline { write_char(<span class="string">'4'</span>)<span class="question-mark">? </span>} |
| <span class="kw">if </span><span class="self">self</span>.is_blink { write_char(<span class="string">'5'</span>)<span class="question-mark">? </span>} |
| <span class="kw">if </span><span class="self">self</span>.is_reverse { write_char(<span class="string">'7'</span>)<span class="question-mark">? </span>} |
| <span class="kw">if </span><span class="self">self</span>.is_hidden { write_char(<span class="string">'8'</span>)<span class="question-mark">? </span>} |
| <span class="kw">if </span><span class="self">self</span>.is_strikethrough { write_char(<span class="string">'9'</span>)<span class="question-mark">? </span>} |
| } |
| |
| <span class="comment">// The foreground and background colours, if specified, need to be |
| // handled specially because the number codes are more complicated. |
| // (see `write_background_code` and `write_foreground_code`) |
| </span><span class="kw">if let </span><span class="prelude-val">Some</span>(bg) = <span class="self">self</span>.background { |
| <span class="kw">if </span>written_anything { <span class="macro">write!</span>(f, <span class="string">";"</span>)<span class="question-mark">?</span>; } |
| written_anything = <span class="bool-val">true</span>; |
| bg.write_background_code(f)<span class="question-mark">?</span>; |
| } |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(fg) = <span class="self">self</span>.foreground { |
| <span class="kw">if </span>written_anything { <span class="macro">write!</span>(f, <span class="string">";"</span>)<span class="question-mark">?</span>; } |
| fg.write_foreground_code(f)<span class="question-mark">?</span>; |
| } |
| |
| <span class="comment">// All the codes end with an `m`, because reasons. |
| </span><span class="macro">write!</span>(f, <span class="string">"m"</span>)<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="doccomment">/// Write any bytes that go *after* a piece of text to the given writer. |
| </span><span class="kw">fn </span>write_suffix<W: AnyWrite + <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>W) -> <span class="prelude-ty">Result</span><(), W::Error> { |
| <span class="kw">if </span><span class="self">self</span>.is_plain() { |
| <span class="prelude-val">Ok</span>(()) |
| } |
| <span class="kw">else </span>{ |
| <span class="macro">write!</span>(f, <span class="string">"{}"</span>, RESET) |
| } |
| } |
| } |
| |
| |
| <span class="doccomment">/// The code to send to reset all styles and return to `Style::default()`. |
| </span><span class="kw">pub static </span>RESET: <span class="kw-2">&</span>str = <span class="string">"\x1B[0m"</span>; |
| |
| |
| |
| <span class="kw">impl </span>Colour { |
| <span class="kw">fn </span>write_foreground_code<W: AnyWrite + <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>W) -> <span class="prelude-ty">Result</span><(), W::Error> { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| Colour::Black => <span class="macro">write!</span>(f, <span class="string">"30"</span>), |
| Colour::Red => <span class="macro">write!</span>(f, <span class="string">"31"</span>), |
| Colour::Green => <span class="macro">write!</span>(f, <span class="string">"32"</span>), |
| Colour::Yellow => <span class="macro">write!</span>(f, <span class="string">"33"</span>), |
| Colour::Blue => <span class="macro">write!</span>(f, <span class="string">"34"</span>), |
| Colour::Purple => <span class="macro">write!</span>(f, <span class="string">"35"</span>), |
| Colour::Cyan => <span class="macro">write!</span>(f, <span class="string">"36"</span>), |
| Colour::White => <span class="macro">write!</span>(f, <span class="string">"37"</span>), |
| Colour::Fixed(num) => <span class="macro">write!</span>(f, <span class="string">"38;5;{}"</span>, <span class="kw-2">&</span>num), |
| Colour::RGB(r,g,b) => <span class="macro">write!</span>(f, <span class="string">"38;2;{};{};{}"</span>, <span class="kw-2">&</span>r, <span class="kw-2">&</span>g, <span class="kw-2">&</span>b), |
| } |
| } |
| |
| <span class="kw">fn </span>write_background_code<W: AnyWrite + <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>W) -> <span class="prelude-ty">Result</span><(), W::Error> { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| Colour::Black => <span class="macro">write!</span>(f, <span class="string">"40"</span>), |
| Colour::Red => <span class="macro">write!</span>(f, <span class="string">"41"</span>), |
| Colour::Green => <span class="macro">write!</span>(f, <span class="string">"42"</span>), |
| Colour::Yellow => <span class="macro">write!</span>(f, <span class="string">"43"</span>), |
| Colour::Blue => <span class="macro">write!</span>(f, <span class="string">"44"</span>), |
| Colour::Purple => <span class="macro">write!</span>(f, <span class="string">"45"</span>), |
| Colour::Cyan => <span class="macro">write!</span>(f, <span class="string">"46"</span>), |
| Colour::White => <span class="macro">write!</span>(f, <span class="string">"47"</span>), |
| Colour::Fixed(num) => <span class="macro">write!</span>(f, <span class="string">"48;5;{}"</span>, <span class="kw-2">&</span>num), |
| Colour::RGB(r,g,b) => <span class="macro">write!</span>(f, <span class="string">"48;2;{};{};{}"</span>, <span class="kw-2">&</span>r, <span class="kw-2">&</span>g, <span class="kw-2">&</span>b), |
| } |
| } |
| } |
| |
| |
| <span class="doccomment">/// Like `ANSIString`, but only displays the style prefix. |
| /// |
| /// This type implements the `Display` trait, meaning it can be written to a |
| /// `std::fmt` formatting without doing any extra allocation, and written to a |
| /// string with the `.to_string()` method. For examples, see |
| /// [`Style::prefix`](struct.Style.html#method.prefix). |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>Prefix(Style); |
| |
| <span class="doccomment">/// Like `ANSIString`, but only displays the difference between two |
| /// styles. |
| /// |
| /// This type implements the `Display` trait, meaning it can be written to a |
| /// `std::fmt` formatting without doing any extra allocation, and written to a |
| /// string with the `.to_string()` method. For examples, see |
| /// [`Style::infix`](struct.Style.html#method.infix). |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>Infix(Style, Style); |
| |
| <span class="doccomment">/// Like `ANSIString`, but only displays the style suffix. |
| /// |
| /// This type implements the `Display` trait, meaning it can be written to a |
| /// `std::fmt` formatting without doing any extra allocation, and written to a |
| /// string with the `.to_string()` method. For examples, see |
| /// [`Style::suffix`](struct.Style.html#method.suffix). |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>Suffix(Style); |
| |
| |
| <span class="kw">impl </span>Style { |
| |
| <span class="doccomment">/// The prefix bytes for this style. These are the bytes that tell the |
| /// terminal to use a different colour or font style. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use ansi_term::{Style, Colour::Blue}; |
| /// |
| /// let style = Style::default().bold(); |
| /// assert_eq!("\x1b[1m", |
| /// style.prefix().to_string()); |
| /// |
| /// let style = Blue.bold(); |
| /// assert_eq!("\x1b[1;34m", |
| /// style.prefix().to_string()); |
| /// |
| /// let style = Style::default(); |
| /// assert_eq!("", |
| /// style.prefix().to_string()); |
| /// ``` |
| </span><span class="kw">pub fn </span>prefix(<span class="self">self</span>) -> Prefix { |
| Prefix(<span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// The infix bytes between this style and `next` style. These are the bytes |
| /// that tell the terminal to change the style to `next`. These may include |
| /// a reset followed by the next colour and style, depending on the two styles. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use ansi_term::{Style, Colour::Green}; |
| /// |
| /// let style = Style::default().bold(); |
| /// assert_eq!("\x1b[32m", |
| /// style.infix(Green.bold()).to_string()); |
| /// |
| /// let style = Green.normal(); |
| /// assert_eq!("\x1b[1m", |
| /// style.infix(Green.bold()).to_string()); |
| /// |
| /// let style = Style::default(); |
| /// assert_eq!("", |
| /// style.infix(style).to_string()); |
| /// ``` |
| </span><span class="kw">pub fn </span>infix(<span class="self">self</span>, next: Style) -> Infix { |
| Infix(<span class="self">self</span>, next) |
| } |
| |
| <span class="doccomment">/// The suffix for this style. These are the bytes that tell the terminal |
| /// to reset back to its normal colour and font style. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use ansi_term::{Style, Colour::Green}; |
| /// |
| /// let style = Style::default().bold(); |
| /// assert_eq!("\x1b[0m", |
| /// style.suffix().to_string()); |
| /// |
| /// let style = Green.normal().bold(); |
| /// assert_eq!("\x1b[0m", |
| /// style.suffix().to_string()); |
| /// |
| /// let style = Style::default(); |
| /// assert_eq!("", |
| /// style.suffix().to_string()); |
| /// ``` |
| </span><span class="kw">pub fn </span>suffix(<span class="self">self</span>) -> Suffix { |
| Suffix(<span class="self">self</span>) |
| } |
| } |
| |
| |
| <span class="kw">impl </span>Colour { |
| |
| <span class="doccomment">/// The prefix bytes for this colour as a `Style`. These are the bytes |
| /// that tell the terminal to use a different colour or font style. |
| /// |
| /// See also [`Style::prefix`](struct.Style.html#method.prefix). |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use ansi_term::Colour::Green; |
| /// |
| /// assert_eq!("\x1b[0m", |
| /// Green.suffix().to_string()); |
| /// ``` |
| </span><span class="kw">pub fn </span>prefix(<span class="self">self</span>) -> Prefix { |
| Prefix(<span class="self">self</span>.normal()) |
| } |
| |
| <span class="doccomment">/// The infix bytes between this colour and `next` colour. These are the bytes |
| /// that tell the terminal to use the `next` colour, or to do nothing if |
| /// the two colours are equal. |
| /// |
| /// See also [`Style::infix`](struct.Style.html#method.infix). |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use ansi_term::Colour::{Red, Yellow}; |
| /// |
| /// assert_eq!("\x1b[33m", |
| /// Red.infix(Yellow).to_string()); |
| /// ``` |
| </span><span class="kw">pub fn </span>infix(<span class="self">self</span>, next: Colour) -> Infix { |
| Infix(<span class="self">self</span>.normal(), next.normal()) |
| } |
| |
| <span class="doccomment">/// The suffix for this colour as a `Style`. These are the bytes that |
| /// tell the terminal to reset back to its normal colour and font style. |
| /// |
| /// See also [`Style::suffix`](struct.Style.html#method.suffix). |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use ansi_term::Colour::Purple; |
| /// |
| /// assert_eq!("\x1b[0m", |
| /// Purple.suffix().to_string()); |
| /// ``` |
| </span><span class="kw">pub fn </span>suffix(<span class="self">self</span>) -> Suffix { |
| Suffix(<span class="self">self</span>.normal()) |
| } |
| } |
| |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>Prefix { |
| <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 { |
| <span class="kw">let </span>f: <span class="kw-2">&mut </span>fmt::Write = f; |
| <span class="self">self</span>.<span class="number">0</span>.write_prefix(f) |
| } |
| } |
| |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>Infix { |
| <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 { |
| <span class="kw">use </span>difference::Difference; |
| |
| <span class="kw">match </span>Difference::between(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="number">1</span>) { |
| Difference::ExtraStyles(style) => { |
| <span class="kw">let </span>f: <span class="kw-2">&mut </span>fmt::Write = f; |
| style.write_prefix(f) |
| }, |
| Difference::Reset => { |
| <span class="kw">let </span>f: <span class="kw-2">&mut </span>fmt::Write = f; |
| <span class="macro">write!</span>(f, <span class="string">"{}{}"</span>, RESET, <span class="self">self</span>.<span class="number">1</span>.prefix()) |
| }, |
| Difference::NoDifference => { |
| <span class="prelude-val">Ok</span>(()) <span class="comment">// nothing to write |
| </span>}, |
| } |
| } |
| } |
| |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>Suffix { |
| <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 { |
| <span class="kw">let </span>f: <span class="kw-2">&mut </span>fmt::Write = f; |
| <span class="self">self</span>.<span class="number">0</span>.write_suffix(f) |
| } |
| } |
| |
| |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>test { |
| <span class="kw">use </span>style::Style; |
| <span class="kw">use </span>style::Colour::<span class="kw-2">*</span>; |
| |
| <span class="macro">macro_rules! </span>test { |
| (<span class="macro-nonterminal">$name</span>: ident: <span class="macro-nonterminal">$style</span>: expr; <span class="macro-nonterminal">$input</span>: expr => <span class="macro-nonterminal">$result</span>: expr) => { |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span><span class="macro-nonterminal">$name</span>() { |
| <span class="macro">assert_eq!</span>(<span class="macro-nonterminal">$style</span>.paint(<span class="macro-nonterminal">$input</span>).to_string(), <span class="macro-nonterminal">$result</span>.to_string()); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>v = Vec::new(); |
| <span class="macro-nonterminal">$style</span>.paint(<span class="macro-nonterminal">$input</span>.as_bytes()).write_to(<span class="kw-2">&mut </span>v).unwrap(); |
| <span class="macro">assert_eq!</span>(v.as_slice(), <span class="macro-nonterminal">$result</span>.as_bytes()); |
| } |
| }; |
| } |
| |
| <span class="macro">test!</span>(plain: Style::default(); <span class="string">"text/plain" </span>=> <span class="string">"text/plain"</span>); |
| <span class="macro">test!</span>(red: Red; <span class="string">"hi" </span>=> <span class="string">"\x1B[31mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(black: Black.normal(); <span class="string">"hi" </span>=> <span class="string">"\x1B[30mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(yellow_bold: Yellow.bold(); <span class="string">"hi" </span>=> <span class="string">"\x1B[1;33mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(yellow_bold_2: Yellow.normal().bold(); <span class="string">"hi" </span>=> <span class="string">"\x1B[1;33mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(blue_underline: Blue.underline(); <span class="string">"hi" </span>=> <span class="string">"\x1B[4;34mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(green_bold_ul: Green.bold().underline(); <span class="string">"hi" </span>=> <span class="string">"\x1B[1;4;32mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(green_bold_ul_2: Green.underline().bold(); <span class="string">"hi" </span>=> <span class="string">"\x1B[1;4;32mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(purple_on_white: Purple.on(White); <span class="string">"hi" </span>=> <span class="string">"\x1B[47;35mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(purple_on_white_2: Purple.normal().on(White); <span class="string">"hi" </span>=> <span class="string">"\x1B[47;35mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(yellow_on_blue: Style::new().on(Blue).fg(Yellow); <span class="string">"hi" </span>=> <span class="string">"\x1B[44;33mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(yellow_on_blue_2: Cyan.on(Blue).fg(Yellow); <span class="string">"hi" </span>=> <span class="string">"\x1B[44;33mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(cyan_bold_on_white: Cyan.bold().on(White); <span class="string">"hi" </span>=> <span class="string">"\x1B[1;47;36mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(cyan_ul_on_white: Cyan.underline().on(White); <span class="string">"hi" </span>=> <span class="string">"\x1B[4;47;36mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(cyan_bold_ul_on_white: Cyan.bold().underline().on(White); <span class="string">"hi" </span>=> <span class="string">"\x1B[1;4;47;36mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(cyan_ul_bold_on_white: Cyan.underline().bold().on(White); <span class="string">"hi" </span>=> <span class="string">"\x1B[1;4;47;36mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(fixed: Fixed(<span class="number">100</span>); <span class="string">"hi" </span>=> <span class="string">"\x1B[38;5;100mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(fixed_on_purple: Fixed(<span class="number">100</span>).on(Purple); <span class="string">"hi" </span>=> <span class="string">"\x1B[45;38;5;100mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(fixed_on_fixed: Fixed(<span class="number">100</span>).on(Fixed(<span class="number">200</span>)); <span class="string">"hi" </span>=> <span class="string">"\x1B[48;5;200;38;5;100mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(rgb: RGB(<span class="number">70</span>,<span class="number">130</span>,<span class="number">180</span>); <span class="string">"hi" </span>=> <span class="string">"\x1B[38;2;70;130;180mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(rgb_on_blue: RGB(<span class="number">70</span>,<span class="number">130</span>,<span class="number">180</span>).on(Blue); <span class="string">"hi" </span>=> <span class="string">"\x1B[44;38;2;70;130;180mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(blue_on_rgb: Blue.on(RGB(<span class="number">70</span>,<span class="number">130</span>,<span class="number">180</span>)); <span class="string">"hi" </span>=> <span class="string">"\x1B[48;2;70;130;180;34mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(rgb_on_rgb: RGB(<span class="number">70</span>,<span class="number">130</span>,<span class="number">180</span>).on(RGB(<span class="number">5</span>,<span class="number">10</span>,<span class="number">15</span>)); <span class="string">"hi" </span>=> <span class="string">"\x1B[48;2;5;10;15;38;2;70;130;180mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(bold: Style::new().bold(); <span class="string">"hi" </span>=> <span class="string">"\x1B[1mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(underline: Style::new().underline(); <span class="string">"hi" </span>=> <span class="string">"\x1B[4mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(bunderline: Style::new().bold().underline(); <span class="string">"hi" </span>=> <span class="string">"\x1B[1;4mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(dimmed: Style::new().dimmed(); <span class="string">"hi" </span>=> <span class="string">"\x1B[2mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(italic: Style::new().italic(); <span class="string">"hi" </span>=> <span class="string">"\x1B[3mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(blink: Style::new().blink(); <span class="string">"hi" </span>=> <span class="string">"\x1B[5mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(reverse: Style::new().reverse(); <span class="string">"hi" </span>=> <span class="string">"\x1B[7mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(hidden: Style::new().hidden(); <span class="string">"hi" </span>=> <span class="string">"\x1B[8mhi\x1B[0m"</span>); |
| <span class="macro">test!</span>(stricken: Style::new().strikethrough(); <span class="string">"hi" </span>=> <span class="string">"\x1B[9mhi\x1B[0m"</span>); |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_infix() { |
| <span class="macro">assert_eq!</span>(Style::new().dimmed().infix(Style::new()).to_string(), <span class="string">"\x1B[0m"</span>); |
| <span class="macro">assert_eq!</span>(White.dimmed().infix(White.normal()).to_string(), <span class="string">"\x1B[0m\x1B[37m"</span>); |
| <span class="macro">assert_eq!</span>(White.normal().infix(White.bold()).to_string(), <span class="string">"\x1B[1m"</span>); |
| <span class="macro">assert_eq!</span>(White.normal().infix(Blue.normal()).to_string(), <span class="string">"\x1B[34m"</span>); |
| <span class="macro">assert_eq!</span>(Blue.bold().infix(Blue.bold()).to_string(), <span class="string">""</span>); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ansi_term" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
