Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / clap / suggestions.rs.html
blob: b15e2e8702ff27c7ed95f059925094b852e25305 [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/suggestions.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>suggestions.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>
</pre><pre class="rust"><code><span class="comment">// Internal
</span><span class="kw">use crate</span>::{app::App, fmt::Format};
<span class="doccomment">/// Produces a string from a given list of possible values which is similar to
/// the passed in value `v` with a certain confidence.
/// Thus in a list of possible values like [&quot;foo&quot;, &quot;bar&quot;], the value &quot;fop&quot; will yield
/// `Some(&quot;foo&quot;)`, whereas &quot;blark&quot; would yield `None`.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;suggestions&quot;</span>)]
#[cfg_attr(feature = <span class="string">&quot;cargo-clippy&quot;</span>, allow(clippy::needless_lifetimes))]
</span><span class="kw">pub fn </span>did_you_mean&lt;<span class="lifetime">&#39;a</span>, T: <span class="question-mark">?</span>Sized, I&gt;(v: <span class="kw-2">&amp;</span>str, possible_values: I) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str&gt;
<span class="kw">where
</span>T: AsRef&lt;str&gt; + <span class="lifetime">&#39;a</span>,
I: IntoIterator&lt;Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>T&gt;,
{
<span class="kw">let </span><span class="kw-2">mut </span>candidate: <span class="prelude-ty">Option</span>&lt;(f64, <span class="kw-2">&amp;</span>str)&gt; = <span class="prelude-val">None</span>;
<span class="kw">for </span>pv <span class="kw">in </span>possible_values {
<span class="kw">let </span>confidence = strsim::jaro_winkler(v, pv.as_ref());
<span class="kw">if </span>confidence &gt; <span class="number">0.8 </span>&amp;&amp; (candidate.is_none() || (candidate.as_ref().unwrap().<span class="number">0 </span>&lt; confidence))
{
candidate = <span class="prelude-val">Some</span>((confidence, pv.as_ref()));
}
}
<span class="kw">match </span>candidate {
<span class="prelude-val">None </span>=&gt; <span class="prelude-val">None</span>,
<span class="prelude-val">Some</span>((<span class="kw">_</span>, candidate)) =&gt; <span class="prelude-val">Some</span>(candidate),
}
}
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;suggestions&quot;</span>))]
</span><span class="kw">pub fn </span>did_you_mean&lt;<span class="lifetime">&#39;a</span>, T: <span class="question-mark">?</span>Sized, I&gt;(<span class="kw">_</span>: <span class="kw-2">&amp;</span>str, <span class="kw">_</span>: I) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str&gt;
<span class="kw">where
</span>T: AsRef&lt;str&gt; + <span class="lifetime">&#39;a</span>,
I: IntoIterator&lt;Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>T&gt;,
{
<span class="prelude-val">None
</span>}
<span class="doccomment">/// Returns a suffix that can be empty, or is the standard &#39;did you mean&#39; phrase
</span><span class="kw">pub fn </span>did_you_mean_flag_suffix&lt;<span class="lifetime">&#39;z</span>, T, I&gt;(
arg: <span class="kw-2">&amp;</span>str,
args_rest: <span class="kw-2">&amp;</span><span class="lifetime">&#39;z </span>[<span class="kw-2">&amp;</span>str],
longs: I,
subcommands: <span class="kw-2">&amp;</span><span class="lifetime">&#39;z </span>[App],
) -&gt; (String, <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;z </span>str&gt;)
<span class="kw">where
</span>T: AsRef&lt;str&gt; + <span class="lifetime">&#39;z</span>,
I: IntoIterator&lt;Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;z </span>T&gt;,
{
<span class="kw">if let </span><span class="prelude-val">Some</span>(candidate) = did_you_mean(arg, longs) {
<span class="kw">let </span>suffix = <span class="macro">format!</span>(
<span class="string">&quot;\n\tDid you mean {}{}?&quot;</span>,
Format::Good(<span class="string">&quot;--&quot;</span>),
Format::Good(candidate)
);
<span class="kw">return </span>(suffix, <span class="prelude-val">Some</span>(candidate));
}
subcommands
.iter()
.filter_map(|subcommand| {
<span class="kw">let </span>opts = subcommand
.p
.flags
.iter()
.filter_map(|f| f.s.long)
.chain(subcommand.p.opts.iter().filter_map(|o| o.s.long));
<span class="kw">let </span>candidate = <span class="kw">match </span>did_you_mean(arg, opts) {
<span class="prelude-val">Some</span>(candidate) =&gt; candidate,
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">None</span>,
};
<span class="kw">let </span>score = <span class="kw">match </span>args_rest.iter().position(|x| <span class="kw-2">*</span>x == subcommand.get_name()) {
<span class="prelude-val">Some</span>(score) =&gt; score,
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">None</span>,
};
<span class="kw">let </span>suffix = <span class="macro">format!</span>(
<span class="string">&quot;\n\tDid you mean to put &#39;{}{}&#39; after the subcommand &#39;{}&#39;?&quot;</span>,
Format::Good(<span class="string">&quot;--&quot;</span>),
Format::Good(candidate),
Format::Good(subcommand.get_name())
);
<span class="prelude-val">Some</span>((score, (suffix, <span class="prelude-val">Some</span>(candidate))))
})
.min_by_key(|<span class="kw-2">&amp;</span>(score, <span class="kw">_</span>)| score)
.map(|(<span class="kw">_</span>, suggestion)| suggestion)
.unwrap_or_else(|| (String::new(), <span class="prelude-val">None</span>))
}
<span class="doccomment">/// Returns a suffix that can be empty, or is the standard &#39;did you mean&#39; phrase
</span><span class="kw">pub fn </span>did_you_mean_value_suffix&lt;<span class="lifetime">&#39;z</span>, T, I&gt;(arg: <span class="kw-2">&amp;</span>str, values: I) -&gt; (String, <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;z </span>str&gt;)
<span class="kw">where
</span>T: AsRef&lt;str&gt; + <span class="lifetime">&#39;z</span>,
I: IntoIterator&lt;Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;z </span>T&gt;,
{
<span class="kw">match </span>did_you_mean(arg, values) {
<span class="prelude-val">Some</span>(candidate) =&gt; {
<span class="kw">let </span>suffix = <span class="macro">format!</span>(<span class="string">&quot;\n\tDid you mean &#39;{}&#39;?&quot;</span>, Format::Good(candidate));
(suffix, <span class="prelude-val">Some</span>(candidate))
}
<span class="prelude-val">None </span>=&gt; (String::new(), <span class="prelude-val">None</span>),
}
}
<span class="attribute">#[cfg(all(test, features = <span class="string">&quot;suggestions&quot;</span>))]
</span><span class="kw">mod </span>test {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>possible_values_match() {
<span class="kw">let </span>p_vals = [<span class="string">&quot;test&quot;</span>, <span class="string">&quot;possible&quot;</span>, <span class="string">&quot;values&quot;</span>];
<span class="macro">assert_eq!</span>(did_you_mean(<span class="string">&quot;tst&quot;</span>, p_vals.iter()), <span class="prelude-val">Some</span>(<span class="string">&quot;test&quot;</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>possible_values_nomatch() {
<span class="kw">let </span>p_vals = [<span class="string">&quot;test&quot;</span>, <span class="string">&quot;possible&quot;</span>, <span class="string">&quot;values&quot;</span>];
<span class="macro">assert!</span>(did_you_mean(<span class="string">&quot;hahaahahah&quot;</span>, p_vals.iter()).is_none());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>suffix_long() {
<span class="kw">let </span>p_vals = [<span class="string">&quot;test&quot;</span>, <span class="string">&quot;possible&quot;</span>, <span class="string">&quot;values&quot;</span>];
<span class="kw">let </span>suffix = <span class="string">&quot;\n\tDid you mean \&#39;--test\&#39;?&quot;</span>;
<span class="macro">assert_eq!</span>(
did_you_mean_flag_suffix(<span class="string">&quot;tst&quot;</span>, p_vals.iter(), []),
(suffix, <span class="prelude-val">Some</span>(<span class="string">&quot;test&quot;</span>))
);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>suffix_enum() {
<span class="kw">let </span>p_vals = [<span class="string">&quot;test&quot;</span>, <span class="string">&quot;possible&quot;</span>, <span class="string">&quot;values&quot;</span>];
<span class="kw">let </span>suffix = <span class="string">&quot;\n\tDid you mean \&#39;test\&#39;?&quot;</span>;
<span class="macro">assert_eq!</span>(
did_you_mean_value_suffix(<span class="string">&quot;tst&quot;</span>, p_vals.iter()),
(suffix, <span class="prelude-val">Some</span>(<span class="string">&quot;test&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.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>