Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / clap / completions / mod.rs.html
blob: 96696443e0924c146cb8cb76782f0b785994ace9 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-2.34.0/src/completions/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../clap/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
</pre><pre class="rust"><code><span class="attribute">#[macro_use]
</span><span class="kw">mod </span>macros;
<span class="kw">mod </span>bash;
<span class="kw">mod </span>elvish;
<span class="kw">mod </span>fish;
<span class="kw">mod </span>powershell;
<span class="kw">mod </span>shell;
<span class="kw">mod </span>zsh;
<span class="comment">// Std
</span><span class="kw">use </span>std::io::Write;
<span class="comment">// Internal
</span><span class="kw">pub use </span><span class="kw">crate</span>::completions::shell::Shell;
<span class="kw">use crate</span>::{
app::parser::Parser,
completions::{
bash::BashGen, elvish::ElvishGen, fish::FishGen, powershell::PowerShellGen, zsh::ZshGen,
},
};
<span class="kw">pub struct </span>ComplGen&lt;<span class="lifetime">&#39;a</span>, <span class="lifetime">&#39;b</span>&gt;
<span class="kw">where
</span><span class="lifetime">&#39;a</span>: <span class="lifetime">&#39;b</span>,
{
p: <span class="kw-2">&amp;</span><span class="lifetime">&#39;b </span>Parser&lt;<span class="lifetime">&#39;a</span>, <span class="lifetime">&#39;b</span>&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, <span class="lifetime">&#39;b</span>&gt; ComplGen&lt;<span class="lifetime">&#39;a</span>, <span class="lifetime">&#39;b</span>&gt; {
<span class="kw">pub fn </span>new(p: <span class="kw-2">&amp;</span><span class="lifetime">&#39;b </span>Parser&lt;<span class="lifetime">&#39;a</span>, <span class="lifetime">&#39;b</span>&gt;) -&gt; <span class="self">Self </span>{
ComplGen { p }
}
<span class="kw">pub fn </span>generate&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, for_shell: Shell, buf: <span class="kw-2">&amp;mut </span>W) {
<span class="kw">match </span>for_shell {
Shell::Bash =&gt; BashGen::new(<span class="self">self</span>.p).generate_to(buf),
Shell::Fish =&gt; FishGen::new(<span class="self">self</span>.p).generate_to(buf),
Shell::Zsh =&gt; ZshGen::new(<span class="self">self</span>.p).generate_to(buf),
Shell::PowerShell =&gt; PowerShellGen::new(<span class="self">self</span>.p).generate_to(buf),
Shell::Elvish =&gt; ElvishGen::new(<span class="self">self</span>.p).generate_to(buf),
}
}
}
<span class="comment">// Gets all subcommands including child subcommands in the form of &#39;name&#39; where the name
// is a single word (i.e. &quot;install&quot;) of the path to said subcommand (i.e.
// &quot;rustup toolchain install&quot;)
//
// Also note, aliases are treated as their own subcommands but duplicates of whatever they&#39;re
// aliasing.
</span><span class="kw">pub fn </span>all_subcommand_names(p: <span class="kw-2">&amp;</span>Parser) -&gt; Vec&lt;String&gt; {
<span class="macro">debugln!</span>(<span class="string">&quot;all_subcommand_names;&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>subcmds: Vec&lt;<span class="kw">_</span>&gt; = subcommands_of(p)
.iter()
.map(|<span class="kw-2">&amp;</span>(<span class="kw-2">ref </span>n, <span class="kw">_</span>)| n.clone())
.collect();
<span class="kw">for </span>sc_v <span class="kw">in </span>p.subcommands.iter().map(|s| all_subcommand_names(<span class="kw-2">&amp;</span>s.p)) {
subcmds.extend(sc_v);
}
subcmds.sort();
subcmds.dedup();
subcmds
}
<span class="comment">// Gets all subcommands including child subcommands in the form of (&#39;name&#39;, &#39;bin_name&#39;) where the name
// is a single word (i.e. &quot;install&quot;) of the path and full bin_name of said subcommand (i.e.
// &quot;rustup toolchain install&quot;)
//
// Also note, aliases are treated as their own subcommands but duplicates of whatever they&#39;re
// aliasing.
</span><span class="kw">pub fn </span>all_subcommands(p: <span class="kw-2">&amp;</span>Parser) -&gt; Vec&lt;(String, String)&gt; {
<span class="macro">debugln!</span>(<span class="string">&quot;all_subcommands;&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>subcmds: Vec&lt;<span class="kw">_</span>&gt; = subcommands_of(p);
<span class="kw">for </span>sc_v <span class="kw">in </span>p.subcommands.iter().map(|s| all_subcommands(<span class="kw-2">&amp;</span>s.p)) {
subcmds.extend(sc_v);
}
subcmds
}
<span class="comment">// Gets all subcommands excluding child subcommands in the form of (name, bin_name) where the name
// is a single word (i.e. &quot;install&quot;) and the bin_name is a space delineated list of the path to said
// subcommand (i.e. &quot;rustup toolchain install&quot;)
//
// Also note, aliases are treated as their own subcommands but duplicates of whatever they&#39;re
// aliasing.
</span><span class="kw">pub fn </span>subcommands_of(p: <span class="kw-2">&amp;</span>Parser) -&gt; Vec&lt;(String, String)&gt; {
<span class="macro">debugln!</span>(
<span class="string">&quot;subcommands_of: name={}, bin_name={}&quot;</span>,
p.meta.name,
p.meta.bin_name.as_ref().unwrap()
);
<span class="kw">let </span><span class="kw-2">mut </span>subcmds = <span class="macro">vec!</span>[];
<span class="macro">debugln!</span>(
<span class="string">&quot;subcommands_of: Has subcommands...{:?}&quot;</span>,
p.has_subcommands()
);
<span class="kw">if </span>!p.has_subcommands() {
<span class="kw">let </span><span class="kw-2">mut </span>ret = <span class="macro">vec!</span>[];
<span class="macro">debugln!</span>(<span class="string">&quot;subcommands_of: Looking for aliases...&quot;</span>);
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>aliases) = p.meta.aliases {
<span class="kw">for </span><span class="kw-2">&amp;</span>(n, <span class="kw">_</span>) <span class="kw">in </span>aliases {
<span class="macro">debugln!</span>(<span class="string">&quot;subcommands_of:iter:iter: Found alias...{}&quot;</span>, n);
<span class="kw">let </span><span class="kw-2">mut </span>als_bin_name: Vec&lt;<span class="kw">_</span>&gt; =
p.meta.bin_name.as_ref().unwrap().split(<span class="string">&#39; &#39;</span>).collect();
als_bin_name.push(n);
<span class="kw">let </span>old = als_bin_name.len() - <span class="number">2</span>;
als_bin_name.swap_remove(old);
ret.push((n.to_owned(), als_bin_name.join(<span class="string">&quot; &quot;</span>)));
}
}
<span class="kw">return </span>ret;
}
<span class="kw">for </span>sc <span class="kw">in </span><span class="kw-2">&amp;</span>p.subcommands {
<span class="macro">debugln!</span>(
<span class="string">&quot;subcommands_of:iter: name={}, bin_name={}&quot;</span>,
sc.p.meta.name,
sc.p.meta.bin_name.as_ref().unwrap()
);
<span class="macro">debugln!</span>(<span class="string">&quot;subcommands_of:iter: Looking for aliases...&quot;</span>);
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>aliases) = sc.p.meta.aliases {
<span class="kw">for </span><span class="kw-2">&amp;</span>(n, <span class="kw">_</span>) <span class="kw">in </span>aliases {
<span class="macro">debugln!</span>(<span class="string">&quot;subcommands_of:iter:iter: Found alias...{}&quot;</span>, n);
<span class="kw">let </span><span class="kw-2">mut </span>als_bin_name: Vec&lt;<span class="kw">_</span>&gt; =
p.meta.bin_name.as_ref().unwrap().split(<span class="string">&#39; &#39;</span>).collect();
als_bin_name.push(n);
<span class="kw">let </span>old = als_bin_name.len() - <span class="number">2</span>;
als_bin_name.swap_remove(old);
subcmds.push((n.to_owned(), als_bin_name.join(<span class="string">&quot; &quot;</span>)));
}
}
subcmds.push((
sc.p.meta.name.clone(),
sc.p.meta.bin_name.as_ref().unwrap().clone(),
));
}
subcmds
}
<span class="kw">pub fn </span>get_all_subcommand_paths(p: <span class="kw-2">&amp;</span>Parser, first: bool) -&gt; Vec&lt;String&gt; {
<span class="macro">debugln!</span>(<span class="string">&quot;get_all_subcommand_paths;&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>subcmds = <span class="macro">vec!</span>[];
<span class="kw">if </span>!p.has_subcommands() {
<span class="kw">if </span>!first {
<span class="kw">let </span>name = <span class="kw-2">&amp;*</span>p.meta.name;
<span class="kw">let </span>path = p.meta.bin_name.as_ref().unwrap().clone().replace(<span class="string">&quot; &quot;</span>, <span class="string">&quot;__&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>ret = <span class="macro">vec!</span>[path.clone()];
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>aliases) = p.meta.aliases {
<span class="kw">for </span><span class="kw-2">&amp;</span>(n, <span class="kw">_</span>) <span class="kw">in </span>aliases {
ret.push(path.replace(name, n));
}
}
<span class="kw">return </span>ret;
}
<span class="kw">return </span><span class="macro">vec!</span>[];
}
<span class="kw">for </span>sc <span class="kw">in </span><span class="kw-2">&amp;</span>p.subcommands {
<span class="kw">let </span>name = <span class="kw-2">&amp;*</span>sc.p.meta.name;
<span class="kw">let </span>path =
sc.p.meta
.bin_name
.as_ref()
.unwrap()
.clone()
.replace(<span class="string">&quot; &quot;</span>, <span class="string">&quot;__&quot;</span>);
subcmds.push(path.clone());
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>aliases) = sc.p.meta.aliases {
<span class="kw">for </span><span class="kw-2">&amp;</span>(n, <span class="kw">_</span>) <span class="kw">in </span>aliases {
subcmds.push(path.replace(name, n));
}
}
}
<span class="kw">for </span>sc_v <span class="kw">in </span>p
.subcommands
.iter()
.map(|s| get_all_subcommand_paths(<span class="kw-2">&amp;</span>s.p, <span class="bool-val">false</span>))
{
subcmds.extend(sc_v);
}
subcmds
}
</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.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>