Now a REAL lib

This commit is contained in:
Justine
2023-01-09 19:23:20 +01:00
parent ef46613c71
commit fe9e6f04f5
19014 changed files with 715877 additions and 264 deletions

View File

@ -0,0 +1,184 @@
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-4.0.32/src/output/fmt.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>fmt.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" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../clap/index.html">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><pre class="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>
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::StyledStr</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::util::color::ColorChoice</span>;
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum</span> <span class="ident">Stream</span> {
<span class="ident">Stdout</span>,
<span class="ident">Stderr</span>,
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">Colorizer</span> {
<span class="ident">stream</span>: <span class="ident">Stream</span>,
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused</span>)]</span>
<span class="ident">color_when</span>: <span class="ident">ColorChoice</span>,
<span class="ident">content</span>: <span class="ident">StyledStr</span>,
}
<span class="kw">impl</span> <span class="ident">Colorizer</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">stream</span>: <span class="ident">Stream</span>, <span class="ident">color_when</span>: <span class="ident">ColorChoice</span>) -&gt; <span class="self">Self</span> {
<span class="ident">Colorizer</span> {
<span class="ident">stream</span>,
<span class="ident">color_when</span>,
<span class="ident">content</span>: <span class="ident">Default::default</span>(),
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">with_content</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">content</span>: <span class="ident">StyledStr</span>) -&gt; <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">content</span> <span class="op">=</span> <span class="ident">content</span>;
<span class="self">self</span>
}
}
<span class="doccomment">/// Printing methods.</span>
<span class="kw">impl</span> <span class="ident">Colorizer</span> {
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;color&quot;</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">print</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">std::io::Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
<span class="kw">use</span> <span class="ident">termcolor</span>::{<span class="ident">BufferWriter</span>, <span class="ident">ColorChoice</span> <span class="kw">as</span> <span class="ident">DepColorChoice</span>};
<span class="kw">let</span> <span class="ident">color_when</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">color_when</span> {
<span class="ident">ColorChoice::Always</span> =&gt; <span class="ident">DepColorChoice::Always</span>,
<span class="ident">ColorChoice::Auto</span> <span class="kw">if</span> <span class="ident">is_a_tty</span>(<span class="self">self</span>.<span class="ident">stream</span>) =&gt; <span class="ident">DepColorChoice::Auto</span>,
<span class="kw">_</span> =&gt; <span class="ident">DepColorChoice::Never</span>,
};
<span class="kw">let</span> <span class="ident">writer</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">stream</span> {
<span class="ident">Stream::Stderr</span> =&gt; <span class="ident">BufferWriter::stderr</span>(<span class="ident">color_when</span>),
<span class="ident">Stream::Stdout</span> =&gt; <span class="ident">BufferWriter::stdout</span>(<span class="ident">color_when</span>),
};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">writer</span>.<span class="ident">buffer</span>();
<span class="macro">ok!</span>(<span class="self">self</span>.<span class="ident">content</span>.<span class="ident">write_colored</span>(<span class="kw-2">&amp;mut</span> <span class="ident">buffer</span>));
<span class="ident">writer</span>.<span class="ident">print</span>(<span class="kw-2">&amp;</span><span class="ident">buffer</span>)
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;color&quot;</span>))]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">print</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">std::io::Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
<span class="kw">use</span> <span class="ident">std::io::Write</span>;
<span class="comment">// [e]println can&#39;t be used here because it panics</span>
<span class="comment">// if something went wrong. We don&#39;t want that.</span>
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">stream</span> {
<span class="ident">Stream::Stdout</span> =&gt; {
<span class="kw">let</span> <span class="ident">stdout</span> <span class="op">=</span> <span class="ident">std::io::stdout</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">stdout</span> <span class="op">=</span> <span class="ident">stdout</span>.<span class="ident">lock</span>();
<span class="macro">write!</span>(<span class="ident">stdout</span>, <span class="string">&quot;{}&quot;</span>, <span class="self">self</span>)
}
<span class="ident">Stream::Stderr</span> =&gt; {
<span class="kw">let</span> <span class="ident">stderr</span> <span class="op">=</span> <span class="ident">std::io::stderr</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">stderr</span> <span class="op">=</span> <span class="ident">stderr</span>.<span class="ident">lock</span>();
<span class="macro">write!</span>(<span class="ident">stderr</span>, <span class="string">&quot;{}&quot;</span>, <span class="self">self</span>)
}
}
}
}
<span class="doccomment">/// Color-unaware printing. Never uses coloring.</span>
<span class="kw">impl</span> <span class="ident">std::fmt::Display</span> <span class="kw">for</span> <span class="ident">Colorizer</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&amp;mut</span> <span class="ident">std::fmt::Formatter</span>) -&gt; <span class="ident">std::fmt::Result</span> {
<span class="self">self</span>.<span class="ident">content</span>.<span class="ident">fmt</span>(<span class="ident">f</span>)
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;color&quot;</span>)]</span>
<span class="kw">fn</span> <span class="ident">is_a_tty</span>(<span class="ident">stream</span>: <span class="ident">Stream</span>) -&gt; <span class="ident">bool</span> {
<span class="kw">use</span> <span class="ident">is_terminal::IsTerminal</span>;
<span class="kw">match</span> <span class="ident">stream</span> {
<span class="ident">Stream::Stdout</span> =&gt; <span class="ident">std::io::stdout</span>().<span class="ident">is_terminal</span>(),
<span class="ident">Stream::Stderr</span> =&gt; <span class="ident">std::io::stderr</span>().<span class="ident">is_terminal</span>(),
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

View File

@ -0,0 +1,90 @@
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-4.0.32/src/output/help.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>help.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" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../clap/index.html">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><pre class="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>
</pre><pre class="rust"><code><span class="attribute">#![<span class="ident">cfg_attr</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;help&quot;</span>), <span class="ident">allow</span>(<span class="ident">unused_variables</span>))]</span>
<span class="comment">// Internal</span>
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::Command</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::StyledStr</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::output::Usage</span>;
<span class="doccomment">/// Writes the parser help to the wrapped stream.</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">write_help</span>(<span class="ident">writer</span>: <span class="kw-2">&amp;mut</span> <span class="ident">StyledStr</span>, <span class="ident">cmd</span>: <span class="kw-2">&amp;</span><span class="ident">Command</span>, <span class="ident">usage</span>: <span class="kw-2">&amp;</span><span class="ident">Usage</span><span class="op">&lt;</span><span class="lifetime">&#39;_</span><span class="op">&gt;</span>, <span class="ident">use_long</span>: <span class="ident">bool</span>) {
<span class="macro">debug!</span>(<span class="string">&quot;write_help&quot;</span>);
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">h</span>) <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">get_override_help</span>() {
<span class="ident">writer</span>.<span class="ident">extend</span>(<span class="ident">h</span>.<span class="ident">iter</span>());
} <span class="kw">else</span> {
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;help&quot;</span>)]</span>
{
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::AutoHelp</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::HelpTemplate</span>;
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">tmpl</span>) <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">get_help_template</span>() {
<span class="kw">for</span> (<span class="ident">style</span>, <span class="ident">content</span>) <span class="kw">in</span> <span class="ident">tmpl</span>.<span class="ident">iter</span>() {
<span class="kw">if</span> <span class="ident">style</span>.<span class="ident">is_none</span>() {
<span class="ident">HelpTemplate::new</span>(<span class="ident">writer</span>, <span class="ident">cmd</span>, <span class="ident">usage</span>, <span class="ident">use_long</span>)
.<span class="ident">write_templated_help</span>(<span class="ident">content</span>);
} <span class="kw">else</span> {
<span class="ident">writer</span>.<span class="ident">stylize</span>(<span class="ident">style</span>, <span class="ident">content</span>);
}
}
} <span class="kw">else</span> {
<span class="ident">AutoHelp::new</span>(<span class="ident">writer</span>, <span class="ident">cmd</span>, <span class="ident">usage</span>, <span class="ident">use_long</span>).<span class="ident">write_help</span>();
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;help&quot;</span>))]</span>
{
<span class="macro">debug!</span>(<span class="string">&quot;write_help: no help, `Command::override_help` and `help` is missing&quot;</span>);
}
}
<span class="comment">// Remove any extra lines caused by book keeping</span>
<span class="ident">writer</span>.<span class="ident">trim</span>();
<span class="comment">// Ensure there is still a trailing newline</span>
<span class="ident">writer</span>.<span class="ident">none</span>(<span class="string">&quot;\n&quot;</span>);
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,50 @@
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-4.0.32/src/output/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" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../clap/index.html">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><pre class="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>
</pre><pre class="rust"><code><span class="kw">mod</span> <span class="ident">help</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;help&quot;</span>)]</span>
<span class="kw">mod</span> <span class="ident">help_template</span>;
<span class="kw">mod</span> <span class="ident">usage</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod</span> <span class="ident">fmt</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;help&quot;</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod</span> <span class="ident">textwrap</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident"><span class="self">self</span>::help::write_help</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;help&quot;</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident"><span class="self">self</span>::help_template::AutoHelp</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;help&quot;</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident"><span class="self">self</span>::help_template::HelpTemplate</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;help&quot;</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident"><span class="self">self</span>::textwrap::core::display_width</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;help&quot;</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident"><span class="self">self</span>::textwrap::wrap</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident"><span class="self">self</span>::usage::Usage</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">TAB</span>: <span class="kw-2">&amp;</span><span class="ident">str</span> <span class="op">=</span> <span class="string">&quot; &quot;</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;help&quot;</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">TAB_WIDTH</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="ident">TAB</span>.<span class="ident">len</span>();
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

