blob: ba65b0e9f0a36699f8526ec339ff0bb7ec553ac7 [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/ansi_term-0.12.1/src/debug.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>debug.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt;
<span class="kw">use </span>style::Style;
<span class="doccomment">/// Styles have a special `Debug` implementation that only shows the fields that
/// are set. Fields that haven’t been touched aren’t included in the output.
///
/// This behaviour gets bypassed when using the alternate formatting mode
/// `format!(&quot;{:#?}&quot;)`.
///
/// use ansi_term::Colour::{Red, Blue};
/// assert_eq!(&quot;Style { fg(Red), on(Blue), bold, italic }&quot;,
/// format!(&quot;{:?}&quot;, Red.on(Blue).bold().italic()));
</span><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>, fmt: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="kw">if </span>fmt.alternate() {
fmt.debug_struct(<span class="string">&quot;Style&quot;</span>)
.field(<span class="string">&quot;foreground&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.foreground)
.field(<span class="string">&quot;background&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.background)
.field(<span class="string">&quot;blink&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_blink)
.field(<span class="string">&quot;bold&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_bold)
.field(<span class="string">&quot;dimmed&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_dimmed)
.field(<span class="string">&quot;hidden&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_hidden)
.field(<span class="string">&quot;italic&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_italic)
.field(<span class="string">&quot;reverse&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_reverse)
.field(<span class="string">&quot;strikethrough&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_strikethrough)
.field(<span class="string">&quot;underline&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_underline)
.finish()
}
<span class="kw">else if </span><span class="self">self</span>.is_plain() {
fmt.write_str(<span class="string">&quot;Style {}&quot;</span>)
}
<span class="kw">else </span>{
fmt.write_str(<span class="string">&quot;Style { &quot;</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">if let </span><span class="prelude-val">Some</span>(fg) = <span class="self">self</span>.foreground {
<span class="kw">if </span>written_anything { fmt.write_str(<span class="string">&quot;, &quot;</span>)<span class="question-mark">? </span>}
written_anything = <span class="bool-val">true</span>;
<span class="macro">write!</span>(fmt, <span class="string">&quot;fg({:?})&quot;</span>, fg)<span class="question-mark">?
</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 { fmt.write_str(<span class="string">&quot;, &quot;</span>)<span class="question-mark">? </span>}
written_anything = <span class="bool-val">true</span>;
<span class="macro">write!</span>(fmt, <span class="string">&quot;on({:?})&quot;</span>, bg)<span class="question-mark">?
</span>}
{
<span class="kw">let </span><span class="kw-2">mut </span>write_flag = |name| {
<span class="kw">if </span>written_anything { fmt.write_str(<span class="string">&quot;, &quot;</span>)<span class="question-mark">? </span>}
written_anything = <span class="bool-val">true</span>;
fmt.write_str(name)
};
<span class="kw">if </span><span class="self">self</span>.is_blink { write_flag(<span class="string">&quot;blink&quot;</span>)<span class="question-mark">? </span>}
<span class="kw">if </span><span class="self">self</span>.is_bold { write_flag(<span class="string">&quot;bold&quot;</span>)<span class="question-mark">? </span>}
<span class="kw">if </span><span class="self">self</span>.is_dimmed { write_flag(<span class="string">&quot;dimmed&quot;</span>)<span class="question-mark">? </span>}
<span class="kw">if </span><span class="self">self</span>.is_hidden { write_flag(<span class="string">&quot;hidden&quot;</span>)<span class="question-mark">? </span>}
<span class="kw">if </span><span class="self">self</span>.is_italic { write_flag(<span class="string">&quot;italic&quot;</span>)<span class="question-mark">? </span>}
<span class="kw">if </span><span class="self">self</span>.is_reverse { write_flag(<span class="string">&quot;reverse&quot;</span>)<span class="question-mark">? </span>}
<span class="kw">if </span><span class="self">self</span>.is_strikethrough { write_flag(<span class="string">&quot;strikethrough&quot;</span>)<span class="question-mark">? </span>}
<span class="kw">if </span><span class="self">self</span>.is_underline { write_flag(<span class="string">&quot;underline&quot;</span>)<span class="question-mark">? </span>}
}
<span class="macro">write!</span>(fmt, <span class="string">&quot; }}&quot;</span>)
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>test {
<span class="kw">use </span>style::Colour::<span class="kw-2">*</span>;
<span class="kw">use </span>style::Style;
<span class="kw">fn </span>style() -&gt; Style {
Style::new()
}
<span class="macro">macro_rules! </span>test {
(<span class="macro-nonterminal">$name</span>: ident: <span class="macro-nonterminal">$obj</span>: expr =&gt; <span class="macro-nonterminal">$result</span>: expr) =&gt; {
<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">$result</span>, <span class="macro">format!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="macro-nonterminal">$obj</span>));
}
};
}
<span class="macro">test!</span>(empty: style() =&gt; <span class="string">&quot;Style {}&quot;</span>);
<span class="macro">test!</span>(bold: style().bold() =&gt; <span class="string">&quot;Style { bold }&quot;</span>);
<span class="macro">test!</span>(italic: style().italic() =&gt; <span class="string">&quot;Style { italic }&quot;</span>);
<span class="macro">test!</span>(both: style().bold().italic() =&gt; <span class="string">&quot;Style { bold, italic }&quot;</span>);
<span class="macro">test!</span>(red: Red.normal() =&gt; <span class="string">&quot;Style { fg(Red) }&quot;</span>);
<span class="macro">test!</span>(redblue: Red.normal().on(RGB(<span class="number">3</span>, <span class="number">2</span>, <span class="number">4</span>)) =&gt; <span class="string">&quot;Style { fg(Red), on(RGB(3, 2, 4)) }&quot;</span>);
<span class="macro">test!</span>(everything:
Red.on(Blue).blink().bold().dimmed().hidden().italic().reverse().strikethrough().underline() =&gt;
<span class="string">&quot;Style { fg(Red), on(Blue), blink, bold, dimmed, hidden, italic, reverse, strikethrough, underline }&quot;</span>);
<span class="attribute">#[test]
</span><span class="kw">fn </span>long_and_detailed() {
<span class="kw">extern crate </span>regex;
<span class="kw">let </span>expected_debug = <span class="string">&quot;Style { fg(Blue), bold }&quot;</span>;
<span class="kw">let </span>expected_pretty_repat = <span class="string">r##&quot;(?x)
Style\s+\{\s+
foreground:\s+Some\(\s+
Blue,?\s+
\),\s+
background:\s+None,\s+
blink:\s+false,\s+
bold:\s+true,\s+
dimmed:\s+false,\s+
hidden:\s+false,\s+
italic:\s+false,\s+
reverse:\s+false,\s+
strikethrough:\s+
false,\s+
underline:\s+false,?\s+
\}&quot;##</span>;
<span class="kw">let </span>re = regex::Regex::new(expected_pretty_repat).unwrap();
<span class="kw">let </span>style = Blue.bold();
<span class="kw">let </span>style_fmt_debug = <span class="macro">format!</span>(<span class="string">&quot;{:?}&quot;</span>, style);
<span class="kw">let </span>style_fmt_pretty = <span class="macro">format!</span>(<span class="string">&quot;{:#?}&quot;</span>, style);
<span class="macro">println!</span>(<span class="string">&quot;style_fmt_debug:\n{}&quot;</span>, style_fmt_debug);
<span class="macro">println!</span>(<span class="string">&quot;style_fmt_pretty:\n{}&quot;</span>, style_fmt_pretty);
<span class="macro">assert_eq!</span>(expected_debug, style_fmt_debug);
<span class="macro">assert!</span>(re.is_match(<span class="kw-2">&amp;</span>style_fmt_pretty));
}
}
</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>