| <!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../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> |
| </pre><pre class="rust"><code><span class="doccomment">//! This is a library for controlling colours and formatting, such as |
| //! red bold text or blue underlined text, on ANSI terminals. |
| //! |
| //! |
| //! ## Basic usage |
| //! |
| //! There are three main types in this crate that you need to be |
| //! concerned with: [`ANSIString`], [`Style`], and [`Colour`]. |
| //! |
| //! A `Style` holds stylistic information: foreground and background colours, |
| //! whether the text should be bold, or blinking, or other properties. The |
| //! [`Colour`] enum represents the available colours. And an [`ANSIString`] is a |
| //! string paired with a [`Style`]. |
| //! |
| //! [`Color`] is also available as an alias to `Colour`. |
| //! |
| //! To format a string, call the `paint` method on a `Style` or a `Colour`, |
| //! passing in the string you want to format as the argument. For example, |
| //! here’s how to get some red text: |
| //! |
| //! ``` |
| //! use ansi_term::Colour::Red; |
| //! |
| //! println!("This is in red: {}", Red.paint("a red string")); |
| //! ``` |
| //! |
| //! It’s important to note that the `paint` method does *not* actually return a |
| //! string with the ANSI control characters surrounding it. Instead, it returns |
| //! an [`ANSIString`] value that has a [`Display`] implementation that, when |
| //! formatted, returns the characters. This allows strings to be printed with a |
| //! minimum of [`String`] allocations being performed behind the scenes. |
| //! |
| //! If you *do* want to get at the escape codes, then you can convert the |
| //! [`ANSIString`] to a string as you would any other `Display` value: |
| //! |
| //! ``` |
| //! use ansi_term::Colour::Red; |
| //! |
| //! let red_string = Red.paint("a red string").to_string(); |
| //! ``` |
| //! |
| //! |
| //! ## Bold, underline, background, and other styles |
| //! |
| //! For anything more complex than plain foreground colour changes, you need to |
| //! construct `Style` values themselves, rather than beginning with a `Colour`. |
| //! You can do this by chaining methods based on a new `Style`, created with |
| //! [`Style::new()`]. Each method creates a new style that has that specific |
| //! property set. For example: |
| //! |
| //! ``` |
| //! use ansi_term::Style; |
| //! |
| //! println!("How about some {} and {}?", |
| //! Style::new().bold().paint("bold"), |
| //! Style::new().underline().paint("underline")); |
| //! ``` |
| //! |
| //! For brevity, these methods have also been implemented for `Colour` values, |
| //! so you can give your styles a foreground colour without having to begin with |
| //! an empty `Style` value: |
| //! |
| //! ``` |
| //! use ansi_term::Colour::{Blue, Yellow}; |
| //! |
| //! println!("Demonstrating {} and {}!", |
| //! Blue.bold().paint("blue bold"), |
| //! Yellow.underline().paint("yellow underline")); |
| //! |
| //! println!("Yellow on blue: {}", Yellow.on(Blue).paint("wow!")); |
| //! ``` |
| //! |
| //! The complete list of styles you can use are: [`bold`], [`dimmed`], [`italic`], |
| //! [`underline`], [`blink`], [`reverse`], [`hidden`], [`strikethrough`], and [`on`] for |
| //! background colours. |
| //! |
| //! In some cases, you may find it easier to change the foreground on an |
| //! existing `Style` rather than starting from the appropriate `Colour`. |
| //! You can do this using the [`fg`] method: |
| //! |
| //! ``` |
| //! use ansi_term::Style; |
| //! use ansi_term::Colour::{Blue, Cyan, Yellow}; |
| //! |
| //! println!("Yellow on blue: {}", Style::new().on(Blue).fg(Yellow).paint("yow!")); |
| //! println!("Also yellow on blue: {}", Cyan.on(Blue).fg(Yellow).paint("zow!")); |
| //! ``` |
| //! |
| //! You can turn a `Colour` into a `Style` with the [`normal`] method. |
| //! This will produce the exact same `ANSIString` as if you just used the |
| //! `paint` method on the `Colour` directly, but it’s useful in certain cases: |
| //! for example, you may have a method that returns `Styles`, and need to |
| //! represent both the “red bold” and “red, but not bold” styles with values of |
| //! the same type. The `Style` struct also has a [`Default`] implementation if you |
| //! want to have a style with *nothing* set. |
| //! |
| //! ``` |
| //! use ansi_term::Style; |
| //! use ansi_term::Colour::Red; |
| //! |
| //! Red.normal().paint("yet another red string"); |
| //! Style::default().paint("a completely regular string"); |
| //! ``` |
| //! |
| //! |
| //! ## Extended colours |
| //! |
| //! You can access the extended range of 256 colours by using the `Colour::Fixed` |
| //! variant, which takes an argument of the colour number to use. This can be |
| //! included wherever you would use a `Colour`: |
| //! |
| //! ``` |
| //! use ansi_term::Colour::Fixed; |
| //! |
| //! Fixed(134).paint("A sort of light purple"); |
| //! Fixed(221).on(Fixed(124)).paint("Mustard in the ketchup"); |
| //! ``` |
| //! |
| //! The first sixteen of these values are the same as the normal and bold |
| //! standard colour variants. There’s nothing stopping you from using these as |
| //! `Fixed` colours instead, but there’s nothing to be gained by doing so |
| //! either. |
| //! |
| //! You can also access full 24-bit colour by using the `Colour::RGB` variant, |
| //! which takes separate `u8` arguments for red, green, and blue: |
| //! |
| //! ``` |
| //! use ansi_term::Colour::RGB; |
| //! |
| //! RGB(70, 130, 180).paint("Steel blue"); |
| //! ``` |
| //! |
| //! ## Combining successive coloured strings |
| //! |
| //! The benefit of writing ANSI escape codes to the terminal is that they |
| //! *stack*: you do not need to end every coloured string with a reset code if |
| //! the text that follows it is of a similar style. For example, if you want to |
| //! have some blue text followed by some blue bold text, it’s possible to send |
| //! the ANSI code for blue, followed by the ANSI code for bold, and finishing |
| //! with a reset code without having to have an extra one between the two |
| //! strings. |
| //! |
| //! This crate can optimise the ANSI codes that get printed in situations like |
| //! this, making life easier for your terminal renderer. The [`ANSIStrings`] |
| //! type takes a slice of several [`ANSIString`] values, and will iterate over |
| //! each of them, printing only the codes for the styles that need to be updated |
| //! as part of its formatting routine. |
| //! |
| //! The following code snippet uses this to enclose a binary number displayed in |
| //! red bold text inside some red, but not bold, brackets: |
| //! |
| //! ``` |
| //! use ansi_term::Colour::Red; |
| //! use ansi_term::{ANSIString, ANSIStrings}; |
| //! |
| //! let some_value = format!("{:b}", 42); |
| //! let strings: &[ANSIString<'static>] = &[ |
| //! Red.paint("["), |
| //! Red.bold().paint(some_value), |
| //! Red.paint("]"), |
| //! ]; |
| //! |
| //! println!("Value: {}", ANSIStrings(strings)); |
| //! ``` |
| //! |
| //! There are several things to note here. Firstly, the [`paint`] method can take |
| //! *either* an owned [`String`] or a borrowed [`&str`]. Internally, an [`ANSIString`] |
| //! holds a copy-on-write ([`Cow`]) string value to deal with both owned and |
| //! borrowed strings at the same time. This is used here to display a `String`, |
| //! the result of the `format!` call, using the same mechanism as some |
| //! statically-available `&str` slices. Secondly, that the [`ANSIStrings`] value |
| //! works in the same way as its singular counterpart, with a [`Display`] |
| //! implementation that only performs the formatting when required. |
| //! |
| //! ## Byte strings |
| //! |
| //! This library also supports formatting `\[u8]` byte strings; this supports |
| //! applications working with text in an unknown encoding. [`Style`] and |
| //! [`Colour`] support painting `\[u8]` values, resulting in an [`ANSIByteString`]. |
| //! This type does not implement [`Display`], as it may not contain UTF-8, but |
| //! it does provide a method [`write_to`] to write the result to any value that |
| //! implements [`Write`]: |
| //! |
| //! ``` |
| //! use ansi_term::Colour::Green; |
| //! |
| //! Green.paint("user data".as_bytes()).write_to(&mut std::io::stdout()).unwrap(); |
| //! ``` |
| //! |
| //! Similarly, the type [`ANSIByteStrings`] supports writing a list of |
| //! [`ANSIByteString`] values with minimal escape sequences: |
| //! |
| //! ``` |
| //! use ansi_term::Colour::Green; |
| //! use ansi_term::ANSIByteStrings; |
| //! |
| //! ANSIByteStrings(&[ |
| //! Green.paint("user data 1\n".as_bytes()), |
| //! Green.bold().paint("user data 2\n".as_bytes()), |
| //! ]).write_to(&mut std::io::stdout()).unwrap(); |
| //! ``` |
| //! |
| //! [`Cow`]: https://doc.rust-lang.org/std/borrow/enum.Cow.html |
| //! [`Display`]: https://doc.rust-lang.org/std/fmt/trait.Display.html |
| //! [`Default`]: https://doc.rust-lang.org/std/default/trait.Default.html |
| //! [`String`]: https://doc.rust-lang.org/std/string/struct.String.html |
| //! [`&str`]: https://doc.rust-lang.org/std/primitive.str.html |
| //! [`Write`]: https://doc.rust-lang.org/std/io/trait.Write.html |
| //! [`Style`]: struct.Style.html |
| //! [`Style::new()`]: struct.Style.html#method.new |
| //! [`Color`]: enum.Color.html |
| //! [`Colour`]: enum.Colour.html |
| //! [`ANSIString`]: type.ANSIString.html |
| //! [`ANSIStrings`]: type.ANSIStrings.html |
| //! [`ANSIByteString`]: type.ANSIByteString.html |
| //! [`ANSIByteStrings`]: type.ANSIByteStrings.html |
| //! [`write_to`]: type.ANSIByteString.html#method.write_to |
| //! [`paint`]: type.ANSIByteString.html#method.write_to |
| //! [`normal`]: enum.Colour.html#method.normal |
| //! |
| //! [`bold`]: struct.Style.html#method.bold |
| //! [`dimmed`]: struct.Style.html#method.dimmed |
| //! [`italic`]: struct.Style.html#method.italic |
| //! [`underline`]: struct.Style.html#method.underline |
| //! [`blink`]: struct.Style.html#method.blink |
| //! [`reverse`]: struct.Style.html#method.reverse |
| //! [`hidden`]: struct.Style.html#method.hidden |
| //! [`strikethrough`]: struct.Style.html#method.strikethrough |
| //! [`fg`]: struct.Style.html#method.fg |
| //! [`on`]: struct.Style.html#method.on |
| |
| </span><span class="attribute">#![crate_name = <span class="string">"ansi_term"</span>] |
| #![crate_type = <span class="string">"rlib"</span>] |
| #![crate_type = <span class="string">"dylib"</span>] |
| |
| #![warn(missing_copy_implementations)] |
| #![warn(missing_docs)] |
| #![warn(trivial_casts, trivial_numeric_casts)] |
| #![warn(unused_extern_crates, unused_qualifications)] |
| |
| #[cfg(target_os=<span class="string">"windows"</span>)] |
| </span><span class="kw">extern crate </span>winapi; |
| <span class="attribute">#[cfg(test)] |
| #[macro_use] |
| </span><span class="kw">extern crate </span>doc_comment; |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="macro">doctest!</span>(<span class="string">"../README.md"</span>); |
| |
| <span class="kw">mod </span>ansi; |
| <span class="kw">pub use </span>ansi::{Prefix, Infix, Suffix}; |
| |
| <span class="kw">mod </span>style; |
| <span class="kw">pub use </span>style::{Colour, Style}; |
| |
| <span class="doccomment">/// Color is a type alias for `Colour`. |
| </span><span class="kw">pub use </span>Colour <span class="kw">as </span>Color; |
| |
| <span class="kw">mod </span>difference; |
| <span class="kw">mod </span>display; |
| <span class="kw">pub use </span>display::<span class="kw-2">*</span>; |
| |
| <span class="kw">mod </span>write; |
| |
| <span class="kw">mod </span>windows; |
| <span class="kw">pub use </span>windows::<span class="kw-2">*</span>; |
| |
| <span class="kw">mod </span>util; |
| <span class="kw">pub use </span>util::<span class="kw-2">*</span>; |
| |
| <span class="kw">mod </span>debug; |
| </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> |