View File

@ -0,0 +1,320 @@
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-4.0.32/src/output/textwrap/core.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>core.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" type="text/css" href="../../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../../clap/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../../clap/index.html">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><pre class="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>
</pre><pre class="rust"><code><span class="doccomment">/// Compute the display width of `text`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Note:** When the `unicode` Cargo feature is disabled, all characters are presumed to take up</span>
<span class="doccomment">/// 1 width. With the feature enabled, function will correctly deal with [combining characters] in</span>
<span class="doccomment">/// their decomposed form (see [Unicode equivalence]).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// An example of a decomposed character is “é”, which can be decomposed into: “e” followed by a</span>
<span class="doccomment">/// combining acute accent: “◌́”. Without the `unicode` Cargo feature, every `char` has a width of</span>
<span class="doccomment">/// 1. This includes the combining accent:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Emojis and CJK Characters</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Characters such as emojis and [CJK characters] used in the</span>
<span class="doccomment">/// Chinese, Japanese, and Korean languages are seen as double-width,</span>
<span class="doccomment">/// even if the `unicode-width` feature is disabled:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Limitations</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The displayed width of a string cannot always be computed from the</span>
<span class="doccomment">/// string alone. This is because the width depends on the rendering</span>
<span class="doccomment">/// engine used. This is particularly visible with [emoji modifier</span>
<span class="doccomment">/// sequences] where a base emoji is modified with, e.g., skin tone or</span>
<span class="doccomment">/// hair color modifiers. It is up to the rendering engine to detect</span>
<span class="doccomment">/// this and to produce a suitable emoji.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A simple example is “❤️”, which consists of “❤” (U+2764: Black</span>
<span class="doccomment">/// Heart Symbol) followed by U+FE0F (Variation Selector-16). By</span>
<span class="doccomment">/// itself, “❤” is a black heart, but if you follow it with the</span>
<span class="doccomment">/// variant selector, you may get a wider red heart.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A more complex example would be “👨‍🦰” which should depict a man</span>
<span class="doccomment">/// with red hair. Here the computed width is too large — and the</span>
<span class="doccomment">/// width differs depending on the use of the `unicode-width` feature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This happens because the grapheme consists of three code points:</span>
<span class="doccomment">/// “👨” (U+1F468: Man), Zero Width Joiner (U+200D), and “🦰”</span>
<span class="doccomment">/// (U+1F9B0: Red Hair). You can see them above in the test. With</span>
<span class="doccomment">/// `unicode-width` enabled, the ZWJ is correctly seen as having zero</span>
<span class="doccomment">/// width, without it is counted as a double-width character.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Terminal Support</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Modern browsers typically do a great job at combining characters</span>
<span class="doccomment">/// as shown above, but terminals often struggle more. As an example,</span>
<span class="doccomment">/// Gnome Terminal version 3.38.1, shows “❤️” as a big red heart, but</span>
<span class="doccomment">/// shows &quot;👨‍🦰&quot; as “👨🦰”.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [combining characters]: https://en.wikipedia.org/wiki/Combining_character</span>
<span class="doccomment">/// [Unicode equivalence]: https://en.wikipedia.org/wiki/Unicode_equivalence</span>
<span class="doccomment">/// [CJK characters]: https://en.wikipedia.org/wiki/CJK_characters</span>
<span class="doccomment">/// [emoji modifier sequences]: https://unicode.org/emoji/charts/full-emoji-modifiers.html</span>
<span class="attribute">#[<span class="ident">inline</span>(<span class="ident">never</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">display_width</span>(<span class="ident">text</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>) -&gt; <span class="ident">usize</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">width</span> <span class="op">=</span> <span class="number">0</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">control_sequence</span> <span class="op">=</span> <span class="bool-val">false</span>;
<span class="kw">let</span> <span class="ident">control_terminate</span>: <span class="ident">char</span> <span class="op">=</span> <span class="string">&#39;m&#39;</span>;
<span class="kw">for</span> <span class="ident">ch</span> <span class="kw">in</span> <span class="ident">text</span>.<span class="ident">chars</span>() {
<span class="kw">if</span> <span class="ident">ch</span>.<span class="ident">is_ascii_control</span>() {
<span class="ident">control_sequence</span> <span class="op">=</span> <span class="bool-val">true</span>;
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">control_sequence</span> <span class="op">&amp;&amp;</span> <span class="ident">ch</span> <span class="op">==</span> <span class="ident">control_terminate</span> {
<span class="ident">control_sequence</span> <span class="op">=</span> <span class="bool-val">false</span>;
<span class="kw">continue</span>;
}
<span class="kw">if</span> <span class="op">!</span><span class="ident">control_sequence</span> {
<span class="ident">width</span> <span class="op">+</span><span class="op">=</span> <span class="ident">ch_width</span>(<span class="ident">ch</span>);
}
}
<span class="ident">width</span>
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>)]</span>
<span class="kw">fn</span> <span class="ident">ch_width</span>(<span class="ident">ch</span>: <span class="ident">char</span>) -&gt; <span class="ident">usize</span> {
<span class="ident">unicode_width::UnicodeWidthChar::width</span>(<span class="ident">ch</span>).<span class="ident">unwrap_or</span>(<span class="number">0</span>)
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>))]</span>
<span class="kw">fn</span> <span class="ident">ch_width</span>(<span class="kw">_</span>: <span class="ident">char</span>) -&gt; <span class="ident">usize</span> {
<span class="number">1</span>
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>)]</span>
<span class="kw">use</span> <span class="ident">unicode_width::UnicodeWidthChar</span>;
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">emojis_have_correct_width</span>() {
<span class="kw">use</span> <span class="ident">unic_emoji_char::is_emoji</span>;
<span class="comment">// Emojis in the Basic Latin (ASCII) and Latin-1 Supplement</span>
<span class="comment">// blocks all have a width of 1 column. This includes</span>
<span class="comment">// characters such as &#39;#&#39; and &#39;©&#39;.</span>
<span class="kw">for</span> <span class="ident">ch</span> <span class="kw">in</span> <span class="string">&#39;\u{1}&#39;</span>..<span class="string">&#39;\u{FF}&#39;</span> {
<span class="kw">if</span> <span class="ident">is_emoji</span>(<span class="ident">ch</span>) {
<span class="kw">let</span> <span class="ident">desc</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">&quot;{:?} U+{:04X}&quot;</span>, <span class="ident">ch</span>, <span class="ident">ch</span> <span class="kw">as</span> <span class="ident">u32</span>);
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>)]</span>
<span class="macro">assert_eq!</span>(<span class="ident">ch</span>.<span class="ident">width</span>().<span class="ident">unwrap</span>(), <span class="number">1</span>, <span class="string">&quot;char: {}&quot;</span>, <span class="ident">desc</span>);
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>))]</span>
<span class="macro">assert_eq!</span>(<span class="ident">ch_width</span>(<span class="ident">ch</span>), <span class="number">1</span>, <span class="string">&quot;char: {}&quot;</span>, <span class="ident">desc</span>);
}
}
<span class="comment">// Emojis in the remaining blocks of the Basic Multilingual</span>
<span class="comment">// Plane (BMP), in the Supplementary Multilingual Plane (SMP),</span>
<span class="comment">// and in the Supplementary Ideographic Plane (SIP), are all 1</span>
<span class="comment">// or 2 columns wide when unicode-width is used, and always 2</span>
<span class="comment">// columns wide otherwise. This includes all of our favorite</span>
<span class="comment">// emojis such as 😊.</span>
<span class="kw">for</span> <span class="ident">ch</span> <span class="kw">in</span> <span class="string">&#39;\u{FF}&#39;</span>..<span class="string">&#39;\u{2FFFF}&#39;</span> {
<span class="kw">if</span> <span class="ident">is_emoji</span>(<span class="ident">ch</span>) {
<span class="kw">let</span> <span class="ident">desc</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">&quot;{:?} U+{:04X}&quot;</span>, <span class="ident">ch</span>, <span class="ident">ch</span> <span class="kw">as</span> <span class="ident">u32</span>);
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>)]</span>
<span class="macro">assert!</span>(<span class="ident">ch</span>.<span class="ident">width</span>().<span class="ident">unwrap</span>() <span class="op">&lt;</span><span class="op">=</span> <span class="number">2</span>, <span class="string">&quot;char: {}&quot;</span>, <span class="ident">desc</span>);
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>))]</span>
<span class="macro">assert_eq!</span>(<span class="ident">ch_width</span>(<span class="ident">ch</span>), <span class="number">1</span>, <span class="string">&quot;char: {}&quot;</span>, <span class="ident">desc</span>);
}
}
<span class="comment">// The remaining planes contain almost no assigned code points</span>
<span class="comment">// and thus also no emojis.</span>
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>)]</span>
<span class="kw">fn</span> <span class="ident">display_width_works</span>() {
<span class="macro">assert_eq!</span>(<span class="string">&quot;Café Plain&quot;</span>.<span class="ident">len</span>(), <span class="number">11</span>); <span class="comment">// “é” is two bytes</span>
<span class="macro">assert_eq!</span>(<span class="ident">display_width</span>(<span class="string">&quot;Café Plain&quot;</span>), <span class="number">10</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>)]</span>
<span class="kw">fn</span> <span class="ident">display_width_narrow_emojis</span>() {
<span class="macro">assert_eq!</span>(<span class="ident">display_width</span>(<span class="string">&quot;&quot;</span>), <span class="number">1</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>)]</span>
<span class="kw">fn</span> <span class="ident">display_width_narrow_emojis_variant_selector</span>() {
<span class="macro">assert_eq!</span>(<span class="ident">display_width</span>(<span class="string">&quot;⁉\u{fe0f}&quot;</span>), <span class="number">1</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;unicode&quot;</span>)]</span>
<span class="kw">fn</span> <span class="ident">display_width_emojis</span>() {
<span class="macro">assert_eq!</span>(<span class="ident">display_width</span>(<span class="string">&quot;😂😭🥺🤣✨😍🙏🥰😊🔥&quot;</span>), <span class="number">20</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

View File

@ -0,0 +1,248 @@
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-4.0.32/src/output/textwrap/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" type="text/css" href="../../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../../clap/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../../clap/index.html">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><pre class="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>
</pre><pre class="rust"><code><span class="doccomment">//! Fork of `textwrap` crate</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Benefits of forking:</span>
<span class="doccomment">//! - Pull in only what we need rather than relying on the compiler to remove what we don&#39;t need</span>
<span class="doccomment">//! - `LineWrapper` is able to incrementally wrap which will help with `StyledStr</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod</span> <span class="ident">core</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;wrap_help&quot;</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod</span> <span class="ident">word_separators</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;wrap_help&quot;</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod</span> <span class="ident">wrap_algorithms</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;wrap_help&quot;</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">wrap</span>(<span class="ident">content</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="ident">hard_width</span>: <span class="ident">usize</span>) -&gt; <span class="ident">String</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">wrapper</span> <span class="op">=</span> <span class="ident">wrap_algorithms::LineWrapper::new</span>(<span class="ident">hard_width</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">total</span> <span class="op">=</span> <span class="ident">Vec::new</span>();
<span class="kw">for</span> <span class="ident">line</span> <span class="kw">in</span> <span class="ident">content</span>.<span class="ident">split_inclusive</span>(<span class="string">&#39;\n&#39;</span>) {
<span class="ident">wrapper</span>.<span class="ident">reset</span>();
<span class="kw">let</span> <span class="ident">line</span> <span class="op">=</span> <span class="ident">word_separators::find_words_ascii_space</span>(<span class="ident">line</span>).<span class="ident">collect</span>::<span class="op">&lt;</span><span class="ident">Vec</span><span class="op">&lt;</span><span class="kw">_</span><span class="op">&gt;</span><span class="op">&gt;</span>();
<span class="ident">total</span>.<span class="ident">extend</span>(<span class="ident">wrapper</span>.<span class="ident">wrap</span>(<span class="ident">line</span>));
}
<span class="ident">total</span>.<span class="ident">join</span>(<span class="string">&quot;&quot;</span>)
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;wrap_help&quot;</span>))]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">wrap</span>(<span class="ident">content</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="ident">_hard_width</span>: <span class="ident">usize</span>) -&gt; <span class="ident">String</span> {
<span class="ident">content</span>.<span class="ident">to_owned</span>()
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;wrap_help&quot;</span>)]</span>
<span class="kw">mod</span> <span class="ident">test</span> {
<span class="doccomment">/// Compatibility shim to keep textwrap&#39;s tests</span>
<span class="kw">fn</span> <span class="ident">wrap</span>(<span class="ident">content</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="ident">hard_width</span>: <span class="ident">usize</span>) -&gt; <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span> {
<span class="ident"><span class="kw">super</span>::wrap</span>(<span class="ident">content</span>, <span class="ident">hard_width</span>)
.<span class="ident">trim_end</span>()
.<span class="ident">split</span>(<span class="string">&#39;\n&#39;</span>)
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="ident">s</span>.<span class="ident">to_owned</span>())
.<span class="ident">collect</span>::<span class="op">&lt;</span><span class="ident">Vec</span><span class="op">&lt;</span><span class="kw">_</span><span class="op">&gt;</span><span class="op">&gt;</span>()
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">no_wrap</span>() {
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="string">&quot;foo&quot;</span>, <span class="number">10</span>), <span class="macro">vec!</span>[<span class="string">&quot;foo&quot;</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">wrap_simple</span>() {
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="string">&quot;foo bar baz&quot;</span>, <span class="number">5</span>), <span class="macro">vec!</span>[<span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>, <span class="string">&quot;baz&quot;</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">to_be_or_not</span>() {
<span class="macro">assert_eq!</span>(
<span class="ident">wrap</span>(<span class="string">&quot;To be, or not to be, that is the question.&quot;</span>, <span class="number">10</span>),
<span class="macro">vec!</span>[<span class="string">&quot;To be, or&quot;</span>, <span class="string">&quot;not to be,&quot;</span>, <span class="string">&quot;that is&quot;</span>, <span class="string">&quot;the&quot;</span>, <span class="string">&quot;question.&quot;</span>]
);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">multiple_words_on_first_line</span>() {
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="string">&quot;foo bar baz&quot;</span>, <span class="number">10</span>), <span class="macro">vec!</span>[<span class="string">&quot;foo bar&quot;</span>, <span class="string">&quot;baz&quot;</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">long_word</span>() {
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="string">&quot;foo&quot;</span>, <span class="number">0</span>), <span class="macro">vec!</span>[<span class="string">&quot;foo&quot;</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">long_words</span>() {
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="string">&quot;foo bar&quot;</span>, <span class="number">0</span>), <span class="macro">vec!</span>[<span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">max_width</span>() {
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="string">&quot;foo bar&quot;</span>, <span class="ident">usize::MAX</span>), <span class="macro">vec!</span>[<span class="string">&quot;foo bar&quot;</span>]);
<span class="kw">let</span> <span class="ident">text</span> <span class="op">=</span> <span class="string">&quot;Hello there! This is some English text. \
It should not be wrapped given the extents below.&quot;</span>;
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="ident">text</span>, <span class="ident">usize::MAX</span>), <span class="macro">vec!</span>[<span class="ident">text</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">leading_whitespace</span>() {
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="string">&quot; foo bar&quot;</span>, <span class="number">6</span>), <span class="macro">vec!</span>[<span class="string">&quot; foo&quot;</span>, <span class="string">&quot;bar&quot;</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">leading_whitespace_empty_first_line</span>() {
<span class="comment">// If there is no space for the first word, the first line</span>
<span class="comment">// will be empty. This is because the string is split into</span>
<span class="comment">// words like [&quot; &quot;, &quot;foobar &quot;, &quot;baz&quot;], which puts &quot;foobar &quot; on</span>
<span class="comment">// the second line. We never output trailing whitespace</span>
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="string">&quot; foobar baz&quot;</span>, <span class="number">6</span>), <span class="macro">vec!</span>[<span class="string">&quot;&quot;</span>, <span class="string">&quot;foobar&quot;</span>, <span class="string">&quot;baz&quot;</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">trailing_whitespace</span>() {
<span class="comment">// Whitespace is only significant inside a line. After a line</span>
<span class="comment">// gets too long and is broken, the first word starts in</span>
<span class="comment">// column zero and is not indented.</span>
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="string">&quot;foo bar baz &quot;</span>, <span class="number">5</span>), <span class="macro">vec!</span>[<span class="string">&quot;foo&quot;</span>, <span class="string">&quot;bar&quot;</span>, <span class="string">&quot;baz&quot;</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">issue_99</span>() {
<span class="comment">// We did not reset the in_whitespace flag correctly and did</span>
<span class="comment">// not handle single-character words after a line break.</span>
<span class="macro">assert_eq!</span>(
<span class="ident">wrap</span>(<span class="string">&quot;aaabbbccc x yyyzzzwww&quot;</span>, <span class="number">9</span>),
<span class="macro">vec!</span>[<span class="string">&quot;aaabbbccc&quot;</span>, <span class="string">&quot;x&quot;</span>, <span class="string">&quot;yyyzzzwww&quot;</span>]
);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">issue_129</span>() {
<span class="comment">// The dash is an em-dash which takes up four bytes. We used</span>
<span class="comment">// to panic since we tried to index into the character.</span>
<span class="macro">assert_eq!</span>(<span class="ident">wrap</span>(<span class="string">&quot;x x&quot;</span>, <span class="number">1</span>), <span class="macro">vec!</span>[<span class="string">&quot;x&quot;</span>, <span class="string">&quot;&quot;</span>, <span class="string">&quot;x&quot;</span>]);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>

View File

@ -0,0 +1,886 @@
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-4.0.32/src/output/usage.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>usage.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" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../clap/index.html">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
</pre><pre class="rust"><code><span class="attribute">#![<span class="ident">cfg_attr</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;usage&quot;</span>), <span class="ident">allow</span>(<span class="ident">unused_imports</span>))]</span>
<span class="attribute">#![<span class="ident">cfg_attr</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;usage&quot;</span>), <span class="ident">allow</span>(<span class="ident">unused_variables</span>))]</span>
<span class="attribute">#![<span class="ident">cfg_attr</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;usage&quot;</span>), <span class="ident">allow</span>(<span class="ident">clippy::manual_map</span>))]</span>
<span class="attribute">#![<span class="ident">cfg_attr</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;usage&quot;</span>), <span class="ident">allow</span>(<span class="ident">dead_code</span>))]</span>
<span class="comment">// Internal</span>
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::StyledStr</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder</span>::{<span class="ident">ArgPredicate</span>, <span class="ident">Command</span>};
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::parser::ArgMatcher</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::util::ChildGraph</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::util::FlatSet</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::util::Id</span>;
<span class="kw">static</span> <span class="ident">DEFAULT_SUB_VALUE_NAME</span>: <span class="kw-2">&amp;</span><span class="ident">str</span> <span class="op">=</span> <span class="string">&quot;COMMAND&quot;</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">Usage</span><span class="op">&lt;</span><span class="lifetime">&#39;cmd</span><span class="op">&gt;</span> {
<span class="ident">cmd</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;cmd</span> <span class="ident">Command</span>,
<span class="ident">required</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="lifetime">&#39;cmd</span> <span class="ident">ChildGraph</span><span class="op">&lt;</span><span class="ident">Id</span><span class="op">&gt;</span><span class="op">&gt;</span>,
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;cmd</span><span class="op">&gt;</span> <span class="ident">Usage</span><span class="op">&lt;</span><span class="lifetime">&#39;cmd</span><span class="op">&gt;</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">cmd</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;cmd</span> <span class="ident">Command</span>) -&gt; <span class="self">Self</span> {
<span class="ident">Usage</span> {
<span class="ident">cmd</span>,
<span class="ident">required</span>: <span class="prelude-val">None</span>,
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">required</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">required</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;cmd</span> <span class="ident">ChildGraph</span><span class="op">&lt;</span><span class="ident">Id</span><span class="op">&gt;</span>) -&gt; <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">required</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">required</span>);
<span class="self">self</span>
}
<span class="comment">// Creates a usage string for display. This happens just after all arguments were parsed, but before</span>
<span class="comment">// any subcommands have been parsed (so as to give subcommands their own usage recursively)</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">create_usage_with_title</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">used</span>: <span class="kw-2">&amp;</span>[<span class="ident">Id</span>]) -&gt; <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">StyledStr</span><span class="op">&gt;</span> {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::create_usage_with_title&quot;</span>);
<span class="kw">let</span> <span class="ident">usage</span> <span class="op">=</span> <span class="macro">some!</span>(<span class="self">self</span>.<span class="ident">create_usage_no_title</span>(<span class="ident">used</span>));
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">styled</span> <span class="op">=</span> <span class="ident">StyledStr::new</span>();
<span class="ident">styled</span>.<span class="ident">header</span>(<span class="string">&quot;Usage:&quot;</span>);
<span class="ident">styled</span>.<span class="ident">none</span>(<span class="string">&quot; &quot;</span>);
<span class="ident">styled</span>.<span class="ident">extend</span>(<span class="ident">usage</span>.<span class="ident">into_iter</span>());
<span class="prelude-val">Some</span>(<span class="ident">styled</span>)
}
<span class="comment">// Creates a usage string (*without title*) if one was not provided by the user manually.</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">create_usage_no_title</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">used</span>: <span class="kw-2">&amp;</span>[<span class="ident">Id</span>]) -&gt; <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">StyledStr</span><span class="op">&gt;</span> {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::create_usage_no_title&quot;</span>);
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">u</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">get_override_usage</span>() {
<span class="prelude-val">Some</span>(<span class="ident">u</span>.<span class="ident">clone</span>())
} <span class="kw">else</span> {
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;usage&quot;</span>)]</span>
{
<span class="kw">if</span> <span class="ident">used</span>.<span class="ident">is_empty</span>() {
<span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="ident">create_help_usage</span>(<span class="bool-val">true</span>))
} <span class="kw">else</span> {
<span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="ident">create_smart_usage</span>(<span class="ident">used</span>))
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;usage&quot;</span>))]</span>
{
<span class="prelude-val">None</span>
}
}
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;usage&quot;</span>)]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;cmd</span><span class="op">&gt;</span> <span class="ident">Usage</span><span class="op">&lt;</span><span class="lifetime">&#39;cmd</span><span class="op">&gt;</span> {
<span class="comment">// Creates a usage string for display in help messages (i.e. not for errors)</span>
<span class="kw">fn</span> <span class="ident">create_help_usage</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">incl_reqs</span>: <span class="ident">bool</span>) -&gt; <span class="ident">StyledStr</span> {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::create_help_usage; incl_reqs={:?}&quot;</span>, <span class="ident">incl_reqs</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">styled</span> <span class="op">=</span> <span class="ident">StyledStr::new</span>();
<span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="self">self</span>
.<span class="ident">cmd</span>
.<span class="ident">get_usage_name</span>()
.<span class="ident">or_else</span>(<span class="op">|</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">get_bin_name</span>())
.<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">get_name</span>());
<span class="ident">styled</span>.<span class="ident">literal</span>(<span class="ident">name</span>);
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">needs_options_tag</span>() {
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="string">&quot; [OPTIONS]&quot;</span>);
}
<span class="self">self</span>.<span class="ident">write_args</span>(<span class="kw-2">&amp;</span>[], <span class="op">!</span><span class="ident">incl_reqs</span>, <span class="kw-2">&amp;mut</span> <span class="ident">styled</span>);
<span class="comment">// incl_reqs is only false when this function is called recursively</span>
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">has_visible_subcommands</span>() <span class="op">&amp;&amp;</span> <span class="ident">incl_reqs</span>
<span class="op">|</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">is_allow_external_subcommands_set</span>()
{
<span class="kw">let</span> <span class="ident">placeholder</span> <span class="op">=</span> <span class="self">self</span>
.<span class="ident">cmd</span>
.<span class="ident">get_subcommand_value_name</span>()
.<span class="ident">unwrap_or</span>(<span class="ident">DEFAULT_SUB_VALUE_NAME</span>);
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">is_subcommand_negates_reqs_set</span>()
<span class="op">|</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">is_args_conflicts_with_subcommands_set</span>()
{
<span class="ident">styled</span>.<span class="ident">none</span>(<span class="string">&quot;\n&quot;</span>);
<span class="ident">styled</span>.<span class="ident">none</span>(<span class="string">&quot; &quot;</span>);
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">is_args_conflicts_with_subcommands_set</span>() {
<span class="comment">// Short-circuit full usage creation since no args will be relevant</span>
<span class="ident">styled</span>.<span class="ident">literal</span>(<span class="ident">name</span>);
} <span class="kw">else</span> {
<span class="ident">styled</span>.<span class="ident">extend</span>(<span class="self">self</span>.<span class="ident">create_help_usage</span>(<span class="bool-val">false</span>).<span class="ident">into_iter</span>());
}
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="string">&quot; &lt;&quot;</span>);
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="ident">placeholder</span>);
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="string">&quot;&gt;&quot;</span>);
} <span class="kw">else</span> <span class="kw">if</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">is_subcommand_required_set</span>() {
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="string">&quot; &lt;&quot;</span>);
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="ident">placeholder</span>);
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="string">&quot;&gt;&quot;</span>);
} <span class="kw">else</span> {
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="string">&quot; [&quot;</span>);
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="ident">placeholder</span>);
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="string">&quot;]&quot;</span>);
}
}
<span class="ident">styled</span>.<span class="ident">trim</span>();
<span class="macro">debug!</span>(<span class="string">&quot;Usage::create_help_usage: usage={}&quot;</span>, <span class="ident">styled</span>);
<span class="ident">styled</span>
}
<span class="comment">// Creates a context aware usage string, or &quot;smart usage&quot; from currently used</span>
<span class="comment">// args, and requirements</span>
<span class="kw">fn</span> <span class="ident">create_smart_usage</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">used</span>: <span class="kw-2">&amp;</span>[<span class="ident">Id</span>]) -&gt; <span class="ident">StyledStr</span> {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::create_smart_usage&quot;</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">styled</span> <span class="op">=</span> <span class="ident">StyledStr::new</span>();
<span class="ident">styled</span>.<span class="ident">literal</span>(
<span class="self">self</span>.<span class="ident">cmd</span>
.<span class="ident">get_usage_name</span>()
.<span class="ident">or_else</span>(<span class="op">|</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">get_bin_name</span>())
.<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">get_name</span>()),
);
<span class="self">self</span>.<span class="ident">write_args</span>(<span class="ident">used</span>, <span class="bool-val">false</span>, <span class="kw-2">&amp;mut</span> <span class="ident">styled</span>);
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">is_subcommand_required_set</span>() {
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="string">&quot; &lt;&quot;</span>);
<span class="ident">styled</span>.<span class="ident">placeholder</span>(
<span class="self">self</span>.<span class="ident">cmd</span>
.<span class="ident">get_subcommand_value_name</span>()
.<span class="ident">unwrap_or</span>(<span class="ident">DEFAULT_SUB_VALUE_NAME</span>),
);
<span class="ident">styled</span>.<span class="ident">placeholder</span>(<span class="string">&quot;&gt;&quot;</span>);
}
<span class="ident">styled</span>
}
<span class="comment">// Determines if we need the `[OPTIONS]` tag in the usage string</span>
<span class="kw">fn</span> <span class="ident">needs_options_tag</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::needs_options_tag&quot;</span>);
<span class="lifetime">&#39;outer</span>: <span class="kw">for</span> <span class="ident">f</span> <span class="kw">in</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">get_non_positionals</span>() {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::needs_options_tag:iter: f={}&quot;</span>, <span class="ident">f</span>.<span class="ident">get_id</span>());
<span class="comment">// Don&#39;t print `[OPTIONS]` just for help or version</span>
<span class="kw">if</span> <span class="ident">f</span>.<span class="ident">get_long</span>() <span class="op">==</span> <span class="prelude-val">Some</span>(<span class="string">&quot;help&quot;</span>) <span class="op">|</span><span class="op">|</span> <span class="ident">f</span>.<span class="ident">get_long</span>() <span class="op">==</span> <span class="prelude-val">Some</span>(<span class="string">&quot;version&quot;</span>) {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::needs_options_tag:iter Option is built-in&quot;</span>);
<span class="kw">continue</span>;
}
<span class="kw">if</span> <span class="ident">f</span>.<span class="ident">is_hide_set</span>() {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::needs_options_tag:iter Option is hidden&quot;</span>);
<span class="kw">continue</span>;
}
<span class="kw">if</span> <span class="ident">f</span>.<span class="ident">is_required_set</span>() {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::needs_options_tag:iter Option is required&quot;</span>);
<span class="kw">continue</span>;
}
<span class="kw">for</span> <span class="ident">grp_s</span> <span class="kw">in</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">groups_for_arg</span>(<span class="ident">f</span>.<span class="ident">get_id</span>()) {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::needs_options_tag:iter:iter: grp_s={:?}&quot;</span>, <span class="ident">grp_s</span>);
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">get_groups</span>().<span class="ident">any</span>(<span class="op">|</span><span class="ident">g</span><span class="op">|</span> <span class="ident">g</span>.<span class="ident">id</span> <span class="op">==</span> <span class="ident">grp_s</span> <span class="op">&amp;&amp;</span> <span class="ident">g</span>.<span class="ident">required</span>) {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::needs_options_tag:iter:iter: Group is required&quot;</span>);
<span class="kw">continue</span> <span class="lifetime">&#39;outer</span>;
}
}
<span class="macro">debug!</span>(<span class="string">&quot;Usage::needs_options_tag:iter: [OPTIONS] required&quot;</span>);
<span class="kw">return</span> <span class="bool-val">true</span>;
}
<span class="macro">debug!</span>(<span class="string">&quot;Usage::needs_options_tag: [OPTIONS] not required&quot;</span>);
<span class="bool-val">false</span>
}
<span class="comment">// Returns the required args in usage string form by fully unrolling all groups</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">write_args</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">incls</span>: <span class="kw-2">&amp;</span>[<span class="ident">Id</span>], <span class="ident">force_optional</span>: <span class="ident">bool</span>, <span class="ident">styled</span>: <span class="kw-2">&amp;mut</span> <span class="ident">StyledStr</span>) {
<span class="kw">for</span> <span class="ident">required</span> <span class="kw">in</span> <span class="self">self</span>.<span class="ident">get_args</span>(<span class="ident">incls</span>, <span class="ident">force_optional</span>) {
<span class="ident">styled</span>.<span class="ident">none</span>(<span class="string">&quot; &quot;</span>);
<span class="ident">styled</span>.<span class="ident">extend</span>(<span class="ident">required</span>.<span class="ident">into_iter</span>());
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">get_args</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">incls</span>: <span class="kw-2">&amp;</span>[<span class="ident">Id</span>], <span class="ident">force_optional</span>: <span class="ident">bool</span>) -&gt; <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">StyledStr</span><span class="op">&gt;</span> {
<span class="macro">debug!</span>(<span class="string">&quot;Usage::get_args: incls={:?}&quot;</span>, <span class="ident">incls</span>,);
<span class="kw">let</span> <span class="ident">required_owned</span>;
<span class="kw">let</span> <span class="ident">required</span> <span class="op">=</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">required</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">required</span> {
<span class="ident">required</span>
} <span class="kw">else</span> {
<span class="ident">required_owned</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">required_graph</span>();
<span class="kw-2">&amp;</span><span class="ident">required_owned</span>
};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">unrolled_reqs</span> <span class="op">=</span> <span class="ident">Vec::new</span>();
<span class="kw">for</span> <span class="ident">a</span> <span class="kw">in</span> <span class="ident">required</span>.<span class="ident">iter</span>() {
<span class="kw">let</span> <span class="ident">is_relevant</span> <span class="op">=</span> <span class="op">|</span>(<span class="ident">val</span>, <span class="ident">req_arg</span>): <span class="kw-2">&amp;</span>(<span class="ident">ArgPredicate</span>, <span class="ident">Id</span>)<span class="op">|</span> -&gt; <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">Id</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">required</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">val</span> {
<span class="ident">ArgPredicate::Equals</span>(<span class="kw">_</span>) =&gt; <span class="bool-val">false</span>,
<span class="ident">ArgPredicate::IsPresent</span> =&gt; <span class="bool-val">true</span>,
};
<span class="ident">required</span>.<span class="ident">then</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">req_arg</span>.<span class="ident">clone</span>())
};
<span class="kw">for</span> <span class="ident">aa</span> <span class="kw">in</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">unroll_arg_requires</span>(<span class="ident">is_relevant</span>, <span class="ident">a</span>) {
<span class="comment">// if we don&#39;t check for duplicates here this causes duplicate error messages</span>
<span class="comment">// see https://github.com/clap-rs/clap/issues/2770</span>
<span class="ident">unrolled_reqs</span>.<span class="ident">push</span>(<span class="ident">aa</span>);
}
<span class="comment">// always include the required arg itself. it will not be enumerated</span>
<span class="comment">// by unroll_requirements_for_arg.</span>
<span class="ident">unrolled_reqs</span>.<span class="ident">push</span>(<span class="ident">a</span>.<span class="ident">clone</span>());
}
<span class="macro">debug!</span>(<span class="string">&quot;Usage::get_args: unrolled_reqs={:?}&quot;</span>, <span class="ident">unrolled_reqs</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">required_groups_members</span> <span class="op">=</span> <span class="ident">FlatSet::new</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">required_groups</span> <span class="op">=</span> <span class="ident">FlatSet::new</span>();
<span class="kw">for</span> <span class="ident">req</span> <span class="kw">in</span> <span class="ident">unrolled_reqs</span>.<span class="ident">iter</span>().<span class="ident">chain</span>(<span class="ident">incls</span>.<span class="ident">iter</span>()) {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">find_group</span>(<span class="ident">req</span>).<span class="ident">is_some</span>() {
<span class="kw">let</span> <span class="ident">group_members</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">unroll_args_in_group</span>(<span class="ident">req</span>);
<span class="kw">let</span> <span class="ident">elem</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">format_group</span>(<span class="ident">req</span>);
<span class="ident">required_groups</span>.<span class="ident">insert</span>(<span class="ident">elem</span>);
<span class="ident">required_groups_members</span>.<span class="ident">extend</span>(<span class="ident">group_members</span>);
} <span class="kw">else</span> {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">find</span>(<span class="ident">req</span>).<span class="ident">is_some</span>());
}
}
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">required_opts</span> <span class="op">=</span> <span class="ident">FlatSet::new</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">required_positionals</span> <span class="op">=</span> <span class="ident">Vec::new</span>();
<span class="kw">for</span> <span class="ident">req</span> <span class="kw">in</span> <span class="ident">unrolled_reqs</span>.<span class="ident">iter</span>().<span class="ident">chain</span>(<span class="ident">incls</span>.<span class="ident">iter</span>()) {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">arg</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">find</span>(<span class="ident">req</span>) {
<span class="kw">if</span> <span class="ident">required_groups_members</span>.<span class="ident">contains</span>(<span class="ident">arg</span>.<span class="ident">get_id</span>()) {
<span class="kw">continue</span>;
}
<span class="kw">let</span> <span class="ident">stylized</span> <span class="op">=</span> <span class="ident">arg</span>.<span class="ident">stylized</span>(<span class="prelude-val">Some</span>(<span class="op">!</span><span class="ident">force_optional</span>));
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">index</span>) <span class="op">=</span> <span class="ident">arg</span>.<span class="ident">get_index</span>() {
<span class="kw">let</span> <span class="ident">new_len</span> <span class="op">=</span> <span class="ident">index</span> <span class="op">+</span> <span class="number">1</span>;
<span class="kw">if</span> <span class="ident">required_positionals</span>.<span class="ident">len</span>() <span class="op">&lt;</span> <span class="ident">new_len</span> {
<span class="ident">required_positionals</span>.<span class="ident">resize</span>(<span class="ident">new_len</span>, <span class="prelude-val">None</span>);
}
<span class="ident">required_positionals</span>[<span class="ident">index</span>] <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">stylized</span>);
} <span class="kw">else</span> {
<span class="ident">required_opts</span>.<span class="ident">insert</span>(<span class="ident">stylized</span>);
}
} <span class="kw">else</span> {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">find_group</span>(<span class="ident">req</span>).<span class="ident">is_some</span>());
}
}
<span class="kw">for</span> <span class="ident">pos</span> <span class="kw">in</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">get_positionals</span>() {
<span class="kw">if</span> <span class="ident">pos</span>.<span class="ident">is_hide_set</span>() {
<span class="kw">continue</span>;
}
<span class="kw">if</span> <span class="ident">required_groups_members</span>.<span class="ident">contains</span>(<span class="ident">pos</span>.<span class="ident">get_id</span>()) {
<span class="kw">continue</span>;
}
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="ident">pos</span>.<span class="ident">get_index</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">new_len</span> <span class="op">=</span> <span class="ident">index</span> <span class="op">+</span> <span class="number">1</span>;
<span class="kw">if</span> <span class="ident">required_positionals</span>.<span class="ident">len</span>() <span class="op">&lt;</span> <span class="ident">new_len</span> {
<span class="ident">required_positionals</span>.<span class="ident">resize</span>(<span class="ident">new_len</span>, <span class="prelude-val">None</span>);
}
<span class="kw">if</span> <span class="ident">required_positionals</span>[<span class="ident">index</span>].<span class="ident">is_some</span>() {
<span class="kw">if</span> <span class="ident">pos</span>.<span class="ident">is_last_set</span>() {
<span class="kw">let</span> <span class="ident">styled</span> <span class="op">=</span> <span class="ident">required_positionals</span>[<span class="ident">index</span>].<span class="ident">take</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">new</span> <span class="op">=</span> <span class="ident">StyledStr::new</span>();
<span class="ident">new</span>.<span class="ident">literal</span>(<span class="string">&quot;-- &quot;</span>);
<span class="ident">new</span>.<span class="ident">extend</span>(<span class="ident">styled</span>.<span class="ident">into_iter</span>());
<span class="ident">required_positionals</span>[<span class="ident">index</span>] <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">new</span>);
}
} <span class="kw">else</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">styled</span>;
<span class="kw">if</span> <span class="ident">pos</span>.<span class="ident">is_last_set</span>() {
<span class="ident">styled</span> <span class="op">=</span> <span class="ident">StyledStr::new</span>();
<span class="ident">styled</span>.<span class="ident">literal</span>(<span class="string">&quot;[-- &quot;</span>);
<span class="ident">styled</span>.<span class="ident">extend</span>(<span class="ident">pos</span>.<span class="ident">stylized</span>(<span class="prelude-val">Some</span>(<span class="bool-val">true</span>)).<span class="ident">into_iter</span>());
<span class="ident">styled</span>.<span class="ident">literal</span>(<span class="string">&quot;]&quot;</span>);
} <span class="kw">else</span> {
<span class="ident">styled</span> <span class="op">=</span> <span class="ident">pos</span>.<span class="ident">stylized</span>(<span class="prelude-val">Some</span>(<span class="bool-val">false</span>));
}
<span class="ident">required_positionals</span>[<span class="ident">index</span>] <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">styled</span>);
}
<span class="kw">if</span> <span class="ident">pos</span>.<span class="ident">is_last_set</span>() <span class="op">&amp;&amp;</span> <span class="ident">force_optional</span> {
<span class="ident">required_positionals</span>[<span class="ident">index</span>] <span class="op">=</span> <span class="prelude-val">None</span>;
}
}
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">ret_val</span> <span class="op">=</span> <span class="ident">Vec::new</span>();
<span class="kw">if</span> <span class="op">!</span><span class="ident">force_optional</span> {
<span class="ident">ret_val</span>.<span class="ident">extend</span>(<span class="ident">required_opts</span>);
<span class="ident">ret_val</span>.<span class="ident">extend</span>(<span class="ident">required_groups</span>);
}
<span class="kw">for</span> <span class="ident">pos</span> <span class="kw">in</span> <span class="ident">required_positionals</span>.<span class="ident">into_iter</span>().<span class="ident">flatten</span>() {
<span class="ident">ret_val</span>.<span class="ident">push</span>(<span class="ident">pos</span>);
}
<span class="macro">debug!</span>(<span class="string">&quot;Usage::get_args: ret_val={:?}&quot;</span>, <span class="ident">ret_val</span>);
<span class="ident">ret_val</span>
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">get_required_usage_from</span>(
<span class="kw-2">&amp;</span><span class="self">self</span>,
<span class="ident">incls</span>: <span class="kw-2">&amp;</span>[<span class="ident">Id</span>],
<span class="ident">matcher</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">ArgMatcher</span><span class="op">&gt;</span>,
<span class="ident">incl_last</span>: <span class="ident">bool</span>,
) -&gt; <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">StyledStr</span><span class="op">&gt;</span> {
<span class="macro">debug!</span>(
<span class="string">&quot;Usage::get_required_usage_from: incls={:?}, matcher={:?}, incl_last={:?}&quot;</span>,
<span class="ident">incls</span>,
<span class="ident">matcher</span>.<span class="ident">is_some</span>(),
<span class="ident">incl_last</span>
);
<span class="kw">let</span> <span class="ident">required_owned</span>;
<span class="kw">let</span> <span class="ident">required</span> <span class="op">=</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">required</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">required</span> {
<span class="ident">required</span>
} <span class="kw">else</span> {
<span class="ident">required_owned</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">required_graph</span>();
<span class="kw-2">&amp;</span><span class="ident">required_owned</span>
};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">unrolled_reqs</span> <span class="op">=</span> <span class="ident">Vec::new</span>();
<span class="kw">for</span> <span class="ident">a</span> <span class="kw">in</span> <span class="ident">required</span>.<span class="ident">iter</span>() {
<span class="kw">let</span> <span class="ident">is_relevant</span> <span class="op">=</span> <span class="op">|</span>(<span class="ident">val</span>, <span class="ident">req_arg</span>): <span class="kw-2">&amp;</span>(<span class="ident">ArgPredicate</span>, <span class="ident">Id</span>)<span class="op">|</span> -&gt; <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">Id</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">required</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">val</span> {
<span class="ident">ArgPredicate::Equals</span>(<span class="kw">_</span>) =&gt; {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">matcher</span>) <span class="op">=</span> <span class="ident">matcher</span> {
<span class="ident">matcher</span>.<span class="ident">check_explicit</span>(<span class="ident">a</span>, <span class="ident">val</span>)
} <span class="kw">else</span> {
<span class="bool-val">false</span>
}
}
<span class="ident">ArgPredicate::IsPresent</span> =&gt; <span class="bool-val">true</span>,
};
<span class="ident">required</span>.<span class="ident">then</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">req_arg</span>.<span class="ident">clone</span>())
};
<span class="kw">for</span> <span class="ident">aa</span> <span class="kw">in</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">unroll_arg_requires</span>(<span class="ident">is_relevant</span>, <span class="ident">a</span>) {
<span class="comment">// if we don&#39;t check for duplicates here this causes duplicate error messages</span>
<span class="comment">// see https://github.com/clap-rs/clap/issues/2770</span>
<span class="ident">unrolled_reqs</span>.<span class="ident">push</span>(<span class="ident">aa</span>);
}
<span class="comment">// always include the required arg itself. it will not be enumerated</span>
<span class="comment">// by unroll_requirements_for_arg.</span>
<span class="ident">unrolled_reqs</span>.<span class="ident">push</span>(<span class="ident">a</span>.<span class="ident">clone</span>());
}
<span class="macro">debug!</span>(
<span class="string">&quot;Usage::get_required_usage_from: unrolled_reqs={:?}&quot;</span>,
<span class="ident">unrolled_reqs</span>
);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">required_groups_members</span> <span class="op">=</span> <span class="ident">FlatSet::new</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">required_groups</span> <span class="op">=</span> <span class="ident">FlatSet::new</span>();
<span class="kw">for</span> <span class="ident">req</span> <span class="kw">in</span> <span class="ident">unrolled_reqs</span>.<span class="ident">iter</span>().<span class="ident">chain</span>(<span class="ident">incls</span>.<span class="ident">iter</span>()) {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">find_group</span>(<span class="ident">req</span>).<span class="ident">is_some</span>() {
<span class="kw">let</span> <span class="ident">group_members</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">unroll_args_in_group</span>(<span class="ident">req</span>);
<span class="kw">let</span> <span class="ident">is_present</span> <span class="op">=</span> <span class="ident">matcher</span>
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">m</span><span class="op">|</span> {
<span class="ident">group_members</span>
.<span class="ident">iter</span>()
.<span class="ident">any</span>(<span class="op">|</span><span class="ident">arg</span><span class="op">|</span> <span class="ident">m</span>.<span class="ident">check_explicit</span>(<span class="ident">arg</span>, <span class="kw-2">&amp;</span><span class="ident">ArgPredicate::IsPresent</span>))
})
.<span class="ident">unwrap_or</span>(<span class="bool-val">false</span>);
<span class="macro">debug!</span>(
<span class="string">&quot;Usage::get_required_usage_from:iter:{:?} group is_present={}&quot;</span>,
<span class="ident">req</span>, <span class="ident">is_present</span>
);
<span class="kw">if</span> <span class="ident">is_present</span> {
<span class="kw">continue</span>;
}
<span class="kw">let</span> <span class="ident">elem</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">format_group</span>(<span class="ident">req</span>);
<span class="ident">required_groups</span>.<span class="ident">insert</span>(<span class="ident">elem</span>);
<span class="ident">required_groups_members</span>.<span class="ident">extend</span>(<span class="ident">group_members</span>);
} <span class="kw">else</span> {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">find</span>(<span class="ident">req</span>).<span class="ident">is_some</span>());
}
}
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">required_opts</span> <span class="op">=</span> <span class="ident">FlatSet::new</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">required_positionals</span> <span class="op">=</span> <span class="ident">Vec::new</span>();
<span class="kw">for</span> <span class="ident">req</span> <span class="kw">in</span> <span class="ident">unrolled_reqs</span>.<span class="ident">iter</span>().<span class="ident">chain</span>(<span class="ident">incls</span>.<span class="ident">iter</span>()) {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">arg</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">find</span>(<span class="ident">req</span>) {
<span class="kw">if</span> <span class="ident">required_groups_members</span>.<span class="ident">contains</span>(<span class="ident">arg</span>.<span class="ident">get_id</span>()) {
<span class="kw">continue</span>;
}
<span class="kw">let</span> <span class="ident">is_present</span> <span class="op">=</span> <span class="ident">matcher</span>
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">m</span><span class="op">|</span> <span class="ident">m</span>.<span class="ident">check_explicit</span>(<span class="ident">req</span>, <span class="kw-2">&amp;</span><span class="ident">ArgPredicate::IsPresent</span>))
.<span class="ident">unwrap_or</span>(<span class="bool-val">false</span>);
<span class="macro">debug!</span>(
<span class="string">&quot;Usage::get_required_usage_from:iter:{:?} arg is_present={}&quot;</span>,
<span class="ident">req</span>, <span class="ident">is_present</span>
);
<span class="kw">if</span> <span class="ident">is_present</span> {
<span class="kw">continue</span>;
}
<span class="kw">let</span> <span class="ident">stylized</span> <span class="op">=</span> <span class="ident">arg</span>.<span class="ident">stylized</span>(<span class="prelude-val">Some</span>(<span class="bool-val">true</span>));
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">index</span>) <span class="op">=</span> <span class="ident">arg</span>.<span class="ident">get_index</span>() {
<span class="kw">if</span> <span class="op">!</span><span class="ident">arg</span>.<span class="ident">is_last_set</span>() <span class="op">|</span><span class="op">|</span> <span class="ident">incl_last</span> {
<span class="kw">let</span> <span class="ident">new_len</span> <span class="op">=</span> <span class="ident">index</span> <span class="op">+</span> <span class="number">1</span>;
<span class="kw">if</span> <span class="ident">required_positionals</span>.<span class="ident">len</span>() <span class="op">&lt;</span> <span class="ident">new_len</span> {
<span class="ident">required_positionals</span>.<span class="ident">resize</span>(<span class="ident">new_len</span>, <span class="prelude-val">None</span>);
}
<span class="ident">required_positionals</span>[<span class="ident">index</span>] <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">stylized</span>);
}
} <span class="kw">else</span> {
<span class="ident">required_opts</span>.<span class="ident">insert</span>(<span class="ident">stylized</span>);
}
} <span class="kw">else</span> {
<span class="macro">debug_assert!</span>(<span class="self">self</span>.<span class="ident">cmd</span>.<span class="ident">find_group</span>(<span class="ident">req</span>).<span class="ident">is_some</span>());
}
}
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">ret_val</span> <span class="op">=</span> <span class="ident">Vec::new</span>();
<span class="ident">ret_val</span>.<span class="ident">extend</span>(<span class="ident">required_opts</span>);
<span class="ident">ret_val</span>.<span class="ident">extend</span>(<span class="ident">required_groups</span>);
<span class="kw">for</span> <span class="ident">pos</span> <span class="kw">in</span> <span class="ident">required_positionals</span>.<span class="ident">into_iter</span>().<span class="ident">flatten</span>() {
<span class="ident">ret_val</span>.<span class="ident">push</span>(<span class="ident">pos</span>);
}
<span class="macro">debug!</span>(<span class="string">&quot;Usage::get_required_usage_from: ret_val={:?}&quot;</span>, <span class="ident">ret_val</span>);
<span class="ident">ret_val</span>
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>