Now a REAL lib
This commit is contained in:
Justine
692
doc/src/clap/builder/action.rs.html
Normal file
692
doc/src/clap/builder/action.rs.html
Normal file
@ -0,0 +1,692 @@
|
||||
<!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/builder/action.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>action.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="doccomment">/// Behavior of arguments when they are encountered while parsing</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</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">"help"</span>), <span class="ident">doc</span> <span class="op">=</span> <span class="string">" ```ignore"</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"help"</span>, <span class="ident">doc</span> <span class="op">=</span> <span class="string">" ```"</span>)]</span>
|
||||
<span class="doccomment">/// # use clap::Command;</span>
|
||||
<span class="doccomment">/// # use clap::Arg;</span>
|
||||
<span class="doccomment">/// let cmd = Command::new("mycmd")</span>
|
||||
<span class="doccomment">/// .arg(</span>
|
||||
<span class="doccomment">/// Arg::new("special-help")</span>
|
||||
<span class="doccomment">/// .short('?')</span>
|
||||
<span class="doccomment">/// .action(clap::ArgAction::Help)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// // Existing help still exists</span>
|
||||
<span class="doccomment">/// let err = cmd.clone().try_get_matches_from(["mycmd", "-h"]).unwrap_err();</span>
|
||||
<span class="doccomment">/// assert_eq!(err.kind(), clap::error::ErrorKind::DisplayHelp);</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// // New help available</span>
|
||||
<span class="doccomment">/// let err = cmd.try_get_matches_from(["mycmd", "-?"]).unwrap_err();</span>
|
||||
<span class="doccomment">/// assert_eq!(err.kind(), clap::error::ErrorKind::DisplayHelp);</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">non_exhaustive</span>]</span>
|
||||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">missing_copy_implementations</span>)]</span> <span class="comment">// In the future, we may accept `Box<dyn ...>`</span>
|
||||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ArgAction</span> {
|
||||
<span class="doccomment">/// When encountered, store the associated value(s) in [`ArgMatches`][crate::ArgMatches]</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// **NOTE:** If the argument has previously been seen, it will result in a</span>
|
||||
<span class="doccomment">/// [`ArgumentConflict`][crate::error::ErrorKind::ArgumentConflict] unless</span>
|
||||
<span class="doccomment">/// [`Command::args_override_self(true)`][crate::Command::args_override_self] is set.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::Command;</span>
|
||||
<span class="doccomment">/// # use clap::Arg;</span>
|
||||
<span class="doccomment">/// let cmd = Command::new("mycmd")</span>
|
||||
<span class="doccomment">/// .arg(</span>
|
||||
<span class="doccomment">/// Arg::new("flag")</span>
|
||||
<span class="doccomment">/// .long("flag")</span>
|
||||
<span class="doccomment">/// .action(clap::ArgAction::Set)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let matches = cmd.try_get_matches_from(["mycmd", "--flag", "value"]).unwrap();</span>
|
||||
<span class="doccomment">/// assert!(matches.contains_id("flag"));</span>
|
||||
<span class="doccomment">/// assert_eq!(</span>
|
||||
<span class="doccomment">/// matches.get_many::<String>("flag").unwrap_or_default().map(|v| v.as_str()).collect::<Vec<_>>(),</span>
|
||||
<span class="doccomment">/// vec!["value"]</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="ident">Set</span>,
|
||||
<span class="doccomment">/// When encountered, store the associated value(s) in [`ArgMatches`][crate::ArgMatches]</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::Command;</span>
|
||||
<span class="doccomment">/// # use clap::Arg;</span>
|
||||
<span class="doccomment">/// let cmd = Command::new("mycmd")</span>
|
||||
<span class="doccomment">/// .arg(</span>
|
||||
<span class="doccomment">/// Arg::new("flag")</span>
|
||||
<span class="doccomment">/// .long("flag")</span>
|
||||
<span class="doccomment">/// .action(clap::ArgAction::Append)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let matches = cmd.try_get_matches_from(["mycmd", "--flag", "value1", "--flag", "value2"]).unwrap();</span>
|
||||
<span class="doccomment">/// assert!(matches.contains_id("flag"));</span>
|
||||
<span class="doccomment">/// assert_eq!(</span>
|
||||
<span class="doccomment">/// matches.get_many::<String>("flag").unwrap_or_default().map(|v| v.as_str()).collect::<Vec<_>>(),</span>
|
||||
<span class="doccomment">/// vec!["value1", "value2"]</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="ident">Append</span>,
|
||||
<span class="doccomment">/// When encountered, act as if `"true"` was encountered on the command-line</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// If no [`default_value`][super::Arg::default_value] is set, it will be `false`.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// No value is allowed. To optionally accept a value, see</span>
|
||||
<span class="doccomment">/// [`Arg::default_missing_value`][super::Arg::default_missing_value]</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// **NOTE:** If the argument has previously been seen, it will result in a</span>
|
||||
<span class="doccomment">/// [`ArgumentConflict`][crate::error::ErrorKind::ArgumentConflict] unless</span>
|
||||
<span class="doccomment">/// [`Command::args_override_self(true)`][crate::Command::args_override_self] is set.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::Command;</span>
|
||||
<span class="doccomment">/// # use clap::Arg;</span>
|
||||
<span class="doccomment">/// let cmd = Command::new("mycmd")</span>
|
||||
<span class="doccomment">/// .arg(</span>
|
||||
<span class="doccomment">/// Arg::new("flag")</span>
|
||||
<span class="doccomment">/// .long("flag")</span>
|
||||
<span class="doccomment">/// .action(clap::ArgAction::SetTrue)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let matches = cmd.clone().try_get_matches_from(["mycmd", "--flag"]).unwrap();</span>
|
||||
<span class="doccomment">/// assert!(matches.contains_id("flag"));</span>
|
||||
<span class="doccomment">/// assert_eq!(</span>
|
||||
<span class="doccomment">/// matches.get_one::<bool>("flag").copied(),</span>
|
||||
<span class="doccomment">/// Some(true)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let matches = cmd.try_get_matches_from(["mycmd"]).unwrap();</span>
|
||||
<span class="doccomment">/// assert!(matches.contains_id("flag"));</span>
|
||||
<span class="doccomment">/// assert_eq!(</span>
|
||||
<span class="doccomment">/// matches.get_one::<bool>("flag").copied(),</span>
|
||||
<span class="doccomment">/// Some(false)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// You can use [`TypedValueParser::map`][crate::builder::TypedValueParser::map] to have the</span>
|
||||
<span class="doccomment">/// flag control an application-specific type:</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::Command;</span>
|
||||
<span class="doccomment">/// # use clap::Arg;</span>
|
||||
<span class="doccomment">/// # use clap::builder::TypedValueParser as _;</span>
|
||||
<span class="doccomment">/// # use clap::builder::BoolishValueParser;</span>
|
||||
<span class="doccomment">/// let cmd = Command::new("mycmd")</span>
|
||||
<span class="doccomment">/// .arg(</span>
|
||||
<span class="doccomment">/// Arg::new("flag")</span>
|
||||
<span class="doccomment">/// .long("flag")</span>
|
||||
<span class="doccomment">/// .action(clap::ArgAction::SetTrue)</span>
|
||||
<span class="doccomment">/// .value_parser(</span>
|
||||
<span class="doccomment">/// BoolishValueParser::new()</span>
|
||||
<span class="doccomment">/// .map(|b| -> usize {</span>
|
||||
<span class="doccomment">/// if b { 10 } else { 5 }</span>
|
||||
<span class="doccomment">/// })</span>
|
||||
<span class="doccomment">/// )</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let matches = cmd.clone().try_get_matches_from(["mycmd", "--flag"]).unwrap();</span>
|
||||
<span class="doccomment">/// assert!(matches.contains_id("flag"));</span>
|
||||
<span class="doccomment">/// assert_eq!(</span>
|
||||
<span class="doccomment">/// matches.get_one::<usize>("flag").copied(),</span>
|
||||
<span class="doccomment">/// Some(10)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let matches = cmd.try_get_matches_from(["mycmd"]).unwrap();</span>
|
||||
<span class="doccomment">/// assert!(matches.contains_id("flag"));</span>
|
||||
<span class="doccomment">/// assert_eq!(</span>
|
||||
<span class="doccomment">/// matches.get_one::<usize>("flag").copied(),</span>
|
||||
<span class="doccomment">/// Some(5)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="ident">SetTrue</span>,
|
||||
<span class="doccomment">/// When encountered, act as if `"false"` was encountered on the command-line</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// If no [`default_value`][super::Arg::default_value] is set, it will be `true`.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// No value is allowed. To optionally accept a value, see</span>
|
||||
<span class="doccomment">/// [`Arg::default_missing_value`][super::Arg::default_missing_value]</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// **NOTE:** If the argument has previously been seen, it will result in a</span>
|
||||
<span class="doccomment">/// [`ArgumentConflict`][crate::error::ErrorKind::ArgumentConflict] unless</span>
|
||||
<span class="doccomment">/// [`Command::args_override_self(true)`][crate::Command::args_override_self] is set.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::Command;</span>
|
||||
<span class="doccomment">/// # use clap::Arg;</span>
|
||||
<span class="doccomment">/// let cmd = Command::new("mycmd")</span>
|
||||
<span class="doccomment">/// .arg(</span>
|
||||
<span class="doccomment">/// Arg::new("flag")</span>
|
||||
<span class="doccomment">/// .long("flag")</span>
|
||||
<span class="doccomment">/// .action(clap::ArgAction::SetFalse)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let matches = cmd.clone().try_get_matches_from(["mycmd", "--flag"]).unwrap();</span>
|
||||
<span class="doccomment">/// assert!(matches.contains_id("flag"));</span>
|
||||
<span class="doccomment">/// assert_eq!(</span>
|
||||
<span class="doccomment">/// matches.get_one::<bool>("flag").copied(),</span>
|
||||
<span class="doccomment">/// Some(false)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let matches = cmd.try_get_matches_from(["mycmd"]).unwrap();</span>
|
||||
<span class="doccomment">/// assert!(matches.contains_id("flag"));</span>
|
||||
<span class="doccomment">/// assert_eq!(</span>
|
||||
<span class="doccomment">/// matches.get_one::<bool>("flag").copied(),</span>
|
||||
<span class="doccomment">/// Some(true)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="ident">SetFalse</span>,
|
||||
<span class="doccomment">/// When encountered, increment a `u8` counter</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// If no [`default_value`][super::Arg::default_value] is set, it will be `0`.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// No value is allowed. To optionally accept a value, see</span>
|
||||
<span class="doccomment">/// [`Arg::default_missing_value`][super::Arg::default_missing_value]</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::Command;</span>
|
||||
<span class="doccomment">/// # use clap::Arg;</span>
|
||||
<span class="doccomment">/// let cmd = Command::new("mycmd")</span>
|
||||
<span class="doccomment">/// .arg(</span>
|
||||
<span class="doccomment">/// Arg::new("flag")</span>
|
||||
<span class="doccomment">/// .long("flag")</span>
|
||||
<span class="doccomment">/// .action(clap::ArgAction::Count)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let matches = cmd.clone().try_get_matches_from(["mycmd", "--flag", "--flag"]).unwrap();</span>
|
||||
<span class="doccomment">/// assert!(matches.contains_id("flag"));</span>
|
||||
<span class="doccomment">/// assert_eq!(</span>
|
||||
<span class="doccomment">/// matches.get_count("flag"),</span>
|
||||
<span class="doccomment">/// 2</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let matches = cmd.try_get_matches_from(["mycmd"]).unwrap();</span>
|
||||
<span class="doccomment">/// assert!(matches.contains_id("flag"));</span>
|
||||
<span class="doccomment">/// assert_eq!(</span>
|
||||
<span class="doccomment">/// matches.get_count("flag"),</span>
|
||||
<span class="doccomment">/// 0</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="ident">Count</span>,
|
||||
<span class="doccomment">/// When encountered, display [`Command::print_help`][super::Command::print_help]</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Depending on the flag, [`Command::print_long_help`][super::Command::print_long_help] may be shown</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</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">"help"</span>), <span class="ident">doc</span> <span class="op">=</span> <span class="string">" ```ignore"</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"help"</span>, <span class="ident">doc</span> <span class="op">=</span> <span class="string">" ```"</span>)]</span>
|
||||
<span class="doccomment">/// # use clap::Command;</span>
|
||||
<span class="doccomment">/// # use clap::Arg;</span>
|
||||
<span class="doccomment">/// let cmd = Command::new("mycmd")</span>
|
||||
<span class="doccomment">/// .arg(</span>
|
||||
<span class="doccomment">/// Arg::new("special-help")</span>
|
||||
<span class="doccomment">/// .short('?')</span>
|
||||
<span class="doccomment">/// .action(clap::ArgAction::Help)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// // Existing help still exists</span>
|
||||
<span class="doccomment">/// let err = cmd.clone().try_get_matches_from(["mycmd", "-h"]).unwrap_err();</span>
|
||||
<span class="doccomment">/// assert_eq!(err.kind(), clap::error::ErrorKind::DisplayHelp);</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// // New help available</span>
|
||||
<span class="doccomment">/// let err = cmd.try_get_matches_from(["mycmd", "-?"]).unwrap_err();</span>
|
||||
<span class="doccomment">/// assert_eq!(err.kind(), clap::error::ErrorKind::DisplayHelp);</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="ident">Help</span>,
|
||||
<span class="doccomment">/// When encountered, display [`Command::version`][super::Command::version]</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Depending on the flag, [`Command::long_version`][super::Command::long_version] may be shown</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::Command;</span>
|
||||
<span class="doccomment">/// # use clap::Arg;</span>
|
||||
<span class="doccomment">/// let cmd = Command::new("mycmd")</span>
|
||||
<span class="doccomment">/// .version("1.0.0")</span>
|
||||
<span class="doccomment">/// .arg(</span>
|
||||
<span class="doccomment">/// Arg::new("special-version")</span>
|
||||
<span class="doccomment">/// .long("special-version")</span>
|
||||
<span class="doccomment">/// .action(clap::ArgAction::Version)</span>
|
||||
<span class="doccomment">/// );</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// // Existing help still exists</span>
|
||||
<span class="doccomment">/// let err = cmd.clone().try_get_matches_from(["mycmd", "--version"]).unwrap_err();</span>
|
||||
<span class="doccomment">/// assert_eq!(err.kind(), clap::error::ErrorKind::DisplayVersion);</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// // New help available</span>
|
||||
<span class="doccomment">/// let err = cmd.try_get_matches_from(["mycmd", "--special-version"]).unwrap_err();</span>
|
||||
<span class="doccomment">/// assert_eq!(err.kind(), clap::error::ErrorKind::DisplayVersion);</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="ident">Version</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">ArgAction</span> {
|
||||
<span class="doccomment">/// Returns whether this action accepts values on the command-line</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [`default_values`][super::Arg::default_values] and [`env`][super::Arg::env] may still be</span>
|
||||
<span class="doccomment">/// processed.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">takes_values</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">bool</span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Set</span> => <span class="bool-val">true</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Append</span> => <span class="bool-val">true</span>,
|
||||
<span class="ident"><span class="self">Self</span>::SetTrue</span> => <span class="bool-val">false</span>,
|
||||
<span class="ident"><span class="self">Self</span>::SetFalse</span> => <span class="bool-val">false</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Count</span> => <span class="bool-val">false</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Help</span> => <span class="bool-val">false</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Version</span> => <span class="bool-val">false</span>,
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">default_value</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Set</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Append</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::SetTrue</span> => <span class="prelude-val">Some</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="string">"false"</span>)),
|
||||
<span class="ident"><span class="self">Self</span>::SetFalse</span> => <span class="prelude-val">Some</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="string">"true"</span>)),
|
||||
<span class="ident"><span class="self">Self</span>::Count</span> => <span class="prelude-val">Some</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="string">"0"</span>)),
|
||||
<span class="ident"><span class="self">Self</span>::Help</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Version</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">default_missing_value</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Set</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Append</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::SetTrue</span> => <span class="prelude-val">Some</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="string">"true"</span>)),
|
||||
<span class="ident"><span class="self">Self</span>::SetFalse</span> => <span class="prelude-val">Some</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="string">"false"</span>)),
|
||||
<span class="ident"><span class="self">Self</span>::Count</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Help</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Version</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">default_value_parser</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident"><span class="kw">super</span>::ValueParser</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Set</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Append</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::SetTrue</span> => <span class="prelude-val">Some</span>(<span class="ident"><span class="kw">super</span>::ValueParser::bool</span>()),
|
||||
<span class="ident"><span class="self">Self</span>::SetFalse</span> => <span class="prelude-val">Some</span>(<span class="ident"><span class="kw">super</span>::ValueParser::bool</span>()),
|
||||
<span class="ident"><span class="self">Self</span>::Count</span> => <span class="prelude-val">Some</span>(<span class="macro">crate::value_parser!</span>(<span class="ident">u8</span>).<span class="ident">into</span>()),
|
||||
<span class="ident"><span class="self">Self</span>::Help</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Version</span> => <span class="prelude-val">None</span>,
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">debug_assertions</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">value_type_id</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident"><span class="kw">crate</span>::parser::AnyValueId</span><span class="op">></span> {
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::parser::AnyValueId</span>;
|
||||
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Set</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Append</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::SetTrue</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::SetFalse</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Count</span> => <span class="prelude-val">Some</span>(<span class="ident">AnyValueId::of</span>::<span class="op"><</span><span class="ident">CountType</span><span class="op">></span>()),
|
||||
<span class="ident"><span class="self">Self</span>::Help</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Version</span> => <span class="prelude-val">None</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">type</span> <span class="ident">CountType</span> <span class="op">=</span> <span class="ident">u8</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>
|
||||
348
doc/src/clap/builder/app_settings.rs.html
Normal file
348
doc/src/clap/builder/app_settings.rs.html
Normal file
@ -0,0 +1,348 @@
|
||||
<!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/builder/app_settings.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>app_settings.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="comment">// Std</span>
|
||||
<span class="kw">use</span> <span class="ident">std::ops::BitOr</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused</span>)]</span>
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::Arg</span>;
|
||||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused</span>)]</span>
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::Command</span>;
|
||||
|
||||
<span class="comment">// Third party</span>
|
||||
<span class="kw">use</span> <span class="ident">bitflags::bitflags</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Copy</span>, <span class="ident">Clone</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">struct</span> <span class="ident">AppFlags</span>(<span class="ident">Flags</span>);
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">AppFlags</span> {
|
||||
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
|
||||
<span class="ident">AppFlags</span>(<span class="ident">Flags::COLOR_AUTO</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Application level settings, which affect how [`Command`] operates</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// **NOTE:** When these settings are used, they apply only to current command, and are *not*</span>
|
||||
<span class="doccomment">/// propagated down or up through child or parent subcommands</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [`Command`]: crate::Command</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">non_exhaustive</span>]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum</span> <span class="ident">AppSettings</span> {
|
||||
<span class="ident">IgnoreErrors</span>,
|
||||
<span class="ident">AllowHyphenValues</span>,
|
||||
<span class="ident">AllowNegativeNumbers</span>,
|
||||
<span class="ident">AllArgsOverrideSelf</span>,
|
||||
<span class="ident">AllowMissingPositional</span>,
|
||||
<span class="ident">TrailingVarArg</span>,
|
||||
<span class="ident">DontDelimitTrailingValues</span>,
|
||||
<span class="ident">InferLongArgs</span>,
|
||||
<span class="ident">InferSubcommands</span>,
|
||||
<span class="ident">SubcommandRequired</span>,
|
||||
<span class="ident">AllowExternalSubcommands</span>,
|
||||
<span class="ident">Multicall</span>,
|
||||
<span class="ident">SubcommandsNegateReqs</span>,
|
||||
<span class="ident">ArgsNegateSubcommands</span>,
|
||||
<span class="ident">SubcommandPrecedenceOverArg</span>,
|
||||
<span class="ident">ArgRequiredElseHelp</span>,
|
||||
<span class="ident">NextLineHelp</span>,
|
||||
<span class="ident">DisableColoredHelp</span>,
|
||||
<span class="ident">DisableHelpFlag</span>,
|
||||
<span class="ident">DisableHelpSubcommand</span>,
|
||||
<span class="ident">DisableVersionFlag</span>,
|
||||
<span class="ident">PropagateVersion</span>,
|
||||
<span class="ident">Hidden</span>,
|
||||
<span class="ident">HidePossibleValues</span>,
|
||||
<span class="ident">HelpExpected</span>,
|
||||
<span class="ident">NoBinaryName</span>,
|
||||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span>
|
||||
<span class="ident">ColorAuto</span>,
|
||||
<span class="ident">ColorAlways</span>,
|
||||
<span class="ident">ColorNever</span>,
|
||||
<span class="ident">Built</span>,
|
||||
<span class="ident">BinNameBuilt</span>,
|
||||
}
|
||||
|
||||
<span class="macro">bitflags!</span> {
|
||||
<span class="kw">struct</span> <span class="ident">Flags</span>: <span class="ident">u64</span> {
|
||||
<span class="kw">const</span> <span class="ident">SC_NEGATE_REQS</span> <span class="op">=</span> <span class="number">1</span>;
|
||||
<span class="kw">const</span> <span class="ident">SC_REQUIRED</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">1</span>;
|
||||
<span class="kw">const</span> <span class="ident">ARG_REQUIRED_ELSE_HELP</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">2</span>;
|
||||
<span class="kw">const</span> <span class="ident">PROPAGATE_VERSION</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">3</span>;
|
||||
<span class="kw">const</span> <span class="ident">DISABLE_VERSION_FOR_SC</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">4</span>;
|
||||
<span class="kw">const</span> <span class="ident">WAIT_ON_ERROR</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">6</span>;
|
||||
<span class="kw">const</span> <span class="ident">DISABLE_VERSION_FLAG</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">10</span>;
|
||||
<span class="kw">const</span> <span class="ident">HIDDEN</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">11</span>;
|
||||
<span class="kw">const</span> <span class="ident">TRAILING_VARARG</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">12</span>;
|
||||
<span class="kw">const</span> <span class="ident">NO_BIN_NAME</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">13</span>;
|
||||
<span class="kw">const</span> <span class="ident">ALLOW_UNK_SC</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">14</span>;
|
||||
<span class="kw">const</span> <span class="ident">LEADING_HYPHEN</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">16</span>;
|
||||
<span class="kw">const</span> <span class="ident">NO_POS_VALUES</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">17</span>;
|
||||
<span class="kw">const</span> <span class="ident">NEXT_LINE_HELP</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">18</span>;
|
||||
<span class="kw">const</span> <span class="ident">DISABLE_COLORED_HELP</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">20</span>;
|
||||
<span class="kw">const</span> <span class="ident">COLOR_ALWAYS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">21</span>;
|
||||
<span class="kw">const</span> <span class="ident">COLOR_AUTO</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">22</span>;
|
||||
<span class="kw">const</span> <span class="ident">COLOR_NEVER</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">23</span>;
|
||||
<span class="kw">const</span> <span class="ident">DONT_DELIM_TRAIL</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">24</span>;
|
||||
<span class="kw">const</span> <span class="ident">ALLOW_NEG_NUMS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">25</span>;
|
||||
<span class="kw">const</span> <span class="ident">DISABLE_HELP_SC</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">27</span>;
|
||||
<span class="kw">const</span> <span class="ident">ARGS_NEGATE_SCS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">29</span>;
|
||||
<span class="kw">const</span> <span class="ident">PROPAGATE_VALS_DOWN</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">30</span>;
|
||||
<span class="kw">const</span> <span class="ident">ALLOW_MISSING_POS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">31</span>;
|
||||
<span class="kw">const</span> <span class="ident">TRAILING_VALUES</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">32</span>;
|
||||
<span class="kw">const</span> <span class="ident">BUILT</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">33</span>;
|
||||
<span class="kw">const</span> <span class="ident">BIN_NAME_BUILT</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">34</span>;
|
||||
<span class="kw">const</span> <span class="ident">VALID_ARG_FOUND</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">35</span>;
|
||||
<span class="kw">const</span> <span class="ident">INFER_SUBCOMMANDS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">36</span>;
|
||||
<span class="kw">const</span> <span class="ident">CONTAINS_LAST</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">37</span>;
|
||||
<span class="kw">const</span> <span class="ident">ARGS_OVERRIDE_SELF</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">38</span>;
|
||||
<span class="kw">const</span> <span class="ident">HELP_REQUIRED</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">39</span>;
|
||||
<span class="kw">const</span> <span class="ident">SUBCOMMAND_PRECEDENCE_OVER_ARG</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">40</span>;
|
||||
<span class="kw">const</span> <span class="ident">DISABLE_HELP_FLAG</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">41</span>;
|
||||
<span class="kw">const</span> <span class="ident">INFER_LONG_ARGS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">43</span>;
|
||||
<span class="kw">const</span> <span class="ident">IGNORE_ERRORS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">44</span>;
|
||||
<span class="kw">const</span> <span class="ident">MULTICALL</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">45</span>;
|
||||
<span class="kw">const</span> <span class="ident">EXPAND_HELP_SUBCOMMAND_TREES</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">46</span>;
|
||||
<span class="kw">const</span> <span class="ident">NO_OP</span> <span class="op">=</span> <span class="number">0</span>;
|
||||
}
|
||||
}
|
||||
|
||||
<span class="macro">impl_settings!</span> { <span class="ident">AppSettings</span>, <span class="ident">AppFlags</span>,
|
||||
<span class="ident">ArgRequiredElseHelp</span>
|
||||
=> <span class="ident">Flags::ARG_REQUIRED_ELSE_HELP</span>,
|
||||
<span class="ident">SubcommandPrecedenceOverArg</span>
|
||||
=> <span class="ident">Flags::SUBCOMMAND_PRECEDENCE_OVER_ARG</span>,
|
||||
<span class="ident">ArgsNegateSubcommands</span>
|
||||
=> <span class="ident">Flags::ARGS_NEGATE_SCS</span>,
|
||||
<span class="ident">AllowExternalSubcommands</span>
|
||||
=> <span class="ident">Flags::ALLOW_UNK_SC</span>,
|
||||
<span class="ident">AllowHyphenValues</span>
|
||||
=> <span class="ident">Flags::LEADING_HYPHEN</span>,
|
||||
<span class="ident">AllowNegativeNumbers</span>
|
||||
=> <span class="ident">Flags::ALLOW_NEG_NUMS</span>,
|
||||
<span class="ident">AllowMissingPositional</span>
|
||||
=> <span class="ident">Flags::ALLOW_MISSING_POS</span>,
|
||||
<span class="ident">ColorAlways</span>
|
||||
=> <span class="ident">Flags::COLOR_ALWAYS</span>,
|
||||
<span class="ident">ColorAuto</span>
|
||||
=> <span class="ident">Flags::COLOR_AUTO</span>,
|
||||
<span class="ident">ColorNever</span>
|
||||
=> <span class="ident">Flags::COLOR_NEVER</span>,
|
||||
<span class="ident">DontDelimitTrailingValues</span>
|
||||
=> <span class="ident">Flags::DONT_DELIM_TRAIL</span>,
|
||||
<span class="ident">DisableColoredHelp</span>
|
||||
=> <span class="ident">Flags::DISABLE_COLORED_HELP</span>,
|
||||
<span class="ident">DisableHelpSubcommand</span>
|
||||
=> <span class="ident">Flags::DISABLE_HELP_SC</span>,
|
||||
<span class="ident">DisableHelpFlag</span>
|
||||
=> <span class="ident">Flags::DISABLE_HELP_FLAG</span>,
|
||||
<span class="ident">DisableVersionFlag</span>
|
||||
=> <span class="ident">Flags::DISABLE_VERSION_FLAG</span>,
|
||||
<span class="ident">PropagateVersion</span>
|
||||
=> <span class="ident">Flags::PROPAGATE_VERSION</span>,
|
||||
<span class="ident">HidePossibleValues</span>
|
||||
=> <span class="ident">Flags::NO_POS_VALUES</span>,
|
||||
<span class="ident">HelpExpected</span>
|
||||
=> <span class="ident">Flags::HELP_REQUIRED</span>,
|
||||
<span class="ident">Hidden</span>
|
||||
=> <span class="ident">Flags::HIDDEN</span>,
|
||||
<span class="ident">Multicall</span>
|
||||
=> <span class="ident">Flags::MULTICALL</span>,
|
||||
<span class="ident">NoBinaryName</span>
|
||||
=> <span class="ident">Flags::NO_BIN_NAME</span>,
|
||||
<span class="ident">SubcommandsNegateReqs</span>
|
||||
=> <span class="ident">Flags::SC_NEGATE_REQS</span>,
|
||||
<span class="ident">SubcommandRequired</span>
|
||||
=> <span class="ident">Flags::SC_REQUIRED</span>,
|
||||
<span class="ident">TrailingVarArg</span>
|
||||
=> <span class="ident">Flags::TRAILING_VARARG</span>,
|
||||
<span class="ident">NextLineHelp</span>
|
||||
=> <span class="ident">Flags::NEXT_LINE_HELP</span>,
|
||||
<span class="ident">IgnoreErrors</span>
|
||||
=> <span class="ident">Flags::IGNORE_ERRORS</span>,
|
||||
<span class="ident">Built</span>
|
||||
=> <span class="ident">Flags::BUILT</span>,
|
||||
<span class="ident">BinNameBuilt</span>
|
||||
=> <span class="ident">Flags::BIN_NAME_BUILT</span>,
|
||||
<span class="ident">InferSubcommands</span>
|
||||
=> <span class="ident">Flags::INFER_SUBCOMMANDS</span>,
|
||||
<span class="ident">AllArgsOverrideSelf</span>
|
||||
=> <span class="ident">Flags::ARGS_OVERRIDE_SELF</span>,
|
||||
<span class="ident">InferLongArgs</span>
|
||||
=> <span class="ident">Flags::INFER_LONG_ARGS</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>
|
||||
9284
doc/src/clap/builder/arg.rs.html
Normal file
9284
doc/src/clap/builder/arg.rs.html
Normal file
File diff suppressed because it is too large
Load Diff
1196
doc/src/clap/builder/arg_group.rs.html
Normal file
1196
doc/src/clap/builder/arg_group.rs.html
Normal file
File diff suppressed because it is too large
Load Diff
42
doc/src/clap/builder/arg_predicate.rs.html
Normal file
42
doc/src/clap/builder/arg_predicate.rs.html
Normal file
@ -0,0 +1,42 @@
|
||||
<!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/builder/arg_predicate.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>arg_predicate.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::OsStr</span>;
|
||||
|
||||
<span class="doccomment">/// Operations to perform on argument values</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// These do not apply to [`ValueSource::DefaultValue`][crate::parser::ValueSource::DefaultValue]</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"unstable-v5"</span>, <span class="ident">non_exhaustive</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ArgPredicate</span> {
|
||||
<span class="doccomment">/// Is the argument present?</span>
|
||||
<span class="ident">IsPresent</span>,
|
||||
<span class="doccomment">/// Does the argument match the specified value?</span>
|
||||
<span class="ident">Equals</span>(<span class="ident">OsStr</span>),
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ArgPredicate</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">other</span>: <span class="ident">S</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Equals</span>(<span class="ident">other</span>.<span class="ident">into</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>
|
||||
294
doc/src/clap/builder/arg_settings.rs.html
Normal file
294
doc/src/clap/builder/arg_settings.rs.html
Normal file
@ -0,0 +1,294 @@
|
||||
<!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/builder/arg_settings.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>arg_settings.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="comment">// Std</span>
|
||||
<span class="kw">use</span> <span class="ident">std::ops::BitOr</span>;
|
||||
|
||||
<span class="comment">// Third party</span>
|
||||
<span class="kw">use</span> <span class="ident">bitflags::bitflags</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused</span>)]</span>
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::Arg</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Copy</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">struct</span> <span class="ident">ArgFlags</span>(<span class="ident">Flags</span>);
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">ArgFlags</span> {
|
||||
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::empty</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Various settings that apply to arguments and may be set, unset, and checked via getter/setter</span>
|
||||
<span class="doccomment">/// methods [`Arg::setting`], [`Arg::unset_setting`], and [`Arg::is_set`]. This is what the</span>
|
||||
<span class="doccomment">/// [`Arg`] methods which accept a `bool` use internally.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [`Arg`]: crate::Arg</span>
|
||||
<span class="doccomment">/// [`Arg::setting`]: crate::Arg::setting()</span>
|
||||
<span class="doccomment">/// [`Arg::unset_setting`]: crate::Arg::unset_setting()</span>
|
||||
<span class="doccomment">/// [`Arg::is_set`]: crate::Arg::is_set()</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">non_exhaustive</span>]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum</span> <span class="ident">ArgSettings</span> {
|
||||
<span class="ident">Required</span>,
|
||||
<span class="ident">Global</span>,
|
||||
<span class="ident">Hidden</span>,
|
||||
<span class="ident">NextLineHelp</span>,
|
||||
<span class="ident">HidePossibleValues</span>,
|
||||
<span class="ident">AllowHyphenValues</span>,
|
||||
<span class="ident">AllowNegativeNumbers</span>,
|
||||
<span class="ident">RequireEquals</span>,
|
||||
<span class="ident">Last</span>,
|
||||
<span class="ident">TrailingVarArg</span>,
|
||||
<span class="ident">HideDefaultValue</span>,
|
||||
<span class="ident">IgnoreCase</span>,
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"env"</span>)]</span>
|
||||
<span class="ident">HideEnv</span>,
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"env"</span>)]</span>
|
||||
<span class="ident">HideEnvValues</span>,
|
||||
<span class="ident">HiddenShortHelp</span>,
|
||||
<span class="ident">HiddenLongHelp</span>,
|
||||
<span class="ident">Exclusive</span>,
|
||||
}
|
||||
|
||||
<span class="macro">bitflags!</span> {
|
||||
<span class="kw">struct</span> <span class="ident">Flags</span>: <span class="ident">u32</span> {
|
||||
<span class="kw">const</span> <span class="ident">REQUIRED</span> <span class="op">=</span> <span class="number">1</span>;
|
||||
<span class="kw">const</span> <span class="ident">GLOBAL</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">3</span>;
|
||||
<span class="kw">const</span> <span class="ident">HIDDEN</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">4</span>;
|
||||
<span class="kw">const</span> <span class="ident">TRAILING_VARARG</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">5</span>;
|
||||
<span class="kw">const</span> <span class="ident">ALLOW_NEG_NUMS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">6</span>;
|
||||
<span class="kw">const</span> <span class="ident">NEXT_LINE_HELP</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">7</span>;
|
||||
<span class="kw">const</span> <span class="ident">DELIM_NOT_SET</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">10</span>;
|
||||
<span class="kw">const</span> <span class="ident">HIDE_POS_VALS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">11</span>;
|
||||
<span class="kw">const</span> <span class="ident">ALLOW_TAC_VALS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">12</span>;
|
||||
<span class="kw">const</span> <span class="ident">REQUIRE_EQUALS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">13</span>;
|
||||
<span class="kw">const</span> <span class="ident">LAST</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">14</span>;
|
||||
<span class="kw">const</span> <span class="ident">HIDE_DEFAULT_VAL</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">15</span>;
|
||||
<span class="kw">const</span> <span class="ident">CASE_INSENSITIVE</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">16</span>;
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"env"</span>)]</span>
|
||||
<span class="kw">const</span> <span class="ident">HIDE_ENV_VALS</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">17</span>;
|
||||
<span class="kw">const</span> <span class="ident">HIDDEN_SHORT_H</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">18</span>;
|
||||
<span class="kw">const</span> <span class="ident">HIDDEN_LONG_H</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">19</span>;
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"env"</span>)]</span>
|
||||
<span class="kw">const</span> <span class="ident">HIDE_ENV</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">21</span>;
|
||||
<span class="kw">const</span> <span class="ident">EXCLUSIVE</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">23</span>;
|
||||
<span class="kw">const</span> <span class="ident">NO_OP</span> <span class="op">=</span> <span class="number">0</span>;
|
||||
}
|
||||
}
|
||||
|
||||
<span class="macro">impl_settings!</span> { <span class="ident">ArgSettings</span>, <span class="ident">ArgFlags</span>,
|
||||
<span class="ident">Required</span> => <span class="ident">Flags::REQUIRED</span>,
|
||||
<span class="ident">Global</span> => <span class="ident">Flags::GLOBAL</span>,
|
||||
<span class="ident">Hidden</span> => <span class="ident">Flags::HIDDEN</span>,
|
||||
<span class="ident">NextLineHelp</span> => <span class="ident">Flags::NEXT_LINE_HELP</span>,
|
||||
<span class="ident">HidePossibleValues</span> => <span class="ident">Flags::HIDE_POS_VALS</span>,
|
||||
<span class="ident">AllowHyphenValues</span> => <span class="ident">Flags::ALLOW_TAC_VALS</span>,
|
||||
<span class="ident">AllowNegativeNumbers</span> => <span class="ident">Flags::ALLOW_NEG_NUMS</span>,
|
||||
<span class="ident">RequireEquals</span> => <span class="ident">Flags::REQUIRE_EQUALS</span>,
|
||||
<span class="ident">Last</span> => <span class="ident">Flags::LAST</span>,
|
||||
<span class="ident">TrailingVarArg</span> => <span class="ident">Flags::TRAILING_VARARG</span>,
|
||||
<span class="ident">IgnoreCase</span> => <span class="ident">Flags::CASE_INSENSITIVE</span>,
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"env"</span>)]</span>
|
||||
<span class="ident">HideEnv</span> => <span class="ident">Flags::HIDE_ENV</span>,
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"env"</span>)]</span>
|
||||
<span class="ident">HideEnvValues</span> => <span class="ident">Flags::HIDE_ENV_VALS</span>,
|
||||
<span class="ident">HideDefaultValue</span> => <span class="ident">Flags::HIDE_DEFAULT_VAL</span>,
|
||||
<span class="ident">HiddenShortHelp</span> => <span class="ident">Flags::HIDDEN_SHORT_H</span>,
|
||||
<span class="ident">HiddenLongHelp</span> => <span class="ident">Flags::HIDDEN_LONG_H</span>,
|
||||
<span class="ident">Exclusive</span> => <span class="ident">Flags::EXCLUSIVE</span>
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">test</span> {
|
||||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::Arg</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">setting</span>() {
|
||||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">Arg::new</span>(<span class="string">"setting"</span>).<span class="ident">setting</span>(<span class="ident">ArgSettings::Required</span>);
|
||||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">is_required_set</span>());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">unset_setting</span>() {
|
||||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">Arg::new</span>(<span class="string">"unset_setting"</span>).<span class="ident">setting</span>(<span class="ident">ArgSettings::Required</span>);
|
||||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">is_required_set</span>());
|
||||
|
||||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">unset_setting</span>(<span class="ident">ArgSettings::Required</span>);
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">m</span>.<span class="ident">is_required_set</span>(), <span class="string">"{:#?}"</span>, <span class="ident">m</span>);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">setting_bitor</span>() {
|
||||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">Arg::new</span>(<span class="string">"setting_bitor"</span>)
|
||||
.<span class="ident">setting</span>(<span class="ident">ArgSettings::Required</span> <span class="op">|</span> <span class="ident">ArgSettings::Hidden</span> <span class="op">|</span> <span class="ident">ArgSettings::Last</span>);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">is_required_set</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">is_hide_set</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">is_last_set</span>());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">unset_setting_bitor</span>() {
|
||||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">Arg::new</span>(<span class="string">"unset_setting_bitor"</span>)
|
||||
.<span class="ident">setting</span>(<span class="ident">ArgSettings::Required</span>)
|
||||
.<span class="ident">setting</span>(<span class="ident">ArgSettings::Hidden</span>)
|
||||
.<span class="ident">setting</span>(<span class="ident">ArgSettings::Last</span>);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">is_required_set</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">is_hide_set</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">is_last_set</span>());
|
||||
|
||||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">m</span>.<span class="ident">unset_setting</span>(<span class="ident">ArgSettings::Required</span> <span class="op">|</span> <span class="ident">ArgSettings::Hidden</span> <span class="op">|</span> <span class="ident">ArgSettings::Last</span>);
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">m</span>.<span class="ident">is_required_set</span>(), <span class="string">"{:#?}"</span>, <span class="ident">m</span>);
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">m</span>.<span class="ident">is_hide_set</span>(), <span class="string">"{:#?}"</span>, <span class="ident">m</span>);
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">m</span>.<span class="ident">is_last_set</span>(), <span class="string">"{:#?}"</span>, <span class="ident">m</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>
|
||||
9410
doc/src/clap/builder/command.rs.html
Normal file
9410
doc/src/clap/builder/command.rs.html
Normal file
File diff suppressed because it is too large
Load Diff
1778
doc/src/clap/builder/debug_asserts.rs.html
Normal file
1778
doc/src/clap/builder/debug_asserts.rs.html
Normal file
File diff suppressed because it is too large
Load Diff
124
doc/src/clap/builder/mod.rs.html
Normal file
124
doc/src/clap/builder/mod.rs.html
Normal file
@ -0,0 +1,124 @@
|
||||
<!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/builder/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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Define [`Command`] line [arguments][`Arg`]</span>
|
||||
|
||||
<span class="kw">mod</span> <span class="ident">action</span>;
|
||||
<span class="kw">mod</span> <span class="ident">app_settings</span>;
|
||||
<span class="kw">mod</span> <span class="ident">arg</span>;
|
||||
<span class="kw">mod</span> <span class="ident">arg_group</span>;
|
||||
<span class="kw">mod</span> <span class="ident">arg_predicate</span>;
|
||||
<span class="kw">mod</span> <span class="ident">arg_settings</span>;
|
||||
<span class="kw">mod</span> <span class="ident">command</span>;
|
||||
<span class="kw">mod</span> <span class="ident">os_str</span>;
|
||||
<span class="kw">mod</span> <span class="ident">possible_value</span>;
|
||||
<span class="kw">mod</span> <span class="ident">range</span>;
|
||||
<span class="kw">mod</span> <span class="ident">resettable</span>;
|
||||
<span class="kw">mod</span> <span class="ident">str</span>;
|
||||
<span class="kw">mod</span> <span class="ident">styled_str</span>;
|
||||
<span class="kw">mod</span> <span class="ident">value_hint</span>;
|
||||
<span class="kw">mod</span> <span class="ident">value_parser</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">debug_assertions</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">debug_asserts</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">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::str::Str</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">action::ArgAction</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">arg::Arg</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">arg_group::ArgGroup</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">arg_predicate::ArgPredicate</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">command::Command</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">os_str::OsStr</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">possible_value::PossibleValue</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">range::ValueRange</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">resettable::IntoResettable</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">resettable::Resettable</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">styled_str::StyledStr</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_hint::ValueHint</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::_AutoValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::via_prelude</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::BoolValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::BoolishValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::EnumValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::FalseyValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::MapValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::NonEmptyStringValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::OsStringValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::PathBufValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::PossibleValuesParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::RangedI64ValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::RangedU64ValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::StringValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::TypedValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::ValueParser</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::ValueParserFactory</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value_parser::_AnonymousValueParser</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_imports</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>::str::Inner</span> <span class="kw">as</span> <span class="ident">StrInner</span>;
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">action::CountType</span>;
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">arg_settings</span>::{<span class="ident">ArgFlags</span>, <span class="ident">ArgSettings</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>
|
||||
676
doc/src/clap/builder/os_str.rs.html
Normal file
676
doc/src/clap/builder/os_str.rs.html
Normal file
@ -0,0 +1,676 @@
|
||||
<!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/builder/os_str.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>os_str.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::Str</span>;
|
||||
|
||||
<span class="doccomment">/// A UTF-8-encoded fixed string</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// **NOTE:** To support dynamic values (i.e. `OsString`), enable the [`string`</span>
|
||||
<span class="doccomment">/// feature][crate::_features]</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Default</span>, <span class="ident">Clone</span>, <span class="ident">Eq</span>, <span class="ident">PartialEq</span>, <span class="ident">PartialOrd</span>, <span class="ident">Ord</span>, <span class="ident">Hash</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">OsStr</span> {
|
||||
<span class="ident">name</span>: <span class="ident">Inner</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_string</span>(<span class="ident">name</span>: <span class="ident">std::ffi::OsString</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span> {
|
||||
<span class="ident">name</span>: <span class="ident">Inner::from_string</span>(<span class="ident">name</span>),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_ref</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="ident">std::ffi::OsStr</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span> {
|
||||
<span class="ident">name</span>: <span class="ident">Inner::from_ref</span>(<span class="ident">name</span>),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_static_ref</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span> {
|
||||
<span class="ident">name</span>: <span class="ident">Inner::from_static_ref</span>(<span class="ident">name</span>),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Get the raw string as an `std::ffi::OsStr`</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_os_str</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">std::ffi::OsStr</span> {
|
||||
<span class="self">self</span>.<span class="ident">name</span>.<span class="ident">as_os_str</span>()
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Get the raw string as an `OsString`</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_os_string</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">std::ffi::OsString</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_os_str</span>().<span class="ident">to_owned</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">id</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">OsStr</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">id</span>.<span class="ident">clone</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">id</span>: <span class="ident">Str</span>) -> <span class="self">Self</span> {
|
||||
<span class="kw">match</span> <span class="ident">id</span>.<span class="ident">into_inner</span>() {
|
||||
<span class="ident"><span class="kw">crate</span>::builder::StrInner::Static</span>(<span class="ident">s</span>) => <span class="ident"><span class="self">Self</span>::from_static_ref</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="ident">s</span>)),
|
||||
<span class="ident"><span class="kw">crate</span>::builder::StrInner::Owned</span>(<span class="ident">s</span>) => <span class="ident"><span class="self">Self</span>::from_ref</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="ident">s</span>.<span class="ident">as_ref</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">"string"</span>))]</span>
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">id</span>: <span class="ident">Str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_static_ref</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="ident">id</span>.<span class="ident">into_inner</span>().<span class="number">0</span>))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"perf"</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">id</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">Str</span>) -> <span class="self">Self</span> {
|
||||
<span class="kw">match</span> <span class="ident">id</span>.<span class="ident">clone</span>().<span class="ident">into_inner</span>() {
|
||||
<span class="ident"><span class="kw">crate</span>::builder::StrInner::Static</span>(<span class="ident">s</span>) => <span class="ident"><span class="self">Self</span>::from_static_ref</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="ident">s</span>)),
|
||||
<span class="ident"><span class="kw">crate</span>::builder::StrInner::Owned</span>(<span class="ident">s</span>) => <span class="ident"><span class="self">Self</span>::from_ref</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="ident">s</span>.<span class="ident">as_ref</span>())),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">id</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">Str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">id</span>.<span class="ident">clone</span>().<span class="ident">into</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">std::ffi::OsString</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="ident">std::ffi::OsString</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_string</span>(<span class="ident">name</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::ffi::OsString</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::ffi::OsString</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_ref</span>(<span class="ident">name</span>.<span class="ident">as_os_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">std::string::String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="ident">std::string::String</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_string</span>(<span class="ident">name</span>.<span class="ident">into</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::string::String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::string::String</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_ref</span>(<span class="ident">name</span>.<span class="ident">as_str</span>().<span class="ident">as_ref</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_static_ref</span>(<span class="ident">name</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_static_ref</span>(<span class="ident">name</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_static_ref</span>(<span class="ident">name</span>.<span class="ident">as_ref</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_static_ref</span>((<span class="kw-2">*</span><span class="ident">name</span>).<span class="ident">as_ref</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">std::ffi::OsString</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="ident">OsStr</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">name</span>.<span class="ident">name</span>.<span class="ident">into_os_string</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">std::path::PathBuf</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="ident">OsStr</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">std::ffi::OsString::from</span>(<span class="ident">name</span>).<span class="ident">into</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::fmt::Debug</span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">std::fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">std::fmt::Result</span> {
|
||||
<span class="ident">std::fmt::Debug::fmt</span>(<span class="self">self</span>.<span class="ident">as_os_str</span>(), <span class="ident">f</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::ops::Deref</span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">std::ffi::OsStr</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">std::ffi::OsStr</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_os_str</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">std::ffi::OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">std::ffi::OsStr</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_os_str</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">std::path::Path</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">std::path::Path</span> {
|
||||
<span class="ident">std::path::Path::new</span>(<span class="self">self</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::borrow::Borrow</span><span class="op"><</span><span class="ident">std::ffi::OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">borrow</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">std::ffi::OsStr</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_os_str</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_os_str</span>(), <span class="ident">other</span>)
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">OsStr</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>, <span class="ident">other</span>.<span class="ident">as_os_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="op">&&</span><span class="ident">str</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_os_str</span>(), <span class="kw-2">*</span><span class="ident">other</span>)
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">OsStr</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="kw-2">*</span><span class="self">self</span>, <span class="ident">other</span>.<span class="ident">as_os_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::ffi::OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="op">&&</span><span class="ident">std::ffi::OsStr</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_os_str</span>(), <span class="kw-2">*</span><span class="ident">other</span>)
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::ffi::OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">OsStr</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="kw-2">*</span><span class="self">self</span>, <span class="ident">other</span>.<span class="ident">as_os_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">std::string::String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">std::string::String</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_os_str</span>(), <span class="ident">other</span>.<span class="ident">as_str</span>())
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">std::string::String</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">OsStr</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_str</span>(), <span class="ident">other</span>.<span class="ident">as_os_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">std::ffi::OsString</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">std::ffi::OsString</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_os_str</span>(), <span class="ident">other</span>.<span class="ident">as_os_str</span>())
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">std::ffi::OsString</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">OsStr</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_os_str</span>(), <span class="ident">other</span>.<span class="ident">as_os_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod</span> <span class="ident">inner</span> {
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum</span> <span class="ident">Inner</span> {
|
||||
<span class="ident">Static</span>(<span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span>),
|
||||
<span class="ident">Owned</span>(<span class="ident">Box</span><span class="op"><</span><span class="ident">std::ffi::OsStr</span><span class="op">></span>),
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_string</span>(<span class="ident">name</span>: <span class="ident">std::ffi::OsString</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Owned</span>(<span class="ident">name</span>.<span class="ident">into_boxed_os_str</span>())
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_ref</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="ident">std::ffi::OsStr</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Owned</span>(<span class="ident">Box::from</span>(<span class="ident">name</span>))
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_static_ref</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Static</span>(<span class="ident">name</span>)
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">as_os_str</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">std::ffi::OsStr</span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Static</span>(<span class="ident">s</span>) => <span class="ident">s</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Owned</span>(<span class="ident">s</span>) => <span class="ident">s</span>.<span class="ident">as_ref</span>(),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_os_string</span>(<span class="self">self</span>) -> <span class="ident">std::ffi::OsString</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_os_str</span>().<span class="ident">to_owned</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">"string"</span>))]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod</span> <span class="ident">inner</span> {
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">Inner</span>(<span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span>);
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_static_ref</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">std::ffi::OsStr</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span>(<span class="ident">name</span>)
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">as_os_str</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">std::ffi::OsStr</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_os_string</span>(<span class="self">self</span>) -> <span class="ident">std::ffi::OsString</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_os_str</span>().<span class="ident">to_owned</span>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">inner::Inner</span>;
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_static_ref</span>(<span class="ident">std::ffi::OsStr::new</span>(<span class="string">""</span>))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span> <span class="kw">for</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">Inner</span>) -> <span class="ident">bool</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_os_str</span>() <span class="op">==</span> <span class="ident">other</span>.<span class="ident">as_os_str</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialOrd</span> <span class="kw">for</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">fn</span> <span class="ident">partial_cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">std::cmp::Ordering</span><span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="ident">as_os_str</span>().<span class="ident">partial_cmp</span>(<span class="ident">other</span>.<span class="ident">as_os_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Ord</span> <span class="kw">for</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">fn</span> <span class="ident">cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">Inner</span>) -> <span class="ident">std::cmp::Ordering</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_os_str</span>().<span class="ident">cmp</span>(<span class="ident">other</span>.<span class="ident">as_os_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Eq</span> <span class="kw">for</span> <span class="ident">Inner</span> {}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::hash::Hash</span> <span class="kw">for</span> <span class="ident">Inner</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">hash</span><span class="op"><</span><span class="ident">H</span>: <span class="ident">std::hash::Hasher</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">state</span>: <span class="kw-2">&mut</span> <span class="ident">H</span>) {
|
||||
<span class="self">self</span>.<span class="ident">as_os_str</span>().<span class="ident">hash</span>(<span class="ident">state</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>
|
||||
472
doc/src/clap/builder/possible_value.rs.html
Normal file
472
doc/src/clap/builder/possible_value.rs.html
Normal file
@ -0,0 +1,472 @@
|
||||
<!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/builder/possible_value.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>possible_value.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::IntoResettable</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::Str</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>::util::eq_ignore_case</span>;
|
||||
|
||||
<span class="doccomment">/// A possible value of an argument.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// This is used for specifying [possible values] of [Args].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// See also [`PossibleValuesParser`][crate::builder::PossibleValuesParser]</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// **NOTE:** Most likely you can use strings, rather than `PossibleValue` as it is only required</span>
|
||||
<span class="doccomment">/// to [hide] single values from help messages and shell completions or to attach [help] to</span>
|
||||
<span class="doccomment">/// possible values.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::{Arg, builder::PossibleValue, ArgAction};</span>
|
||||
<span class="doccomment">/// let cfg = Arg::new("config")</span>
|
||||
<span class="doccomment">/// .action(ArgAction::Set)</span>
|
||||
<span class="doccomment">/// .value_name("FILE")</span>
|
||||
<span class="doccomment">/// .value_parser([</span>
|
||||
<span class="doccomment">/// PossibleValue::new("fast"),</span>
|
||||
<span class="doccomment">/// PossibleValue::new("slow").help("slower than fast"),</span>
|
||||
<span class="doccomment">/// PossibleValue::new("secret speed").hide(true)</span>
|
||||
<span class="doccomment">/// ]);</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [Args]: crate::Arg</span>
|
||||
<span class="doccomment">/// [possible values]: crate::builder::ValueParser::possible_values</span>
|
||||
<span class="doccomment">/// [hide]: PossibleValue::hide()</span>
|
||||
<span class="doccomment">/// [help]: PossibleValue::help()</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">PossibleValue</span> {
|
||||
<span class="ident">name</span>: <span class="ident">Str</span>,
|
||||
<span class="ident">help</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">StyledStr</span><span class="op">></span>,
|
||||
<span class="ident">aliases</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span>, <span class="comment">// (name, visible)</span>
|
||||
<span class="ident">hide</span>: <span class="ident">bool</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PossibleValue</span> {
|
||||
<span class="doccomment">/// Create a [`PossibleValue`] with its name.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// The name will be used to decide whether this value was provided by the user to an argument.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// **NOTE:** In case it is not [hidden] it will also be shown in help messages for arguments</span>
|
||||
<span class="doccomment">/// that use it as a [possible value] and have not hidden them through [`Arg::hide_possible_values(true)`].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::builder::PossibleValue;</span>
|
||||
<span class="doccomment">/// PossibleValue::new("fast")</span>
|
||||
<span class="doccomment">/// # ;</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// [hidden]: PossibleValue::hide</span>
|
||||
<span class="doccomment">/// [possible value]: crate::builder::PossibleValuesParser</span>
|
||||
<span class="doccomment">/// [`Arg::hide_possible_values(true)`]: crate::Arg::hide_possible_values()</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">name</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">PossibleValue</span> {
|
||||
<span class="ident">name</span>: <span class="ident">name</span>.<span class="ident">into</span>(),
|
||||
..<span class="ident">Default::default</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Sets the help description of the value.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// This is typically displayed in completions (where supported) and should be a short, one-line</span>
|
||||
<span class="doccomment">/// description.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::builder::PossibleValue;</span>
|
||||
<span class="doccomment">/// PossibleValue::new("slow")</span>
|
||||
<span class="doccomment">/// .help("not fast")</span>
|
||||
<span class="doccomment">/// # ;</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="attribute">#[<span class="ident">must_use</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">help</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">help</span>: <span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">StyledStr</span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="self">self</span>.<span class="ident">help</span> <span class="op">=</span> <span class="ident">help</span>.<span class="ident">into_resettable</span>().<span class="ident">into_option</span>();
|
||||
<span class="self">self</span>
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Hides this value from help and shell completions.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// This is an alternative to hiding through [`Arg::hide_possible_values(true)`], if you only</span>
|
||||
<span class="doccomment">/// want to hide some values.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::builder::PossibleValue;</span>
|
||||
<span class="doccomment">/// PossibleValue::new("secret")</span>
|
||||
<span class="doccomment">/// .hide(true)</span>
|
||||
<span class="doccomment">/// # ;</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// [`Arg::hide_possible_values(true)`]: crate::Arg::hide_possible_values()</span>
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="attribute">#[<span class="ident">must_use</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">hide</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">yes</span>: <span class="ident">bool</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">self</span>.<span class="ident">hide</span> <span class="op">=</span> <span class="ident">yes</span>;
|
||||
<span class="self">self</span>
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Sets a *hidden* alias for this argument value.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::builder::PossibleValue;</span>
|
||||
<span class="doccomment">/// PossibleValue::new("slow")</span>
|
||||
<span class="doccomment">/// .alias("not-fast")</span>
|
||||
<span class="doccomment">/// # ;</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="attribute">#[<span class="ident">must_use</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">alias</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">name</span>: <span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">name</span>) <span class="op">=</span> <span class="ident">name</span>.<span class="ident">into_resettable</span>().<span class="ident">into_option</span>() {
|
||||
<span class="self">self</span>.<span class="ident">aliases</span>.<span class="ident">push</span>(<span class="ident">name</span>);
|
||||
} <span class="kw">else</span> {
|
||||
<span class="self">self</span>.<span class="ident">aliases</span>.<span class="ident">clear</span>();
|
||||
}
|
||||
<span class="self">self</span>
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Sets multiple *hidden* aliases for this argument value.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::builder::PossibleValue;</span>
|
||||
<span class="doccomment">/// PossibleValue::new("slow")</span>
|
||||
<span class="doccomment">/// .aliases(["not-fast", "snake-like"])</span>
|
||||
<span class="doccomment">/// # ;</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="attribute">#[<span class="ident">must_use</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">aliases</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">names</span>: <span class="kw">impl</span> <span class="ident">IntoIterator</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="self">self</span>.<span class="ident">aliases</span>.<span class="ident">extend</span>(<span class="ident">names</span>.<span class="ident">into_iter</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">a</span><span class="op">|</span> <span class="ident">a</span>.<span class="ident">into</span>()));
|
||||
<span class="self">self</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Reflection</span>
|
||||
<span class="kw">impl</span> <span class="ident">PossibleValue</span> {
|
||||
<span class="doccomment">/// Get the name of the argument value</span>
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_name</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="self">self</span>.<span class="ident">name</span>.<span class="ident">as_str</span>()
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Get the help specified for this argument, if any</span>
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_help</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">StyledStr</span><span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="ident">help</span>.<span class="ident">as_ref</span>()
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Get the help specified for this argument, if any and the argument</span>
|
||||
<span class="doccomment">/// value is not hidden</span>
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"help"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">get_visible_help</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">StyledStr</span><span class="op">></span> {
|
||||
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">hide</span> {
|
||||
<span class="self">self</span>.<span class="ident">get_help</span>()
|
||||
} <span class="kw">else</span> {
|
||||
<span class="prelude-val">None</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Report if [`PossibleValue::hide`] is set</span>
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_hide_set</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">bool</span> {
|
||||
<span class="self">self</span>.<span class="ident">hide</span>
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Report if PossibleValue is not hidden and has a help message</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">should_show_help</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">bool</span> {
|
||||
<span class="op">!</span><span class="self">self</span>.<span class="ident">hide</span> <span class="op">&&</span> <span class="self">self</span>.<span class="ident">help</span>.<span class="ident">is_some</span>()
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Get the name if argument value is not hidden, `None` otherwise,</span>
|
||||
<span class="doccomment">/// but wrapped in quotes if it contains whitespace</span>
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"help"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">get_visible_quoted_name</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">std::borrow::Cow</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span> {
|
||||
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">hide</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="kw">if</span> <span class="self">self</span>.<span class="ident">name</span>.<span class="ident">contains</span>(<span class="ident">char::is_whitespace</span>) {
|
||||
<span class="macro">format!</span>(<span class="string">"{:?}"</span>, <span class="self">self</span>.<span class="ident">name</span>).<span class="ident">into</span>()
|
||||
} <span class="kw">else</span> {
|
||||
<span class="self">self</span>.<span class="ident">name</span>.<span class="ident">as_str</span>().<span class="ident">into</span>()
|
||||
})
|
||||
} <span class="kw">else</span> {
|
||||
<span class="prelude-val">None</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Returns all valid values of the argument value.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Namely the name and all aliases.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_name_and_aliases</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl</span> <span class="ident">Iterator</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> <span class="op">+</span> <span class="lifetime">'_</span> {
|
||||
<span class="ident">std::iter::once</span>(<span class="self">self</span>.<span class="ident">get_name</span>()).<span class="ident">chain</span>(<span class="self">self</span>.<span class="ident">aliases</span>.<span class="ident">iter</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">as_str</span>()))
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Tests if the value is valid for this argument value</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// The value is valid if it is either the name or one of the aliases.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::builder::PossibleValue;</span>
|
||||
<span class="doccomment">/// let arg_value = PossibleValue::new("fast").alias("not-slow");</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// assert!(arg_value.matches("fast", false));</span>
|
||||
<span class="doccomment">/// assert!(arg_value.matches("not-slow", false));</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// assert!(arg_value.matches("FAST", true));</span>
|
||||
<span class="doccomment">/// assert!(!arg_value.matches("FAST", false));</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">matches</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">value</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">ignore_case</span>: <span class="ident">bool</span>) -> <span class="ident">bool</span> {
|
||||
<span class="kw">if</span> <span class="ident">ignore_case</span> {
|
||||
<span class="self">self</span>.<span class="ident">get_name_and_aliases</span>()
|
||||
.<span class="ident">any</span>(<span class="op">|</span><span class="ident">name</span><span class="op">|</span> <span class="ident">eq_ignore_case</span>(<span class="ident">name</span>, <span class="ident">value</span>))
|
||||
} <span class="kw">else</span> {
|
||||
<span class="self">self</span>.<span class="ident">get_name_and_aliases</span>().<span class="ident">any</span>(<span class="op">|</span><span class="ident">name</span><span class="op">|</span> <span class="ident">name</span> <span class="op">==</span> <span class="ident">value</span>)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="kw">for</span> <span class="ident">PossibleValue</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">s</span>: <span class="ident">S</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::new</span>(<span class="ident">s</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>
|
||||
570
doc/src/clap/builder/range.rs.html
Normal file
570
doc/src/clap/builder/range.rs.html
Normal file
@ -0,0 +1,570 @@
|
||||
<!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/builder/range.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>range.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="doccomment">/// Values per occurrence for an argument</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Hash</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ValueRange</span> {
|
||||
<span class="ident">start_inclusive</span>: <span class="ident">usize</span>,
|
||||
<span class="ident">end_inclusive</span>: <span class="ident">usize</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">ValueRange</span> {
|
||||
<span class="doccomment">/// Nor argument values, or a flag</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">EMPTY</span>: <span class="self">Self</span> <span class="op">=</span> <span class="self">Self</span> {
|
||||
<span class="ident">start_inclusive</span>: <span class="number">0</span>,
|
||||
<span class="ident">end_inclusive</span>: <span class="number">0</span>,
|
||||
};
|
||||
|
||||
<span class="doccomment">/// A single argument value, the most common case for options</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">SINGLE</span>: <span class="self">Self</span> <span class="op">=</span> <span class="self">Self</span> {
|
||||
<span class="ident">start_inclusive</span>: <span class="number">1</span>,
|
||||
<span class="ident">end_inclusive</span>: <span class="number">1</span>,
|
||||
};
|
||||
|
||||
<span class="doccomment">/// Create a range</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Panics</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// If the end is less than the start</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use clap::builder::ValueRange;</span>
|
||||
<span class="doccomment">/// let range = ValueRange::new(5);</span>
|
||||
<span class="doccomment">/// let range = ValueRange::new(5..10);</span>
|
||||
<span class="doccomment">/// let range = ValueRange::new(5..=10);</span>
|
||||
<span class="doccomment">/// let range = ValueRange::new(5..);</span>
|
||||
<span class="doccomment">/// let range = ValueRange::new(..10);</span>
|
||||
<span class="doccomment">/// let range = ValueRange::new(..=10);</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// While this will panic:</span>
|
||||
<span class="doccomment">/// ```should_panic</span>
|
||||
<span class="doccomment">/// # use clap::builder::ValueRange;</span>
|
||||
<span class="doccomment">/// let range = ValueRange::new(10..5); // Panics!</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">range</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">range</span>.<span class="ident">into</span>()
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">raw</span>(<span class="ident">start_inclusive</span>: <span class="ident">usize</span>, <span class="ident">end_inclusive</span>: <span class="ident">usize</span>) -> <span class="self">Self</span> {
|
||||
<span class="macro">debug_assert!</span>(<span class="ident">start_inclusive</span> <span class="op"><</span><span class="op">=</span> <span class="ident">end_inclusive</span>);
|
||||
<span class="self">Self</span> {
|
||||
<span class="ident">start_inclusive</span>,
|
||||
<span class="ident">end_inclusive</span>,
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Fewest number of values the argument accepts</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">min_values</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">usize</span> {
|
||||
<span class="self">self</span>.<span class="ident">start_inclusive</span>
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Most number of values the argument accepts</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">max_values</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">usize</span> {
|
||||
<span class="self">self</span>.<span class="ident">end_inclusive</span>
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Report whether the argument takes any values (ie is a flag)</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use clap::builder::ValueRange;</span>
|
||||
<span class="doccomment">/// let range = ValueRange::new(5);</span>
|
||||
<span class="doccomment">/// assert!(range.takes_values());</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let range = ValueRange::new(0);</span>
|
||||
<span class="doccomment">/// assert!(!range.takes_values());</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">takes_values</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">bool</span> {
|
||||
<span class="self">self</span>.<span class="ident">end_inclusive</span> <span class="op">!</span><span class="op">=</span> <span class="number">0</span>
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">is_unbounded</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">bool</span> {
|
||||
<span class="self">self</span>.<span class="ident">end_inclusive</span> <span class="op">==</span> <span class="ident">usize::MAX</span>
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">is_fixed</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">bool</span> {
|
||||
<span class="self">self</span>.<span class="ident">start_inclusive</span> <span class="op">==</span> <span class="self">self</span>.<span class="ident">end_inclusive</span>
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">is_multiple</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">bool</span> {
|
||||
<span class="self">self</span>.<span class="ident">start_inclusive</span> <span class="op">!</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">end_inclusive</span> <span class="op">|</span><span class="op">|</span> <span class="number">1</span> <span class="op"><</span> <span class="self">self</span>.<span class="ident">start_inclusive</span>
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">num_values</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="ident">is_fixed</span>().<span class="ident">then</span>(<span class="op">|</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">start_inclusive</span>)
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">accepts_more</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">current</span>: <span class="ident">usize</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">current</span> <span class="op"><</span> <span class="self">self</span>.<span class="ident">end_inclusive</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::ops::RangeBounds</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">start_bound</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">std::ops::Bound</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">usize</span><span class="op">></span> {
|
||||
<span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">start_inclusive</span>)
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">end_bound</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">std::ops::Bound</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">usize</span><span class="op">></span> {
|
||||
<span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">end_inclusive</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::SINGLE</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">fixed</span>: <span class="ident">usize</span>) -> <span class="self">Self</span> {
|
||||
(<span class="ident">fixed</span>..<span class="op">=</span><span class="ident">fixed</span>).<span class="ident">into</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">std::ops::Range</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span><span class="op">></span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">range</span>: <span class="ident">std::ops::Range</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="kw">let</span> <span class="ident">start_inclusive</span> <span class="op">=</span> <span class="ident">range</span>.<span class="ident">start</span>;
|
||||
<span class="kw">let</span> <span class="ident">end_inclusive</span> <span class="op">=</span> <span class="ident">range</span>.<span class="ident">end</span>.<span class="ident">saturating_sub</span>(<span class="number">1</span>);
|
||||
<span class="ident"><span class="self">Self</span>::raw</span>(<span class="ident">start_inclusive</span>, <span class="ident">end_inclusive</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">std::ops::RangeFull</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="kw">_</span>: <span class="ident">std::ops::RangeFull</span>) -> <span class="self">Self</span> {
|
||||
<span class="kw">let</span> <span class="ident">start_inclusive</span> <span class="op">=</span> <span class="number">0</span>;
|
||||
<span class="kw">let</span> <span class="ident">end_inclusive</span> <span class="op">=</span> <span class="ident">usize::MAX</span>;
|
||||
<span class="ident"><span class="self">Self</span>::raw</span>(<span class="ident">start_inclusive</span>, <span class="ident">end_inclusive</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">std::ops::RangeFrom</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span><span class="op">></span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">range</span>: <span class="ident">std::ops::RangeFrom</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="kw">let</span> <span class="ident">start_inclusive</span> <span class="op">=</span> <span class="ident">range</span>.<span class="ident">start</span>;
|
||||
<span class="kw">let</span> <span class="ident">end_inclusive</span> <span class="op">=</span> <span class="ident">usize::MAX</span>;
|
||||
<span class="ident"><span class="self">Self</span>::raw</span>(<span class="ident">start_inclusive</span>, <span class="ident">end_inclusive</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">std::ops::RangeTo</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span><span class="op">></span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">range</span>: <span class="ident">std::ops::RangeTo</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="kw">let</span> <span class="ident">start_inclusive</span> <span class="op">=</span> <span class="number">0</span>;
|
||||
<span class="kw">let</span> <span class="ident">end_inclusive</span> <span class="op">=</span> <span class="ident">range</span>.<span class="ident">end</span>.<span class="ident">saturating_sub</span>(<span class="number">1</span>);
|
||||
<span class="ident"><span class="self">Self</span>::raw</span>(<span class="ident">start_inclusive</span>, <span class="ident">end_inclusive</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">std::ops::RangeInclusive</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span><span class="op">></span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">range</span>: <span class="ident">std::ops::RangeInclusive</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="kw">let</span> <span class="ident">start_inclusive</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">range</span>.<span class="ident">start</span>();
|
||||
<span class="kw">let</span> <span class="ident">end_inclusive</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">range</span>.<span class="ident">end</span>();
|
||||
<span class="ident"><span class="self">Self</span>::raw</span>(<span class="ident">start_inclusive</span>, <span class="ident">end_inclusive</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">std::ops::RangeToInclusive</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span><span class="op">></span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">range</span>: <span class="ident">std::ops::RangeToInclusive</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="kw">let</span> <span class="ident">start_inclusive</span> <span class="op">=</span> <span class="number">0</span>;
|
||||
<span class="kw">let</span> <span class="ident">end_inclusive</span> <span class="op">=</span> <span class="ident">range</span>.<span class="ident">end</span>;
|
||||
<span class="ident"><span class="self">Self</span>::raw</span>(<span class="ident">start_inclusive</span>, <span class="ident">end_inclusive</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::fmt::Display</span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">std::fmt::Formatter</span>) -> <span class="ident">std::fmt::Result</span> {
|
||||
<span class="macro">ok!</span>(<span class="self">self</span>.<span class="ident">start_inclusive</span>.<span class="ident">fmt</span>(<span class="ident">f</span>));
|
||||
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">is_fixed</span>() {
|
||||
<span class="macro">ok!</span>(<span class="string">"..="</span>.<span class="ident">fmt</span>(<span class="ident">f</span>));
|
||||
<span class="macro">ok!</span>(<span class="self">self</span>.<span class="ident">end_inclusive</span>.<span class="ident">fmt</span>(<span class="ident">f</span>));
|
||||
}
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::fmt::Debug</span> <span class="kw">for</span> <span class="ident">ValueRange</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">std::fmt::Formatter</span>) -> <span class="ident">std::fmt::Result</span> {
|
||||
<span class="macro">write!</span>(<span class="ident">f</span>, <span class="string">"{}"</span>, <span class="self">self</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">test</span> {
|
||||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std::ops::RangeBounds</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">from_fixed</span>() {
|
||||
<span class="kw">let</span> <span class="ident">range</span>: <span class="ident">ValueRange</span> <span class="op">=</span> <span class="number">5</span>.<span class="ident">into</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">start_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">5</span>));
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">end_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">5</span>));
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">is_fixed</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">is_multiple</span>());
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">num_values</span>(), <span class="prelude-val">Some</span>(<span class="number">5</span>));
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">takes_values</span>());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">from_fixed_empty</span>() {
|
||||
<span class="kw">let</span> <span class="ident">range</span>: <span class="ident">ValueRange</span> <span class="op">=</span> <span class="number">0</span>.<span class="ident">into</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">start_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">0</span>));
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">end_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">0</span>));
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">is_fixed</span>());
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">range</span>.<span class="ident">is_multiple</span>());
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">num_values</span>(), <span class="prelude-val">Some</span>(<span class="number">0</span>));
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">range</span>.<span class="ident">takes_values</span>());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">from_range</span>() {
|
||||
<span class="kw">let</span> <span class="ident">range</span>: <span class="ident">ValueRange</span> <span class="op">=</span> (<span class="number">5</span>..<span class="number">10</span>).<span class="ident">into</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">start_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">5</span>));
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">end_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">9</span>));
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">range</span>.<span class="ident">is_fixed</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">is_multiple</span>());
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">num_values</span>(), <span class="prelude-val">None</span>);
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">takes_values</span>());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">from_range_inclusive</span>() {
|
||||
<span class="kw">let</span> <span class="ident">range</span>: <span class="ident">ValueRange</span> <span class="op">=</span> (<span class="number">5</span>..<span class="op">=</span><span class="number">10</span>).<span class="ident">into</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">start_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">5</span>));
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">end_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">10</span>));
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">range</span>.<span class="ident">is_fixed</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">is_multiple</span>());
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">num_values</span>(), <span class="prelude-val">None</span>);
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">takes_values</span>());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">from_range_full</span>() {
|
||||
<span class="kw">let</span> <span class="ident">range</span>: <span class="ident">ValueRange</span> <span class="op">=</span> (..).<span class="ident">into</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">start_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">0</span>));
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">end_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="ident">usize::MAX</span>));
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">range</span>.<span class="ident">is_fixed</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">is_multiple</span>());
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">num_values</span>(), <span class="prelude-val">None</span>);
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">takes_values</span>());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">from_range_from</span>() {
|
||||
<span class="kw">let</span> <span class="ident">range</span>: <span class="ident">ValueRange</span> <span class="op">=</span> (<span class="number">5</span>..).<span class="ident">into</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">start_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">5</span>));
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">end_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="ident">usize::MAX</span>));
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">range</span>.<span class="ident">is_fixed</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">is_multiple</span>());
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">num_values</span>(), <span class="prelude-val">None</span>);
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">takes_values</span>());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">from_range_to</span>() {
|
||||
<span class="kw">let</span> <span class="ident">range</span>: <span class="ident">ValueRange</span> <span class="op">=</span> (..<span class="number">10</span>).<span class="ident">into</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">start_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">0</span>));
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">end_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">9</span>));
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">range</span>.<span class="ident">is_fixed</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">is_multiple</span>());
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">num_values</span>(), <span class="prelude-val">None</span>);
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">takes_values</span>());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">from_range_to_inclusive</span>() {
|
||||
<span class="kw">let</span> <span class="ident">range</span>: <span class="ident">ValueRange</span> <span class="op">=</span> (..<span class="op">=</span><span class="number">10</span>).<span class="ident">into</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">start_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">0</span>));
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">end_bound</span>(), <span class="ident">std::ops::Bound::Included</span>(<span class="kw-2">&</span><span class="number">10</span>));
|
||||
<span class="macro">assert!</span>(<span class="op">!</span><span class="ident">range</span>.<span class="ident">is_fixed</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">is_multiple</span>());
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">range</span>.<span class="ident">num_values</span>(), <span class="prelude-val">None</span>);
|
||||
<span class="macro">assert!</span>(<span class="ident">range</span>.<span class="ident">takes_values</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>
|
||||
426
doc/src/clap/builder/resettable.rs.html
Normal file
426
doc/src/clap/builder/resettable.rs.html
Normal file
@ -0,0 +1,426 @@
|
||||
<!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/builder/resettable.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>resettable.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="comment">// Unlike `impl Into<Option<T>>` or `Option<impl Into<T>>`, this isn't ambiguous for the `None`</span>
|
||||
<span class="comment">// case.</span>
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::ArgAction</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::OsStr</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::Str</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::ValueHint</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::ValueParser</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::builder::ValueRange</span>;
|
||||
|
||||
<span class="doccomment">/// Clearable builder value</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// This allows a builder function to both accept any value that can [`Into::into`] `T` (like</span>
|
||||
<span class="doccomment">/// `&str` into `OsStr`) as well as `None` to reset it to the default. This is needed to</span>
|
||||
<span class="doccomment">/// workaround a limitation where you can't have a function argument that is `impl Into<Option<T>>`</span>
|
||||
<span class="doccomment">/// where `T` is `impl Into<S>` accept `None` as its type is ambiguous.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Example</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```rust</span>
|
||||
<span class="doccomment">/// # use clap::Command;</span>
|
||||
<span class="doccomment">/// # use clap::Arg;</span>
|
||||
<span class="doccomment">/// fn common() -> Command {</span>
|
||||
<span class="doccomment">/// Command::new("cli")</span>
|
||||
<span class="doccomment">/// .arg(Arg::new("input").short('i').long("input"))</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">/// let mut command = common();</span>
|
||||
<span class="doccomment">/// command.mut_arg("input", |arg| arg.short(None));</span>
|
||||
<span class="doccomment">/// ```</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 class="ident">PartialOrd</span>, <span class="ident">Ord</span>, <span class="ident">Hash</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||||
<span class="doccomment">/// Overwrite builder value</span>
|
||||
<span class="ident">Value</span>(<span class="ident">T</span>),
|
||||
<span class="doccomment">/// Reset builder value</span>
|
||||
<span class="ident">Reset</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_option</span>(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Value</span>(<span class="ident">t</span>) => <span class="prelude-val">Some</span>(<span class="ident">t</span>),
|
||||
<span class="ident"><span class="self">Self</span>::Reset</span> => <span class="prelude-val">None</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">other</span>: <span class="ident">T</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Value</span>(<span class="ident">other</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">T</span><span class="op">></span><span class="op">></span> <span class="kw">for</span> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">other</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>) -> <span class="self">Self</span> {
|
||||
<span class="kw">match</span> <span class="ident">other</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">inner</span>) => <span class="ident"><span class="self">Self</span>::Value</span>(<span class="ident">inner</span>),
|
||||
<span class="prelude-val">None</span> => <span class="ident"><span class="self">Self</span>::Reset</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Convert to the intended resettable type</span>
|
||||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||||
<span class="doccomment">/// Convert to the intended resettable type</span>
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>;
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">char</span><span class="op">></span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">char</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">char</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">s</span>) => <span class="ident">Resettable::Value</span>(<span class="ident">s</span>),
|
||||
<span class="prelude-val">None</span> => <span class="ident">Resettable::Reset</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">s</span>) => <span class="ident">Resettable::Value</span>(<span class="ident">s</span>),
|
||||
<span class="prelude-val">None</span> => <span class="ident">Resettable::Reset</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">ArgAction</span><span class="op">></span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ArgAction</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">ArgAction</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">s</span>) => <span class="ident">Resettable::Value</span>(<span class="ident">s</span>),
|
||||
<span class="prelude-val">None</span> => <span class="ident">Resettable::Reset</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">ValueHint</span><span class="op">></span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ValueHint</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">ValueHint</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">s</span>) => <span class="ident">Resettable::Value</span>(<span class="ident">s</span>),
|
||||
<span class="prelude-val">None</span> => <span class="ident">Resettable::Reset</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">ValueParser</span><span class="op">></span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ValueParser</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">ValueParser</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">s</span>) => <span class="ident">Resettable::Value</span>(<span class="ident">s</span>),
|
||||
<span class="prelude-val">None</span> => <span class="ident">Resettable::Reset</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">StyledStr</span><span class="op">></span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">StyledStr</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">s</span>) => <span class="ident">Resettable::Value</span>(<span class="ident">s</span>.<span class="ident">into</span>()),
|
||||
<span class="prelude-val">None</span> => <span class="ident">Resettable::Reset</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">s</span>) => <span class="ident">Resettable::Value</span>(<span class="ident">s</span>.<span class="ident">into</span>()),
|
||||
<span class="prelude-val">None</span> => <span class="ident">Resettable::Reset</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">s</span>) => <span class="ident">Resettable::Value</span>(<span class="ident">s</span>.<span class="ident">into</span>()),
|
||||
<span class="prelude-val">None</span> => <span class="ident">Resettable::Reset</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||||
<span class="self">self</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">char</span><span class="op">></span> <span class="kw">for</span> <span class="ident">char</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">char</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> <span class="kw">for</span> <span class="ident">usize</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">ArgAction</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ArgAction</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">ArgAction</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">ValueHint</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ValueHint</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">ValueHint</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">I</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">ValueRange</span><span class="op">></span><span class="op">></span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">ValueRange</span><span class="op">></span> <span class="kw">for</span> <span class="ident">I</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">ValueRange</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>.<span class="ident">into</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">I</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">ValueParser</span><span class="op">></span><span class="op">></span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">ValueParser</span><span class="op">></span> <span class="kw">for</span> <span class="ident">I</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">ValueParser</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>.<span class="ident">into</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">I</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">I</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>.<span class="ident">into</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">I</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">StyledStr</span><span class="op">></span><span class="op">></span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">StyledStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">I</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">StyledStr</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>.<span class="ident">into</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">I</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span><span class="op">></span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">I</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">OsStr</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>.<span class="ident">into</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">I</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span><span class="op">></span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">I</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>.<span class="ident">into</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">I</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident"><span class="kw">crate</span>::Id</span><span class="op">></span><span class="op">></span> <span class="ident">IntoResettable</span><span class="op"><</span><span class="ident"><span class="kw">crate</span>::Id</span><span class="op">></span> <span class="kw">for</span> <span class="ident">I</span> {
|
||||
<span class="kw">fn</span> <span class="ident">into_resettable</span>(<span class="self">self</span>) -> <span class="ident">Resettable</span><span class="op"><</span><span class="ident"><span class="kw">crate</span>::Id</span><span class="op">></span> {
|
||||
<span class="ident">Resettable::Value</span>(<span class="self">self</span>.<span class="ident">into</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>
|
||||
618
doc/src/clap/builder/str.rs.html
Normal file
618
doc/src/clap/builder/str.rs.html
Normal file
@ -0,0 +1,618 @@
|
||||
<!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/builder/str.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>str.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="doccomment">/// A UTF-8-encoded fixed string</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// **NOTE:** To support dynamic values (i.e. `String`), enable the [`string`</span>
|
||||
<span class="doccomment">/// feature][crate::_features]</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Default</span>, <span class="ident">Clone</span>, <span class="ident">Eq</span>, <span class="ident">PartialEq</span>, <span class="ident">PartialOrd</span>, <span class="ident">Ord</span>, <span class="ident">Hash</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Str</span> {
|
||||
<span class="ident">name</span>: <span class="ident">Inner</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_string</span>(<span class="ident">name</span>: <span class="ident">std::string::String</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span> {
|
||||
<span class="ident">name</span>: <span class="ident">Inner::from_string</span>(<span class="ident">name</span>),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_ref</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span> {
|
||||
<span class="ident">name</span>: <span class="ident">Inner::from_ref</span>(<span class="ident">name</span>),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_static_ref</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span> {
|
||||
<span class="ident">name</span>: <span class="ident">Inner::from_static_ref</span>(<span class="ident">name</span>),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) -> <span class="ident">Inner</span> {
|
||||
<span class="self">self</span>.<span class="ident">name</span>
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Get the raw string of the `Str`</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_str</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="self">self</span>.<span class="ident">name</span>.<span class="ident">as_str</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">id</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">Str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">id</span>.<span class="ident">clone</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">std::string::String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="ident">std::string::String</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_string</span>(<span class="ident">name</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::string::String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::string::String</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_ref</span>(<span class="ident">name</span>.<span class="ident">as_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_static_ref</span>(<span class="ident">name</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_static_ref</span>(<span class="ident">name</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">String</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="ident">Str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">name</span>.<span class="ident">name</span>.<span class="ident">into_string</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="ident">Str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">String::from</span>(<span class="ident">name</span>).<span class="ident">into</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">std::ffi::OsString</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="ident">Str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">String::from</span>(<span class="ident">name</span>).<span class="ident">into</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">std::path::PathBuf</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="ident">Str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">String::from</span>(<span class="ident">name</span>).<span class="ident">into</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::fmt::Display</span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">std::fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">std::fmt::Result</span> {
|
||||
<span class="ident">std::fmt::Display::fmt</span>(<span class="self">self</span>.<span class="ident">as_str</span>(), <span class="ident">f</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::fmt::Debug</span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">std::fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">std::fmt::Result</span> {
|
||||
<span class="ident">std::fmt::Debug::fmt</span>(<span class="self">self</span>.<span class="ident">as_str</span>(), <span class="ident">f</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::ops::Deref</span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">str</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_str</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_str</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[<span class="ident">u8</span>] {
|
||||
<span class="self">self</span>.<span class="ident">as_bytes</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">std::ffi::OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">std::ffi::OsStr</span> {
|
||||
(<span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span>).<span class="ident">as_ref</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">std::path::Path</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">std::path::Path</span> {
|
||||
<span class="ident">std::path::Path::new</span>(<span class="self">self</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::borrow::Borrow</span><span class="op"><</span><span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">borrow</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_str</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_str</span>(), <span class="ident">other</span>)
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">Str</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>, <span class="ident">other</span>.<span class="ident">as_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="op">&&</span><span class="ident">str</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_str</span>(), <span class="kw-2">*</span><span class="ident">other</span>)
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">Str</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="kw-2">*</span><span class="self">self</span>, <span class="ident">other</span>.<span class="ident">as_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">std::ffi::OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">std::ffi::OsStr</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_str</span>(), <span class="ident">other</span>)
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">std::ffi::OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">Str</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>, <span class="ident">other</span>.<span class="ident">as_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::ffi::OsStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="op">&&</span><span class="ident">std::ffi::OsStr</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_str</span>(), <span class="kw-2">*</span><span class="ident">other</span>)
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::ffi::OsStr</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">Str</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="kw-2">*</span><span class="self">self</span>, <span class="ident">other</span>.<span class="ident">as_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">std::string::String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Str</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">std::string::String</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_str</span>(), <span class="ident">other</span>.<span class="ident">as_str</span>())
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">Str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">std::string::String</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">Str</span>) -> <span class="ident">bool</span> {
|
||||
<span class="ident">PartialEq::eq</span>(<span class="self">self</span>.<span class="ident">as_str</span>(), <span class="ident">other</span>.<span class="ident">as_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"string"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod</span> <span class="ident">inner</span> {
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum</span> <span class="ident">Inner</span> {
|
||||
<span class="ident">Static</span>(<span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>),
|
||||
<span class="ident">Owned</span>(<span class="ident">Box</span><span class="op"><</span><span class="ident">str</span><span class="op">></span>),
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_string</span>(<span class="ident">name</span>: <span class="ident">std::string::String</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Owned</span>(<span class="ident">name</span>.<span class="ident">into_boxed_str</span>())
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_ref</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Owned</span>(<span class="ident">Box::from</span>(<span class="ident">name</span>))
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_static_ref</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Static</span>(<span class="ident">name</span>)
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">as_str</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Static</span>(<span class="ident">s</span>) => <span class="ident">s</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Owned</span>(<span class="ident">s</span>) => <span class="ident">s</span>.<span class="ident">as_ref</span>(),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_string</span>(<span class="self">self</span>) -> <span class="ident">String</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_str</span>().<span class="ident">to_owned</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">"string"</span>))]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod</span> <span class="ident">inner</span> {
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">Inner</span>(<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>);
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_static_ref</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span>(<span class="ident">name</span>)
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">as_str</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_string</span>(<span class="self">self</span>) -> <span class="ident">String</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_str</span>().<span class="ident">to_owned</span>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="ident">inner::Inner</span>;
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::from_static_ref</span>(<span class="string">""</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialEq</span> <span class="kw">for</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">Inner</span>) -> <span class="ident">bool</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_str</span>() <span class="op">==</span> <span class="ident">other</span>.<span class="ident">as_str</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialOrd</span> <span class="kw">for</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">fn</span> <span class="ident">partial_cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">std::cmp::Ordering</span><span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="ident">as_str</span>().<span class="ident">partial_cmp</span>(<span class="ident">other</span>.<span class="ident">as_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Ord</span> <span class="kw">for</span> <span class="ident">Inner</span> {
|
||||
<span class="kw">fn</span> <span class="ident">cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">Inner</span>) -> <span class="ident">std::cmp::Ordering</span> {
|
||||
<span class="self">self</span>.<span class="ident">as_str</span>().<span class="ident">cmp</span>(<span class="ident">other</span>.<span class="ident">as_str</span>())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Eq</span> <span class="kw">for</span> <span class="ident">Inner</span> {}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">std::hash::Hash</span> <span class="kw">for</span> <span class="ident">Inner</span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">hash</span><span class="op"><</span><span class="ident">H</span>: <span class="ident">std::hash::Hasher</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">state</span>: <span class="kw-2">&mut</span> <span class="ident">H</span>) {
|
||||
<span class="self">self</span>.<span class="ident">as_str</span>().<span class="ident">hash</span>(<span class="ident">state</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>
|
||||
702
doc/src/clap/builder/styled_str.rs.html
Normal file
702
doc/src/clap/builder/styled_str.rs.html
Normal file
@ -0,0 +1,702 @@
|
||||
<!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/builder/styled_str.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>styled_str.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="doccomment">/// Terminal-styling container</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// For now, this is the same as a [`Str`][crate::builder::Str]. This exists to reserve space in</span>
|
||||
<span class="doccomment">/// the API for exposing terminal styling.</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Default</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">struct</span> <span class="ident">StyledStr</span> {
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="ident">pieces</span>: <span class="ident">Vec</span><span class="op"><</span>(<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span>, <span class="ident">String</span>)<span class="op">></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">"color"</span>))]</span>
|
||||
<span class="ident">pieces</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">StyledStr</span> {
|
||||
<span class="doccomment">/// Create an empty buffer</span>
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span> { <span class="ident">pieces</span>: <span class="ident">Vec::new</span>() }
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Create an empty 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">"color"</span>))]</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span> {
|
||||
<span class="ident">pieces</span>: <span class="ident">String::new</span>(),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Display using [ANSI Escape Code](https://en.wikipedia.org/wiki/ANSI_escape_code) styling</span>
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ansi</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl</span> <span class="ident">std::fmt::Display</span> <span class="op">+</span> <span class="lifetime">'_</span> {
|
||||
<span class="ident">AnsiDisplay</span> { <span class="ident">styled</span>: <span class="self">self</span> }
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">header</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) {
|
||||
<span class="self">self</span>.<span class="ident">stylize_</span>(<span class="prelude-val">Some</span>(<span class="ident">Style::Header</span>), <span class="ident">msg</span>.<span class="ident">into</span>());
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">literal</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) {
|
||||
<span class="self">self</span>.<span class="ident">stylize_</span>(<span class="prelude-val">Some</span>(<span class="ident">Style::Literal</span>), <span class="ident">msg</span>.<span class="ident">into</span>());
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">placeholder</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) {
|
||||
<span class="self">self</span>.<span class="ident">stylize_</span>(<span class="prelude-val">Some</span>(<span class="ident">Style::Placeholder</span>), <span class="ident">msg</span>.<span class="ident">into</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">"error-context"</span>), <span class="ident">allow</span>(<span class="ident">dead_code</span>))]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">good</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) {
|
||||
<span class="self">self</span>.<span class="ident">stylize_</span>(<span class="prelude-val">Some</span>(<span class="ident">Style::Good</span>), <span class="ident">msg</span>.<span class="ident">into</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">"error-context"</span>), <span class="ident">allow</span>(<span class="ident">dead_code</span>))]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">warning</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) {
|
||||
<span class="self">self</span>.<span class="ident">stylize_</span>(<span class="prelude-val">Some</span>(<span class="ident">Style::Warning</span>), <span class="ident">msg</span>.<span class="ident">into</span>());
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">error</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) {
|
||||
<span class="self">self</span>.<span class="ident">stylize_</span>(<span class="prelude-val">Some</span>(<span class="ident">Style::Error</span>), <span class="ident">msg</span>.<span class="ident">into</span>());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">hint</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) {
|
||||
<span class="self">self</span>.<span class="ident">stylize_</span>(<span class="prelude-val">Some</span>(<span class="ident">Style::Hint</span>), <span class="ident">msg</span>.<span class="ident">into</span>());
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">none</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) {
|
||||
<span class="self">self</span>.<span class="ident">stylize_</span>(<span class="prelude-val">None</span>, <span class="ident">msg</span>.<span class="ident">into</span>());
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">stylize</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">style</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span><span class="op">></span>, <span class="ident">msg</span>: <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) {
|
||||
<span class="self">self</span>.<span class="ident">stylize_</span>(<span class="ident">style</span>.<span class="ident">into</span>(), <span class="ident">msg</span>.<span class="ident">into</span>());
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">trim</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) {
|
||||
<span class="self">self</span>.<span class="ident">trim_start</span>();
|
||||
<span class="self">self</span>.<span class="ident">trim_end</span>();
|
||||
}
|
||||
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">trim_start</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) {
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>((<span class="kw">_</span>, <span class="ident">item</span>)) <span class="op">=</span> <span class="self">self</span>.<span class="ident">iter_mut</span>().<span class="ident">next</span>() {
|
||||
<span class="kw-2">*</span><span class="ident">item</span> <span class="op">=</span> <span class="ident">item</span>.<span class="ident">trim_start</span>().<span class="ident">to_owned</span>();
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">trim_end</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) {
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>((<span class="kw">_</span>, <span class="ident">item</span>)) <span class="op">=</span> <span class="self">self</span>.<span class="ident">pieces</span>.<span class="ident">last_mut</span>() {
|
||||
<span class="kw-2">*</span><span class="ident">item</span> <span class="op">=</span> <span class="ident">item</span>.<span class="ident">trim_end</span>().<span class="ident">to_owned</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">"color"</span>))]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">trim_end</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) {
|
||||
<span class="self">self</span>.<span class="ident">pieces</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">pieces</span>.<span class="ident">trim_end</span>().<span class="ident">to_owned</span>();
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"help"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">indent</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">initial</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">trailing</span>: <span class="kw-2">&</span><span class="ident">str</span>) {
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>((<span class="kw">_</span>, <span class="ident">first</span>)) <span class="op">=</span> <span class="self">self</span>.<span class="ident">iter_mut</span>().<span class="ident">next</span>() {
|
||||
<span class="ident">first</span>.<span class="ident">insert_str</span>(<span class="number">0</span>, <span class="ident">initial</span>);
|
||||
}
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">line_sep</span> <span class="op">=</span> <span class="string">"\n"</span>.<span class="ident">to_owned</span>();
|
||||
<span class="ident">line_sep</span>.<span class="ident">push_str</span>(<span class="ident">trailing</span>);
|
||||
<span class="kw">for</span> (<span class="kw">_</span>, <span class="ident">content</span>) <span class="kw">in</span> <span class="self">self</span>.<span class="ident">iter_mut</span>() {
|
||||
<span class="kw-2">*</span><span class="ident">content</span> <span class="op">=</span> <span class="ident">content</span>.<span class="ident">replace</span>(<span class="string">'\n'</span>, <span class="kw-2">&</span><span class="ident">line_sep</span>);
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"wrap_help"</span>), <span class="ident">feature</span> <span class="op">=</span> <span class="string">"help"</span>))]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">wrap</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">_hard_width</span>: <span class="ident">usize</span>) {}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"wrap_help"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">wrap</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">hard_width</span>: <span class="ident">usize</span>) {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">wrapper</span> <span class="op">=</span> <span class="ident"><span class="kw">crate</span>::output::textwrap::wrap_algorithms::LineWrapper::new</span>(<span class="ident">hard_width</span>);
|
||||
<span class="kw">for</span> (<span class="kw">_</span>, <span class="ident">content</span>) <span class="kw">in</span> <span class="self">self</span>.<span class="ident">iter_mut</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">i</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">'\n'</span>).<span class="ident">enumerate</span>() {
|
||||
<span class="kw">if</span> <span class="number">0</span> <span class="op"><</span> <span class="ident">i</span> {
|
||||
<span class="comment">// start of a section does not imply newline</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"><span class="kw">crate</span>::output::textwrap::word_separators::find_words_ascii_space</span>(<span class="ident">line</span>)
|
||||
.<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></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="kw">let</span> <span class="ident">total</span> <span class="op">=</span> <span class="ident">total</span>.<span class="ident">join</span>(<span class="string">""</span>);
|
||||
<span class="kw-2">*</span><span class="ident">content</span> <span class="op">=</span> <span class="ident">total</span>;
|
||||
}
|
||||
|
||||
<span class="self">self</span>.<span class="ident">trim_end</span>();
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="kw">fn</span> <span class="ident">stylize_</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">style</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span>, <span class="ident">msg</span>: <span class="ident">String</span>) {
|
||||
<span class="kw">if</span> <span class="op">!</span><span class="ident">msg</span>.<span class="ident">is_empty</span>() {
|
||||
<span class="self">self</span>.<span class="ident">pieces</span>.<span class="ident">push</span>((<span class="ident">style</span>, <span class="ident">msg</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">"color"</span>))]</span>
|
||||
<span class="kw">fn</span> <span class="ident">stylize_</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">_style</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span>, <span class="ident">msg</span>: <span class="ident">String</span>) {
|
||||
<span class="self">self</span>.<span class="ident">pieces</span>.<span class="ident">push_str</span>(<span class="kw-2">&</span><span class="ident">msg</span>);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">inline</span>(<span class="ident">never</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"help"</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="kw-2">&</span><span class="self">self</span>) -> <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">for</span> (<span class="kw">_</span>, <span class="ident">c</span>) <span class="kw">in</span> <span class="self">self</span>.<span class="ident">iter</span>() {
|
||||
<span class="ident">width</span> <span class="op">+</span><span class="op">=</span> <span class="ident"><span class="kw">crate</span>::output::display_width</span>(<span class="ident">c</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">"help"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">is_empty</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">bool</span> {
|
||||
<span class="self">self</span>.<span class="ident">pieces</span>.<span class="ident">is_empty</span>()
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">iter</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl</span> <span class="ident">Iterator</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> (<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span>, <span class="kw-2">&</span><span class="ident">str</span>)<span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="ident">pieces</span>.<span class="ident">iter</span>().<span class="ident">map</span>(<span class="op">|</span>(<span class="ident">s</span>, <span class="ident">c</span>)<span class="op">|</span> (<span class="kw-2">*</span><span class="ident">s</span>, <span class="ident">c</span>.<span class="ident">as_str</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">"color"</span>))]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">iter</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl</span> <span class="ident">Iterator</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> (<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span>, <span class="kw-2">&</span><span class="ident">str</span>)<span class="op">></span> {
|
||||
[(<span class="prelude-val">None</span>, <span class="self">self</span>.<span class="ident">pieces</span>.<span class="ident">as_str</span>())].<span class="ident">into_iter</span>()
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">iter_mut</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) -> <span class="kw">impl</span> <span class="ident">Iterator</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> (<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span>, <span class="kw-2">&mut</span> <span class="ident">String</span>)<span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="ident">pieces</span>.<span class="ident">iter_mut</span>().<span class="ident">map</span>(<span class="op">|</span>(<span class="ident">s</span>, <span class="ident">c</span>)<span class="op">|</span> (<span class="kw-2">*</span><span class="ident">s</span>, <span class="ident">c</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">"color"</span>))]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">iter_mut</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) -> <span class="kw">impl</span> <span class="ident">Iterator</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> (<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span>, <span class="kw-2">&mut</span> <span class="ident">String</span>)<span class="op">></span> {
|
||||
[(<span class="prelude-val">None</span>, <span class="kw-2">&mut</span> <span class="self">self</span>.<span class="ident">pieces</span>)].<span class="ident">into_iter</span>()
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_iter</span>(<span class="self">self</span>) -> <span class="kw">impl</span> <span class="ident">Iterator</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> (<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span>, <span class="ident">String</span>)<span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="ident">pieces</span>.<span class="ident">into_iter</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">"color"</span>))]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_iter</span>(<span class="self">self</span>) -> <span class="kw">impl</span> <span class="ident">Iterator</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> (<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span>, <span class="ident">String</span>)<span class="op">></span> {
|
||||
[(<span class="prelude-val">None</span>, <span class="self">self</span>.<span class="ident">pieces</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">extend</span>(
|
||||
<span class="kw-2">&mut</span> <span class="self">self</span>,
|
||||
<span class="ident">other</span>: <span class="kw">impl</span> <span class="ident">IntoIterator</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> (<span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span><span class="op">></span>, <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>)<span class="op">></span>,
|
||||
) {
|
||||
<span class="kw">for</span> (<span class="ident">style</span>, <span class="ident">content</span>) <span class="kw">in</span> <span class="ident">other</span> {
|
||||
<span class="self">self</span>.<span class="ident">stylize</span>(<span class="ident">style</span>.<span class="ident">into</span>(), <span class="ident">content</span>.<span class="ident">into</span>());
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">write_colored</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">buffer</span>: <span class="kw-2">&mut</span> <span class="ident">termcolor::Buffer</span>) -> <span class="ident">std::io::Result</span><span class="op"><</span>()<span class="op">></span> {
|
||||
<span class="kw">use</span> <span class="ident">std::io::Write</span>;
|
||||
<span class="kw">use</span> <span class="ident">termcolor::WriteColor</span>;
|
||||
|
||||
<span class="kw">for</span> (<span class="ident">style</span>, <span class="ident">content</span>) <span class="kw">in</span> <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">pieces</span> {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">color</span> <span class="op">=</span> <span class="ident">termcolor::ColorSpec::new</span>();
|
||||
<span class="kw">match</span> <span class="ident">style</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">Style::Header</span>) => {
|
||||
<span class="ident">color</span>.<span class="ident">set_bold</span>(<span class="bool-val">true</span>);
|
||||
<span class="ident">color</span>.<span class="ident">set_underline</span>(<span class="bool-val">true</span>);
|
||||
}
|
||||
<span class="prelude-val">Some</span>(<span class="ident">Style::Literal</span>) => {
|
||||
<span class="ident">color</span>.<span class="ident">set_bold</span>(<span class="bool-val">true</span>);
|
||||
}
|
||||
<span class="prelude-val">Some</span>(<span class="ident">Style::Placeholder</span>) => {}
|
||||
<span class="prelude-val">Some</span>(<span class="ident">Style::Good</span>) => {
|
||||
<span class="ident">color</span>.<span class="ident">set_fg</span>(<span class="prelude-val">Some</span>(<span class="ident">termcolor::Color::Green</span>));
|
||||
}
|
||||
<span class="prelude-val">Some</span>(<span class="ident">Style::Warning</span>) => {
|
||||
<span class="ident">color</span>.<span class="ident">set_fg</span>(<span class="prelude-val">Some</span>(<span class="ident">termcolor::Color::Yellow</span>));
|
||||
}
|
||||
<span class="prelude-val">Some</span>(<span class="ident">Style::Error</span>) => {
|
||||
<span class="ident">color</span>.<span class="ident">set_fg</span>(<span class="prelude-val">Some</span>(<span class="ident">termcolor::Color::Red</span>));
|
||||
<span class="ident">color</span>.<span class="ident">set_bold</span>(<span class="bool-val">true</span>);
|
||||
}
|
||||
<span class="prelude-val">Some</span>(<span class="ident">Style::Hint</span>) => {
|
||||
<span class="ident">color</span>.<span class="ident">set_dimmed</span>(<span class="bool-val">true</span>);
|
||||
}
|
||||
<span class="prelude-val">None</span> => {}
|
||||
}
|
||||
|
||||
<span class="macro">ok!</span>(<span class="ident">buffer</span>.<span class="ident">set_color</span>(<span class="kw-2">&</span><span class="ident">color</span>));
|
||||
<span class="macro">ok!</span>(<span class="ident">buffer</span>.<span class="ident">write_all</span>(<span class="ident">content</span>.<span class="ident">as_bytes</span>()));
|
||||
<span class="macro">ok!</span>(<span class="ident">buffer</span>.<span class="ident">reset</span>());
|
||||
}
|
||||
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">StyledStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
|
||||
<span class="kw">static</span> <span class="ident">DEFAULT</span>: <span class="ident">StyledStr</span> <span class="op">=</span> <span class="ident">StyledStr::new</span>();
|
||||
<span class="kw-2">&</span><span class="ident">DEFAULT</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">std::string::String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">StyledStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="ident">std::string::String</span>) -> <span class="self">Self</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">none</span>(<span class="ident">name</span>);
|
||||
<span class="ident">styled</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::string::String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">StyledStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="ident">std::string::String</span>) -> <span class="self">Self</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">none</span>(<span class="ident">name</span>);
|
||||
<span class="ident">styled</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">StyledStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) -> <span class="self">Self</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">none</span>(<span class="ident">name</span>);
|
||||
<span class="ident">styled</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'_</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">StyledStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'_</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">StyledStr::from</span>(<span class="kw-2">*</span><span class="ident">name</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">PartialOrd</span> <span class="kw">for</span> <span class="ident">StyledStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">partial_cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">std::cmp::Ordering</span><span class="op">></span> {
|
||||
<span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="ident">cmp</span>(<span class="ident">other</span>))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Ord</span> <span class="kw">for</span> <span class="ident">StyledStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="ident">std::cmp::Ordering</span> {
|
||||
<span class="self">self</span>.<span class="ident">iter</span>().<span class="ident">map</span>(<span class="ident">cmp_key</span>).<span class="ident">cmp</span>(<span class="ident">other</span>.<span class="ident">iter</span>().<span class="ident">map</span>(<span class="ident">cmp_key</span>))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">cmp_key</span>(<span class="ident">c</span>: (<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Style</span><span class="op">></span>, <span class="kw-2">&</span><span class="ident">str</span>)) -> (<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>, <span class="kw-2">&</span><span class="ident">str</span>) {
|
||||
<span class="kw">let</span> <span class="ident">style</span> <span class="op">=</span> <span class="ident">c</span>.<span class="number">0</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">as_usize</span>());
|
||||
<span class="kw">let</span> <span class="ident">content</span> <span class="op">=</span> <span class="ident">c</span>.<span class="number">1</span>;
|
||||
(<span class="ident">style</span>, <span class="ident">content</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">StyledStr</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">std::fmt::Formatter</span>) -> <span class="ident">std::fmt::Result</span> {
|
||||
<span class="kw">for</span> (<span class="kw">_</span>, <span class="ident">content</span>) <span class="kw">in</span> <span class="self">self</span>.<span class="ident">iter</span>() {
|
||||
<span class="macro">ok!</span>(<span class="ident">std::fmt::Display::fmt</span>(<span class="ident">content</span>, <span class="ident">f</span>));
|
||||
}
|
||||
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">AnsiDisplay</span><span class="op"><</span><span class="lifetime">'s</span><span class="op">></span> {
|
||||
<span class="ident">styled</span>: <span class="kw-2">&</span><span class="lifetime">'s</span> <span class="ident">StyledStr</span>,
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"color"</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">std::fmt::Display</span> <span class="kw">for</span> <span class="ident">AnsiDisplay</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">std::fmt::Formatter</span>) -> <span class="ident">std::fmt::Result</span> {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">termcolor::Buffer::ansi</span>();
|
||||
<span class="macro">ok!</span>(<span class="self">self</span>
|
||||
.<span class="ident">styled</span>
|
||||
.<span class="ident">write_colored</span>(<span class="kw-2">&mut</span> <span class="ident">buffer</span>)
|
||||
.<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">std::fmt::Error</span>));
|
||||
<span class="kw">let</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">buffer</span>.<span class="ident">into_inner</span>();
|
||||
<span class="kw">let</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="macro">ok!</span>(<span class="ident">String::from_utf8</span>(<span class="ident">buffer</span>).<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">std::fmt::Error</span>));
|
||||
<span class="macro">ok!</span>(<span class="ident">std::fmt::Display::fmt</span>(<span class="kw-2">&</span><span class="ident">buffer</span>, <span class="ident">f</span>));
|
||||
|
||||
<span class="prelude-val">Ok</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">Style</span> {
|
||||
<span class="ident">Header</span>,
|
||||
<span class="ident">Literal</span>,
|
||||
<span class="ident">Placeholder</span>,
|
||||
<span class="ident">Good</span>,
|
||||
<span class="ident">Warning</span>,
|
||||
<span class="ident">Error</span>,
|
||||
<span class="ident">Hint</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Style</span> {
|
||||
<span class="kw">fn</span> <span class="ident">as_usize</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">usize</span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::Header</span> => <span class="number">0</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Literal</span> => <span class="number">1</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Placeholder</span> => <span class="number">2</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Good</span> => <span class="number">3</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Warning</span> => <span class="number">4</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Error</span> => <span class="number">5</span>,
|
||||
<span class="ident"><span class="self">Self</span>::Hint</span> => <span class="number">6</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>
|
||||
194
doc/src/clap/builder/value_hint.rs.html
Normal file
194
doc/src/clap/builder/value_hint.rs.html
Normal file
@ -0,0 +1,194 @@
|
||||
<!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/builder/value_hint.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>value_hint.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">☰</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>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::str::FromStr</span>;
|
||||
|
||||
<span class="doccomment">/// Provide shell with hint on how to complete an argument.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// See [Arg::value_hint][crate::Arg::value_hint] to set this on an argument.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// See the `clap_complete` crate for completion script generation.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Overview of which hints are supported by which shell:</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// | Hint | zsh | fish[^1]|</span>
|
||||
<span class="doccomment">/// | ---------------------- | --- | ------- |</span>
|
||||
<span class="doccomment">/// | `AnyPath` | Yes | Yes |</span>
|
||||
<span class="doccomment">/// | `FilePath` | Yes | Yes |</span>
|
||||
<span class="doccomment">/// | `DirPath` | Yes | Yes |</span>
|
||||
<span class="doccomment">/// | `ExecutablePath` | Yes | Partial |</span>
|
||||
<span class="doccomment">/// | `CommandName` | Yes | Yes |</span>
|
||||
<span class="doccomment">/// | `CommandString` | Yes | Partial |</span>
|
||||
<span class="doccomment">/// | `CommandWithArguments` | Yes | |</span>
|
||||
<span class="doccomment">/// | `Username` | Yes | Yes |</span>
|
||||
<span class="doccomment">/// | `Hostname` | Yes | Yes |</span>
|
||||
<span class="doccomment">/// | `Url` | Yes | |</span>
|
||||
<span class="doccomment">/// | `EmailAddress` | Yes | |</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [^1]: fish completions currently only support named arguments (e.g. -o or --opt), not</span>
|
||||
<span class="doccomment">/// positional arguments.</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Hash</span>, <span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">non_exhaustive</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ValueHint</span> {
|
||||
<span class="doccomment">/// Default value if hint is not specified. Follows shell default behavior, which is usually</span>
|
||||
<span class="doccomment">/// auto-completing filenames.</span>
|
||||
<span class="ident">Unknown</span>,
|
||||
<span class="doccomment">/// None of the hints below apply. Disables shell completion for this argument.</span>
|
||||
<span class="ident">Other</span>,
|
||||
<span class="doccomment">/// Any existing path.</span>
|
||||
<span class="ident">AnyPath</span>,
|
||||
<span class="doccomment">/// Path to a file.</span>
|
||||
<span class="ident">FilePath</span>,
|
||||
<span class="doccomment">/// Path to a directory.</span>
|
||||
<span class="ident">DirPath</span>,
|
||||
<span class="doccomment">/// Path to an executable file.</span>
|
||||
<span class="ident">ExecutablePath</span>,
|
||||
<span class="doccomment">/// Name of a command, without arguments. May be relative to PATH, or full path to executable.</span>
|
||||
<span class="ident">CommandName</span>,
|
||||
<span class="doccomment">/// A single string containing a command and its arguments.</span>
|
||||
<span class="ident">CommandString</span>,
|
||||
<span class="doccomment">/// Capture the remaining arguments as a command name and arguments for that command. This is</span>
|
||||
<span class="doccomment">/// common when writing shell wrappers that execute anther command, for example `sudo` or `env`.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// This hint is special, the argument must be a positional argument and have</span>
|
||||
<span class="doccomment">/// [`.num_args(1..)`] and Command must use [`Command::trailing_var_arg(true)`]. The result is that the</span>
|
||||
<span class="doccomment">/// command line `my_app ls -la /` will be parsed as `["ls", "-la", "/"]` and clap won't try to</span>
|
||||
<span class="doccomment">/// parse the `-la` argument itself.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [`Command::trailing_var_arg(true)`]: crate::Command::trailing_var_arg</span>
|
||||
<span class="doccomment">/// [`.num_args(1..)`]: crate::Arg::num_args()</span>
|
||||
<span class="ident">CommandWithArguments</span>,
|
||||
<span class="doccomment">/// Name of a local operating system user.</span>
|
||||
<span class="ident">Username</span>,
|
||||
<span class="doccomment">/// Host name of a computer.</span>
|
||||
<span class="doccomment">/// Shells usually parse `/etc/hosts` and `.ssh/known_hosts` to complete hostnames.</span>
|
||||
<span class="ident">Hostname</span>,
|
||||
<span class="doccomment">/// Complete web address.</span>
|
||||
<span class="ident">Url</span>,
|
||||
<span class="doccomment">/// Email address.</span>
|
||||
<span class="ident">EmailAddress</span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">ValueHint</span> {
|
||||
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
|
||||
<span class="ident">ValueHint::Unknown</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">FromStr</span> <span class="kw">for</span> <span class="ident">ValueHint</span> {
|
||||
<span class="kw">type</span> <span class="prelude-val">Err</span> <span class="op">=</span> <span class="ident">String</span>;
|
||||
<span class="kw">fn</span> <span class="ident">from_str</span>(<span class="ident">s</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="op"><</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">FromStr</span><span class="op">></span><span class="ident">::Err</span><span class="op">></span> {
|
||||
<span class="prelude-val">Ok</span>(<span class="kw">match</span> <span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">s</span>.<span class="ident">to_ascii_lowercase</span>() {
|
||||
<span class="string">"unknown"</span> => <span class="ident">ValueHint::Unknown</span>,
|
||||
<span class="string">"other"</span> => <span class="ident">ValueHint::Other</span>,
|
||||
<span class="string">"anypath"</span> => <span class="ident">ValueHint::AnyPath</span>,
|
||||
<span class="string">"filepath"</span> => <span class="ident">ValueHint::FilePath</span>,
|
||||
<span class="string">"dirpath"</span> => <span class="ident">ValueHint::DirPath</span>,
|
||||
<span class="string">"executablepath"</span> => <span class="ident">ValueHint::ExecutablePath</span>,
|
||||
<span class="string">"commandname"</span> => <span class="ident">ValueHint::CommandName</span>,
|
||||
<span class="string">"commandstring"</span> => <span class="ident">ValueHint::CommandString</span>,
|
||||
<span class="string">"commandwitharguments"</span> => <span class="ident">ValueHint::CommandWithArguments</span>,
|
||||
<span class="string">"username"</span> => <span class="ident">ValueHint::Username</span>,
|
||||
<span class="string">"hostname"</span> => <span class="ident">ValueHint::Hostname</span>,
|
||||
<span class="string">"url"</span> => <span class="ident">ValueHint::Url</span>,
|
||||
<span class="string">"emailaddress"</span> => <span class="ident">ValueHint::EmailAddress</span>,
|
||||
<span class="kw">_</span> => <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">"unknown ValueHint: `{}`"</span>, <span class="ident">s</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>
|
||||
4874
doc/src/clap/builder/value_parser.rs.html
Normal file
4874
doc/src/clap/builder/value_parser.rs.html
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user