| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-2.34.0/src/args/arg_matches.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>arg_matches.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../clap/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| <span id="634">634</span> |
| <span id="635">635</span> |
| <span id="636">636</span> |
| <span id="637">637</span> |
| <span id="638">638</span> |
| <span id="639">639</span> |
| <span id="640">640</span> |
| <span id="641">641</span> |
| <span id="642">642</span> |
| <span id="643">643</span> |
| <span id="644">644</span> |
| <span id="645">645</span> |
| <span id="646">646</span> |
| <span id="647">647</span> |
| <span id="648">648</span> |
| <span id="649">649</span> |
| <span id="650">650</span> |
| <span id="651">651</span> |
| <span id="652">652</span> |
| <span id="653">653</span> |
| <span id="654">654</span> |
| <span id="655">655</span> |
| <span id="656">656</span> |
| <span id="657">657</span> |
| <span id="658">658</span> |
| <span id="659">659</span> |
| <span id="660">660</span> |
| <span id="661">661</span> |
| <span id="662">662</span> |
| <span id="663">663</span> |
| <span id="664">664</span> |
| <span id="665">665</span> |
| <span id="666">666</span> |
| <span id="667">667</span> |
| <span id="668">668</span> |
| <span id="669">669</span> |
| <span id="670">670</span> |
| <span id="671">671</span> |
| <span id="672">672</span> |
| <span id="673">673</span> |
| <span id="674">674</span> |
| <span id="675">675</span> |
| <span id="676">676</span> |
| <span id="677">677</span> |
| <span id="678">678</span> |
| <span id="679">679</span> |
| <span id="680">680</span> |
| <span id="681">681</span> |
| <span id="682">682</span> |
| <span id="683">683</span> |
| <span id="684">684</span> |
| <span id="685">685</span> |
| <span id="686">686</span> |
| <span id="687">687</span> |
| <span id="688">688</span> |
| <span id="689">689</span> |
| <span id="690">690</span> |
| <span id="691">691</span> |
| <span id="692">692</span> |
| <span id="693">693</span> |
| <span id="694">694</span> |
| <span id="695">695</span> |
| <span id="696">696</span> |
| <span id="697">697</span> |
| <span id="698">698</span> |
| <span id="699">699</span> |
| <span id="700">700</span> |
| <span id="701">701</span> |
| <span id="702">702</span> |
| <span id="703">703</span> |
| <span id="704">704</span> |
| <span id="705">705</span> |
| <span id="706">706</span> |
| <span id="707">707</span> |
| <span id="708">708</span> |
| <span id="709">709</span> |
| <span id="710">710</span> |
| <span id="711">711</span> |
| <span id="712">712</span> |
| <span id="713">713</span> |
| <span id="714">714</span> |
| <span id="715">715</span> |
| <span id="716">716</span> |
| <span id="717">717</span> |
| <span id="718">718</span> |
| <span id="719">719</span> |
| <span id="720">720</span> |
| <span id="721">721</span> |
| <span id="722">722</span> |
| <span id="723">723</span> |
| <span id="724">724</span> |
| <span id="725">725</span> |
| <span id="726">726</span> |
| <span id="727">727</span> |
| <span id="728">728</span> |
| <span id="729">729</span> |
| <span id="730">730</span> |
| <span id="731">731</span> |
| <span id="732">732</span> |
| <span id="733">733</span> |
| <span id="734">734</span> |
| <span id="735">735</span> |
| <span id="736">736</span> |
| <span id="737">737</span> |
| <span id="738">738</span> |
| <span id="739">739</span> |
| <span id="740">740</span> |
| <span id="741">741</span> |
| <span id="742">742</span> |
| <span id="743">743</span> |
| <span id="744">744</span> |
| <span id="745">745</span> |
| <span id="746">746</span> |
| <span id="747">747</span> |
| <span id="748">748</span> |
| <span id="749">749</span> |
| <span id="750">750</span> |
| <span id="751">751</span> |
| <span id="752">752</span> |
| <span id="753">753</span> |
| <span id="754">754</span> |
| <span id="755">755</span> |
| <span id="756">756</span> |
| <span id="757">757</span> |
| <span id="758">758</span> |
| <span id="759">759</span> |
| <span id="760">760</span> |
| <span id="761">761</span> |
| <span id="762">762</span> |
| <span id="763">763</span> |
| <span id="764">764</span> |
| <span id="765">765</span> |
| <span id="766">766</span> |
| <span id="767">767</span> |
| <span id="768">768</span> |
| <span id="769">769</span> |
| <span id="770">770</span> |
| <span id="771">771</span> |
| <span id="772">772</span> |
| <span id="773">773</span> |
| <span id="774">774</span> |
| <span id="775">775</span> |
| <span id="776">776</span> |
| <span id="777">777</span> |
| <span id="778">778</span> |
| <span id="779">779</span> |
| <span id="780">780</span> |
| <span id="781">781</span> |
| <span id="782">782</span> |
| <span id="783">783</span> |
| <span id="784">784</span> |
| <span id="785">785</span> |
| <span id="786">786</span> |
| <span id="787">787</span> |
| <span id="788">788</span> |
| <span id="789">789</span> |
| <span id="790">790</span> |
| <span id="791">791</span> |
| <span id="792">792</span> |
| <span id="793">793</span> |
| <span id="794">794</span> |
| <span id="795">795</span> |
| <span id="796">796</span> |
| <span id="797">797</span> |
| <span id="798">798</span> |
| <span id="799">799</span> |
| <span id="800">800</span> |
| <span id="801">801</span> |
| <span id="802">802</span> |
| <span id="803">803</span> |
| <span id="804">804</span> |
| <span id="805">805</span> |
| <span id="806">806</span> |
| <span id="807">807</span> |
| <span id="808">808</span> |
| <span id="809">809</span> |
| <span id="810">810</span> |
| <span id="811">811</span> |
| <span id="812">812</span> |
| <span id="813">813</span> |
| <span id="814">814</span> |
| <span id="815">815</span> |
| <span id="816">816</span> |
| <span id="817">817</span> |
| <span id="818">818</span> |
| <span id="819">819</span> |
| <span id="820">820</span> |
| <span id="821">821</span> |
| <span id="822">822</span> |
| <span id="823">823</span> |
| <span id="824">824</span> |
| <span id="825">825</span> |
| <span id="826">826</span> |
| <span id="827">827</span> |
| <span id="828">828</span> |
| <span id="829">829</span> |
| <span id="830">830</span> |
| <span id="831">831</span> |
| <span id="832">832</span> |
| <span id="833">833</span> |
| <span id="834">834</span> |
| <span id="835">835</span> |
| <span id="836">836</span> |
| <span id="837">837</span> |
| <span id="838">838</span> |
| <span id="839">839</span> |
| <span id="840">840</span> |
| <span id="841">841</span> |
| <span id="842">842</span> |
| <span id="843">843</span> |
| <span id="844">844</span> |
| <span id="845">845</span> |
| <span id="846">846</span> |
| <span id="847">847</span> |
| <span id="848">848</span> |
| <span id="849">849</span> |
| <span id="850">850</span> |
| <span id="851">851</span> |
| <span id="852">852</span> |
| <span id="853">853</span> |
| <span id="854">854</span> |
| <span id="855">855</span> |
| <span id="856">856</span> |
| <span id="857">857</span> |
| <span id="858">858</span> |
| <span id="859">859</span> |
| <span id="860">860</span> |
| <span id="861">861</span> |
| <span id="862">862</span> |
| <span id="863">863</span> |
| <span id="864">864</span> |
| <span id="865">865</span> |
| <span id="866">866</span> |
| <span id="867">867</span> |
| <span id="868">868</span> |
| <span id="869">869</span> |
| <span id="870">870</span> |
| <span id="871">871</span> |
| <span id="872">872</span> |
| <span id="873">873</span> |
| <span id="874">874</span> |
| <span id="875">875</span> |
| <span id="876">876</span> |
| <span id="877">877</span> |
| <span id="878">878</span> |
| <span id="879">879</span> |
| <span id="880">880</span> |
| <span id="881">881</span> |
| <span id="882">882</span> |
| <span id="883">883</span> |
| <span id="884">884</span> |
| <span id="885">885</span> |
| <span id="886">886</span> |
| <span id="887">887</span> |
| <span id="888">888</span> |
| <span id="889">889</span> |
| <span id="890">890</span> |
| <span id="891">891</span> |
| <span id="892">892</span> |
| <span id="893">893</span> |
| <span id="894">894</span> |
| <span id="895">895</span> |
| <span id="896">896</span> |
| <span id="897">897</span> |
| <span id="898">898</span> |
| <span id="899">899</span> |
| <span id="900">900</span> |
| <span id="901">901</span> |
| <span id="902">902</span> |
| <span id="903">903</span> |
| <span id="904">904</span> |
| <span id="905">905</span> |
| <span id="906">906</span> |
| <span id="907">907</span> |
| <span id="908">908</span> |
| <span id="909">909</span> |
| <span id="910">910</span> |
| <span id="911">911</span> |
| <span id="912">912</span> |
| <span id="913">913</span> |
| <span id="914">914</span> |
| <span id="915">915</span> |
| <span id="916">916</span> |
| <span id="917">917</span> |
| <span id="918">918</span> |
| <span id="919">919</span> |
| <span id="920">920</span> |
| <span id="921">921</span> |
| <span id="922">922</span> |
| <span id="923">923</span> |
| <span id="924">924</span> |
| <span id="925">925</span> |
| <span id="926">926</span> |
| <span id="927">927</span> |
| <span id="928">928</span> |
| <span id="929">929</span> |
| <span id="930">930</span> |
| <span id="931">931</span> |
| <span id="932">932</span> |
| <span id="933">933</span> |
| <span id="934">934</span> |
| <span id="935">935</span> |
| <span id="936">936</span> |
| <span id="937">937</span> |
| <span id="938">938</span> |
| <span id="939">939</span> |
| <span id="940">940</span> |
| <span id="941">941</span> |
| <span id="942">942</span> |
| <span id="943">943</span> |
| <span id="944">944</span> |
| <span id="945">945</span> |
| <span id="946">946</span> |
| <span id="947">947</span> |
| <span id="948">948</span> |
| <span id="949">949</span> |
| <span id="950">950</span> |
| <span id="951">951</span> |
| <span id="952">952</span> |
| <span id="953">953</span> |
| <span id="954">954</span> |
| <span id="955">955</span> |
| <span id="956">956</span> |
| <span id="957">957</span> |
| <span id="958">958</span> |
| <span id="959">959</span> |
| <span id="960">960</span> |
| <span id="961">961</span> |
| <span id="962">962</span> |
| <span id="963">963</span> |
| <span id="964">964</span> |
| <span id="965">965</span> |
| <span id="966">966</span> |
| <span id="967">967</span> |
| <span id="968">968</span> |
| <span id="969">969</span> |
| <span id="970">970</span> |
| <span id="971">971</span> |
| <span id="972">972</span> |
| <span id="973">973</span> |
| <span id="974">974</span> |
| <span id="975">975</span> |
| <span id="976">976</span> |
| <span id="977">977</span> |
| <span id="978">978</span> |
| <span id="979">979</span> |
| <span id="980">980</span> |
| <span id="981">981</span> |
| <span id="982">982</span> |
| <span id="983">983</span> |
| <span id="984">984</span> |
| <span id="985">985</span> |
| <span id="986">986</span> |
| <span id="987">987</span> |
| <span id="988">988</span> |
| <span id="989">989</span> |
| <span id="990">990</span> |
| <span id="991">991</span> |
| <span id="992">992</span> |
| <span id="993">993</span> |
| <span id="994">994</span> |
| <span id="995">995</span> |
| <span id="996">996</span> |
| <span id="997">997</span> |
| <span id="998">998</span> |
| <span id="999">999</span> |
| <span id="1000">1000</span> |
| <span id="1001">1001</span> |
| </pre><pre class="rust"><code><span class="comment">// Std |
| </span><span class="kw">use </span>std::{ |
| borrow::Cow, |
| collections::HashMap, |
| ffi::{OsStr, OsString}, |
| iter::Map, |
| slice::Iter, |
| }; |
| |
| <span class="comment">// Internal |
| </span><span class="kw">use crate</span>::{ |
| args::{MatchedArg, SubCommand}, |
| INVALID_UTF8, |
| }; |
| |
| <span class="doccomment">/// Used to get information about the arguments that were supplied to the program at runtime by |
| /// the user. New instances of this struct are obtained by using the [`App::get_matches`] family of |
| /// methods. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// let matches = App::new("MyApp") |
| /// .arg(Arg::with_name("out") |
| /// .long("output") |
| /// .required(true) |
| /// .takes_value(true)) |
| /// .arg(Arg::with_name("debug") |
| /// .short("d") |
| /// .multiple(true)) |
| /// .arg(Arg::with_name("cfg") |
| /// .short("c") |
| /// .takes_value(true)) |
| /// .get_matches(); // builds the instance of ArgMatches |
| /// |
| /// // to get information about the "cfg" argument we created, such as the value supplied we use |
| /// // various ArgMatches methods, such as ArgMatches::value_of |
| /// if let Some(c) = matches.value_of("cfg") { |
| /// println!("Value for -c: {}", c); |
| /// } |
| /// |
| /// // The ArgMatches::value_of method returns an Option because the user may not have supplied |
| /// // that argument at runtime. But if we specified that the argument was "required" as we did |
| /// // with the "out" argument, we can safely unwrap because `clap` verifies that was actually |
| /// // used at runtime. |
| /// println!("Value for --output: {}", matches.value_of("out").unwrap()); |
| /// |
| /// // You can check the presence of an argument |
| /// if matches.is_present("out") { |
| /// // Another way to check if an argument was present, or if it occurred multiple times is to |
| /// // use occurrences_of() which returns 0 if an argument isn't found at runtime, or the |
| /// // number of times that it occurred, if it was. To allow an argument to appear more than |
| /// // once, you must use the .multiple(true) method, otherwise it will only return 1 or 0. |
| /// if matches.occurrences_of("debug") > 2 { |
| /// println!("Debug mode is REALLY on, don't be crazy"); |
| /// } else { |
| /// println!("Debug mode kind of on"); |
| /// } |
| /// } |
| /// ``` |
| /// [`App::get_matches`]: ./struct.App.html#method.get_matches |
| </span><span class="attribute">#[derive(Debug, Clone)] |
| </span><span class="kw">pub struct </span>ArgMatches<<span class="lifetime">'a</span>> { |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub </span>args: HashMap<<span class="kw-2">&</span><span class="lifetime">'a </span>str, MatchedArg>, |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub </span>subcommand: <span class="prelude-ty">Option</span><Box<SubCommand<<span class="lifetime">'a</span>>>>, |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub </span>usage: <span class="prelude-ty">Option</span><String>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Default <span class="kw">for </span>ArgMatches<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| ArgMatches { |
| args: HashMap::new(), |
| subcommand: <span class="prelude-val">None</span>, |
| usage: <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> ArgMatches<<span class="lifetime">'a</span>> { |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub fn </span>new() -> <span class="self">Self </span>{ |
| ArgMatches { |
| ..Default::default() |
| } |
| } |
| |
| <span class="doccomment">/// Gets the value of a specific [option] or [positional] argument (i.e. an argument that takes |
| /// an additional value at runtime). If the option wasn't present at runtime |
| /// it returns `None`. |
| /// |
| /// *NOTE:* If getting a value for an option or positional argument that allows multiples, |
| /// prefer [`ArgMatches::values_of`] as `ArgMatches::value_of` will only return the *first* |
| /// value. |
| /// |
| /// # Panics |
| /// |
| /// This method will [`panic!`] if the value contains invalid UTF-8 code points. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("output") |
| /// .takes_value(true)) |
| /// .get_matches_from(vec!["myapp", "something"]); |
| /// |
| /// assert_eq!(m.value_of("output"), Some("something")); |
| /// ``` |
| /// [option]: ./struct.Arg.html#method.takes_value |
| /// [positional]: ./struct.Arg.html#method.index |
| /// [`ArgMatches::values_of`]: ./struct.ArgMatches.html#method.values_of |
| /// [`panic!`]: https://doc.rust-lang.org/std/macro.panic!.html |
| </span><span class="kw">pub fn </span>value_of<S: AsRef<str>>(<span class="kw-2">&</span><span class="self">self</span>, name: S) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(arg) = <span class="self">self</span>.args.get(name.as_ref()) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = arg.vals.get(<span class="number">0</span>) { |
| <span class="kw">return </span><span class="prelude-val">Some</span>(v.to_str().expect(INVALID_UTF8)); |
| } |
| } |
| <span class="prelude-val">None |
| </span>} |
| |
| <span class="doccomment">/// Gets the lossy value of a specific argument. If the argument wasn't present at runtime |
| /// it returns `None`. A lossy value is one which contains invalid UTF-8 code points, those |
| /// invalid points will be replaced with `\u{FFFD}` |
| /// |
| /// *NOTE:* If getting a value for an option or positional argument that allows multiples, |
| /// prefer [`Arg::values_of_lossy`] as `value_of_lossy()` will only return the *first* value. |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(not(unix), doc = <span class="string">" ```ignore"</span>)] |
| #[cfg_attr(unix, doc = <span class="string">" ```"</span>)] |
| </span><span class="doccomment">/// # use clap::{App, Arg}; |
| /// use std::ffi::OsString; |
| /// use std::os::unix::ffi::{OsStrExt,OsStringExt}; |
| /// |
| /// let m = App::new("utf8") |
| /// .arg(Arg::from_usage("<arg> 'some arg'")) |
| /// .get_matches_from(vec![OsString::from("myprog"), |
| /// // "Hi {0xe9}!" |
| /// OsString::from_vec(vec![b'H', b'i', b' ', 0xe9, b'!'])]); |
| /// assert_eq!(&*m.value_of_lossy("arg").unwrap(), "Hi \u{FFFD}!"); |
| /// ``` |
| /// [`Arg::values_of_lossy`]: ./struct.ArgMatches.html#method.values_of_lossy |
| </span><span class="kw">pub fn </span>value_of_lossy<S: AsRef<str>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, name: S) -> <span class="prelude-ty">Option</span><Cow<<span class="lifetime">'a</span>, str>> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(arg) = <span class="self">self</span>.args.get(name.as_ref()) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = arg.vals.get(<span class="number">0</span>) { |
| <span class="kw">return </span><span class="prelude-val">Some</span>(v.to_string_lossy()); |
| } |
| } |
| <span class="prelude-val">None |
| </span>} |
| |
| <span class="doccomment">/// Gets the OS version of a string value of a specific argument. If the option wasn't present |
| /// at runtime it returns `None`. An OS value on Unix-like systems is any series of bytes, |
| /// regardless of whether or not they contain valid UTF-8 code points. Since [`String`]s in |
| /// Rust are guaranteed to be valid UTF-8, a valid filename on a Unix system as an argument |
| /// value may contain invalid UTF-8 code points. |
| /// |
| /// *NOTE:* If getting a value for an option or positional argument that allows multiples, |
| /// prefer [`ArgMatches::values_of_os`] as `Arg::value_of_os` will only return the *first* |
| /// value. |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(not(unix), doc = <span class="string">" ```ignore"</span>)] |
| #[cfg_attr(unix, doc = <span class="string">" ```"</span>)] |
| </span><span class="doccomment">/// # use clap::{App, Arg}; |
| /// use std::ffi::OsString; |
| /// use std::os::unix::ffi::{OsStrExt,OsStringExt}; |
| /// |
| /// let m = App::new("utf8") |
| /// .arg(Arg::from_usage("<arg> 'some arg'")) |
| /// .get_matches_from(vec![OsString::from("myprog"), |
| /// // "Hi {0xe9}!" |
| /// OsString::from_vec(vec![b'H', b'i', b' ', 0xe9, b'!'])]); |
| /// assert_eq!(&*m.value_of_os("arg").unwrap().as_bytes(), [b'H', b'i', b' ', 0xe9, b'!']); |
| /// ``` |
| /// [`String`]: https://doc.rust-lang.org/std/string/struct.String.html |
| /// [`ArgMatches::values_of_os`]: ./struct.ArgMatches.html#method.values_of_os |
| </span><span class="kw">pub fn </span>value_of_os<S: AsRef<str>>(<span class="kw-2">&</span><span class="self">self</span>, name: S) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>OsStr> { |
| <span class="self">self</span>.args |
| .get(name.as_ref()) |
| .and_then(|arg| arg.vals.get(<span class="number">0</span>).map(|v| v.as_os_str())) |
| } |
| |
| <span class="doccomment">/// Gets a [`Values`] struct which implements [`Iterator`] for values of a specific argument |
| /// (i.e. an argument that takes multiple values at runtime). If the option wasn't present at |
| /// runtime it returns `None` |
| /// |
| /// # Panics |
| /// |
| /// This method will panic if any of the values contain invalid UTF-8 code points. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myprog") |
| /// .arg(Arg::with_name("output") |
| /// .multiple(true) |
| /// .short("o") |
| /// .takes_value(true)) |
| /// .get_matches_from(vec![ |
| /// "myprog", "-o", "val1", "val2", "val3" |
| /// ]); |
| /// let vals: Vec<&str> = m.values_of("output").unwrap().collect(); |
| /// assert_eq!(vals, ["val1", "val2", "val3"]); |
| /// ``` |
| /// [`Values`]: ./struct.Values.html |
| /// [`Iterator`]: https://doc.rust-lang.org/std/iter/trait.Iterator.html |
| </span><span class="kw">pub fn </span>values_of<S: AsRef<str>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, name: S) -> <span class="prelude-ty">Option</span><Values<<span class="lifetime">'a</span>>> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(arg) = <span class="self">self</span>.args.get(name.as_ref()) { |
| <span class="kw">fn </span>to_str_slice(o: <span class="kw-2">&</span>OsString) -> <span class="kw-2">&</span>str { |
| o.to_str().expect(INVALID_UTF8) |
| } |
| <span class="kw">let </span>to_str_slice: <span class="kw">fn</span>(<span class="kw-2">&</span>OsString) -> <span class="kw-2">&</span>str = to_str_slice; <span class="comment">// coerce to fn pointer |
| </span><span class="kw">return </span><span class="prelude-val">Some</span>(Values { |
| iter: arg.vals.iter().map(to_str_slice), |
| }); |
| } |
| <span class="prelude-val">None |
| </span>} |
| |
| <span class="doccomment">/// Gets the lossy values of a specific argument. If the option wasn't present at runtime |
| /// it returns `None`. A lossy value is one where if it contains invalid UTF-8 code points, |
| /// those invalid points will be replaced with `\u{FFFD}` |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(not(unix), doc = <span class="string">" ```ignore"</span>)] |
| #[cfg_attr(unix, doc = <span class="string">" ```"</span>)] |
| </span><span class="doccomment">/// # use clap::{App, Arg}; |
| /// use std::ffi::OsString; |
| /// use std::os::unix::ffi::OsStringExt; |
| /// |
| /// let m = App::new("utf8") |
| /// .arg(Arg::from_usage("<arg>... 'some arg'")) |
| /// .get_matches_from(vec![OsString::from("myprog"), |
| /// // "Hi" |
| /// OsString::from_vec(vec![b'H', b'i']), |
| /// // "{0xe9}!" |
| /// OsString::from_vec(vec![0xe9, b'!'])]); |
| /// let mut itr = m.values_of_lossy("arg").unwrap().into_iter(); |
| /// assert_eq!(&itr.next().unwrap()[..], "Hi"); |
| /// assert_eq!(&itr.next().unwrap()[..], "\u{FFFD}!"); |
| /// assert_eq!(itr.next(), None); |
| /// ``` |
| </span><span class="kw">pub fn </span>values_of_lossy<S: AsRef<str>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, name: S) -> <span class="prelude-ty">Option</span><Vec<String>> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(arg) = <span class="self">self</span>.args.get(name.as_ref()) { |
| <span class="kw">return </span><span class="prelude-val">Some</span>( |
| arg.vals |
| .iter() |
| .map(|v| v.to_string_lossy().into_owned()) |
| .collect(), |
| ); |
| } |
| <span class="prelude-val">None |
| </span>} |
| |
| <span class="doccomment">/// Gets a [`OsValues`] struct which is implements [`Iterator`] for [`OsString`] values of a |
| /// specific argument. If the option wasn't present at runtime it returns `None`. An OS value |
| /// on Unix-like systems is any series of bytes, regardless of whether or not they contain |
| /// valid UTF-8 code points. Since [`String`]s in Rust are guaranteed to be valid UTF-8, a valid |
| /// filename as an argument value on Linux (for example) may contain invalid UTF-8 code points. |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(not(unix), doc = <span class="string">" ```ignore"</span>)] |
| #[cfg_attr(unix, doc = <span class="string">" ```"</span>)] |
| </span><span class="doccomment">/// # use clap::{App, Arg}; |
| /// use std::ffi::{OsStr,OsString}; |
| /// use std::os::unix::ffi::{OsStrExt,OsStringExt}; |
| /// |
| /// let m = App::new("utf8") |
| /// .arg(Arg::from_usage("<arg>... 'some arg'")) |
| /// .get_matches_from(vec![OsString::from("myprog"), |
| /// // "Hi" |
| /// OsString::from_vec(vec![b'H', b'i']), |
| /// // "{0xe9}!" |
| /// OsString::from_vec(vec![0xe9, b'!'])]); |
| /// |
| /// let mut itr = m.values_of_os("arg").unwrap().into_iter(); |
| /// assert_eq!(itr.next(), Some(OsStr::new("Hi"))); |
| /// assert_eq!(itr.next(), Some(OsStr::from_bytes(&[0xe9, b'!']))); |
| /// assert_eq!(itr.next(), None); |
| /// ``` |
| /// [`OsValues`]: ./struct.OsValues.html |
| /// [`Iterator`]: https://doc.rust-lang.org/std/iter/trait.Iterator.html |
| /// [`OsString`]: https://doc.rust-lang.org/std/ffi/struct.OsString.html |
| /// [`String`]: https://doc.rust-lang.org/std/string/struct.String.html |
| </span><span class="kw">pub fn </span>values_of_os<S: AsRef<str>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, name: S) -> <span class="prelude-ty">Option</span><OsValues<<span class="lifetime">'a</span>>> { |
| <span class="kw">fn </span>to_str_slice(o: <span class="kw-2">&</span>OsString) -> <span class="kw-2">&</span>OsStr { |
| <span class="kw-2">&*</span>o |
| } |
| <span class="kw">let </span>to_str_slice: <span class="kw">fn</span>(<span class="kw-2">&</span><span class="lifetime">'a </span>OsString) -> <span class="kw-2">&</span><span class="lifetime">'a </span>OsStr = to_str_slice; <span class="comment">// coerce to fn pointer |
| </span><span class="kw">if let </span><span class="prelude-val">Some</span>(arg) = <span class="self">self</span>.args.get(name.as_ref()) { |
| <span class="kw">return </span><span class="prelude-val">Some</span>(OsValues { |
| iter: arg.vals.iter().map(to_str_slice), |
| }); |
| } |
| <span class="prelude-val">None |
| </span>} |
| |
| <span class="doccomment">/// Returns `true` if an argument was present at runtime, otherwise `false`. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myprog") |
| /// .arg(Arg::with_name("debug") |
| /// .short("d")) |
| /// .get_matches_from(vec![ |
| /// "myprog", "-d" |
| /// ]); |
| /// |
| /// assert!(m.is_present("debug")); |
| /// ``` |
| </span><span class="kw">pub fn </span>is_present<S: AsRef<str>>(<span class="kw-2">&</span><span class="self">self</span>, name: S) -> bool { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>sc) = <span class="self">self</span>.subcommand { |
| <span class="kw">if </span>sc.name == name.as_ref() { |
| <span class="kw">return </span><span class="bool-val">true</span>; |
| } |
| } |
| <span class="self">self</span>.args.contains_key(name.as_ref()) |
| } |
| |
| <span class="doccomment">/// Returns the number of times an argument was used at runtime. If an argument isn't present |
| /// it will return `0`. |
| /// |
| /// **NOTE:** This returns the number of times the argument was used, *not* the number of |
| /// values. For example, `-o val1 val2 val3 -o val4` would return `2` (2 occurrences, but 4 |
| /// values). |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myprog") |
| /// .arg(Arg::with_name("debug") |
| /// .short("d") |
| /// .multiple(true)) |
| /// .get_matches_from(vec![ |
| /// "myprog", "-d", "-d", "-d" |
| /// ]); |
| /// |
| /// assert_eq!(m.occurrences_of("debug"), 3); |
| /// ``` |
| /// |
| /// This next example shows that counts actual uses of the argument, not just `-`'s |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myprog") |
| /// .arg(Arg::with_name("debug") |
| /// .short("d") |
| /// .multiple(true)) |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .get_matches_from(vec![ |
| /// "myprog", "-ddfd" |
| /// ]); |
| /// |
| /// assert_eq!(m.occurrences_of("debug"), 3); |
| /// assert_eq!(m.occurrences_of("flag"), 1); |
| /// ``` |
| </span><span class="kw">pub fn </span>occurrences_of<S: AsRef<str>>(<span class="kw-2">&</span><span class="self">self</span>, name: S) -> u64 { |
| <span class="self">self</span>.args.get(name.as_ref()).map_or(<span class="number">0</span>, |a| a.occurs) |
| } |
| |
| <span class="doccomment">/// Gets the starting index of the argument in respect to all other arguments. Indices are |
| /// similar to argv indices, but are not exactly 1:1. |
| /// |
| /// For flags (i.e. those arguments which don't have an associated value), indices refer |
| /// to occurrence of the switch, such as `-f`, or `--flag`. However, for options the indices |
| /// refer to the *values* `-o val` would therefore not represent two distinct indices, only the |
| /// index for `val` would be recorded. This is by design. |
| /// |
| /// Besides the flag/option descrepancy, the primary difference between an argv index and clap |
| /// index, is that clap continues counting once all arguments have properly seperated, whereas |
| /// an argv index does not. |
| /// |
| /// The examples should clear this up. |
| /// |
| /// *NOTE:* If an argument is allowed multiple times, this method will only give the *first* |
| /// index. |
| /// |
| /// # Examples |
| /// |
| /// The argv indices are listed in the comments below. See how they correspond to the clap |
| /// indices. Note that if it's not listed in a clap index, this is becuase it's not saved in |
| /// in an `ArgMatches` struct for querying. |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("option") |
| /// .short("o") |
| /// .takes_value(true)) |
| /// .get_matches_from(vec!["myapp", "-f", "-o", "val"]); |
| /// // ARGV idices: ^0 ^1 ^2 ^3 |
| /// // clap idices: ^1 ^3 |
| /// |
| /// assert_eq!(m.index_of("flag"), Some(1)); |
| /// assert_eq!(m.index_of("option"), Some(3)); |
| /// ``` |
| /// |
| /// Now notice, if we use one of the other styles of options: |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("option") |
| /// .short("o") |
| /// .takes_value(true)) |
| /// .get_matches_from(vec!["myapp", "-f", "-o=val"]); |
| /// // ARGV idices: ^0 ^1 ^2 |
| /// // clap idices: ^1 ^3 |
| /// |
| /// assert_eq!(m.index_of("flag"), Some(1)); |
| /// assert_eq!(m.index_of("option"), Some(3)); |
| /// ``` |
| /// |
| /// Things become much more complicated, or clear if we look at a more complex combination of |
| /// flags. Let's also throw in the final option style for good measure. |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("flag2") |
| /// .short("F")) |
| /// .arg(Arg::with_name("flag3") |
| /// .short("z")) |
| /// .arg(Arg::with_name("option") |
| /// .short("o") |
| /// .takes_value(true)) |
| /// .get_matches_from(vec!["myapp", "-fzF", "-oval"]); |
| /// // ARGV idices: ^0 ^1 ^2 |
| /// // clap idices: ^1,2,3 ^5 |
| /// // |
| /// // clap sees the above as 'myapp -f -z -F -o val' |
| /// // ^0 ^1 ^2 ^3 ^4 ^5 |
| /// assert_eq!(m.index_of("flag"), Some(1)); |
| /// assert_eq!(m.index_of("flag2"), Some(3)); |
| /// assert_eq!(m.index_of("flag3"), Some(2)); |
| /// assert_eq!(m.index_of("option"), Some(5)); |
| /// ``` |
| /// |
| /// One final combination of flags/options to see how they combine: |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("flag2") |
| /// .short("F")) |
| /// .arg(Arg::with_name("flag3") |
| /// .short("z")) |
| /// .arg(Arg::with_name("option") |
| /// .short("o") |
| /// .takes_value(true) |
| /// .multiple(true)) |
| /// .get_matches_from(vec!["myapp", "-fzFoval"]); |
| /// // ARGV idices: ^0 ^1 |
| /// // clap idices: ^1,2,3^5 |
| /// // |
| /// // clap sees the above as 'myapp -f -z -F -o val' |
| /// // ^0 ^1 ^2 ^3 ^4 ^5 |
| /// assert_eq!(m.index_of("flag"), Some(1)); |
| /// assert_eq!(m.index_of("flag2"), Some(3)); |
| /// assert_eq!(m.index_of("flag3"), Some(2)); |
| /// assert_eq!(m.index_of("option"), Some(5)); |
| /// ``` |
| /// |
| /// The last part to mention is when values are sent in multiple groups with a [delimiter]. |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("option") |
| /// .short("o") |
| /// .takes_value(true) |
| /// .multiple(true)) |
| /// .get_matches_from(vec!["myapp", "-o=val1,val2,val3"]); |
| /// // ARGV idices: ^0 ^1 |
| /// // clap idices: ^2 ^3 ^4 |
| /// // |
| /// // clap sees the above as 'myapp -o val1 val2 val3' |
| /// // ^0 ^1 ^2 ^3 ^4 |
| /// assert_eq!(m.index_of("option"), Some(2)); |
| /// ``` |
| /// [`ArgMatches`]: ./struct.ArgMatches.html |
| /// [delimiter]: ./struct.Arg.html#method.value_delimiter |
| </span><span class="kw">pub fn </span>index_of<S: AsRef<str>>(<span class="kw-2">&</span><span class="self">self</span>, name: S) -> <span class="prelude-ty">Option</span><usize> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(arg) = <span class="self">self</span>.args.get(name.as_ref()) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(i) = arg.indices.get(<span class="number">0</span>) { |
| <span class="kw">return </span><span class="prelude-val">Some</span>(<span class="kw-2">*</span>i); |
| } |
| } |
| <span class="prelude-val">None |
| </span>} |
| |
| <span class="doccomment">/// Gets all indices of the argument in respect to all other arguments. Indices are |
| /// similar to argv indices, but are not exactly 1:1. |
| /// |
| /// For flags (i.e. those arguments which don't have an associated value), indices refer |
| /// to occurrence of the switch, such as `-f`, or `--flag`. However, for options the indices |
| /// refer to the *values* `-o val` would therefore not represent two distinct indices, only the |
| /// index for `val` would be recorded. This is by design. |
| /// |
| /// *NOTE:* For more information about how clap indices compare to argv indices, see |
| /// [`ArgMatches::index_of`] |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("option") |
| /// .short("o") |
| /// .takes_value(true) |
| /// .use_delimiter(true) |
| /// .multiple(true)) |
| /// .get_matches_from(vec!["myapp", "-o=val1,val2,val3"]); |
| /// // ARGV idices: ^0 ^1 |
| /// // clap idices: ^2 ^3 ^4 |
| /// // |
| /// // clap sees the above as 'myapp -o val1 val2 val3' |
| /// // ^0 ^1 ^2 ^3 ^4 |
| /// assert_eq!(m.indices_of("option").unwrap().collect::<Vec<_>>(), &[2, 3, 4]); |
| /// ``` |
| /// |
| /// Another quick example is when flags and options are used together |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("option") |
| /// .short("o") |
| /// .takes_value(true) |
| /// .multiple(true)) |
| /// .arg(Arg::with_name("flag") |
| /// .short("f") |
| /// .multiple(true)) |
| /// .get_matches_from(vec!["myapp", "-o", "val1", "-f", "-o", "val2", "-f"]); |
| /// // ARGV idices: ^0 ^1 ^2 ^3 ^4 ^5 ^6 |
| /// // clap idices: ^2 ^3 ^5 ^6 |
| /// |
| /// assert_eq!(m.indices_of("option").unwrap().collect::<Vec<_>>(), &[2, 5]); |
| /// assert_eq!(m.indices_of("flag").unwrap().collect::<Vec<_>>(), &[3, 6]); |
| /// ``` |
| /// |
| /// One final example, which is an odd case; if we *don't* use value delimiter as we did with |
| /// the first example above instead of `val1`, `val2` and `val3` all being distinc values, they |
| /// would all be a single value of `val1,val2,val3`, in which case case they'd only receive a |
| /// single index. |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("option") |
| /// .short("o") |
| /// .takes_value(true) |
| /// .multiple(true)) |
| /// .get_matches_from(vec!["myapp", "-o=val1,val2,val3"]); |
| /// // ARGV idices: ^0 ^1 |
| /// // clap idices: ^2 |
| /// // |
| /// // clap sees the above as 'myapp -o "val1,val2,val3"' |
| /// // ^0 ^1 ^2 |
| /// assert_eq!(m.indices_of("option").unwrap().collect::<Vec<_>>(), &[2]); |
| /// ``` |
| /// [`ArgMatches`]: ./struct.ArgMatches.html |
| /// [`ArgMatches::index_of`]: ./struct.ArgMatches.html#method.index_of |
| /// [delimiter]: ./struct.Arg.html#method.value_delimiter |
| </span><span class="kw">pub fn </span>indices_of<S: AsRef<str>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>, name: S) -> <span class="prelude-ty">Option</span><Indices<<span class="lifetime">'a</span>>> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(arg) = <span class="self">self</span>.args.get(name.as_ref()) { |
| <span class="kw">fn </span>to_usize(i: <span class="kw-2">&</span>usize) -> usize { |
| <span class="kw-2">*</span>i |
| } |
| <span class="kw">let </span>to_usize: <span class="kw">fn</span>(<span class="kw-2">&</span>usize) -> usize = to_usize; <span class="comment">// coerce to fn pointer |
| </span><span class="kw">return </span><span class="prelude-val">Some</span>(Indices { |
| iter: arg.indices.iter().map(to_usize), |
| }); |
| } |
| <span class="prelude-val">None |
| </span>} |
| |
| <span class="doccomment">/// Because [`Subcommand`]s are essentially "sub-[`App`]s" they have their own [`ArgMatches`] |
| /// as well. This method returns the [`ArgMatches`] for a particular subcommand or `None` if |
| /// the subcommand wasn't present at runtime. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, SubCommand}; |
| /// let app_m = App::new("myprog") |
| /// .arg(Arg::with_name("debug") |
| /// .short("d")) |
| /// .subcommand(SubCommand::with_name("test") |
| /// .arg(Arg::with_name("opt") |
| /// .long("option") |
| /// .takes_value(true))) |
| /// .get_matches_from(vec![ |
| /// "myprog", "-d", "test", "--option", "val" |
| /// ]); |
| /// |
| /// // Both parent commands, and child subcommands can have arguments present at the same times |
| /// assert!(app_m.is_present("debug")); |
| /// |
| /// // Get the subcommand's ArgMatches instance |
| /// if let Some(sub_m) = app_m.subcommand_matches("test") { |
| /// // Use the struct like normal |
| /// assert_eq!(sub_m.value_of("opt"), Some("val")); |
| /// } |
| /// ``` |
| /// [`Subcommand`]: ./struct.SubCommand.html |
| /// [`App`]: ./struct.App.html |
| /// [`ArgMatches`]: ./struct.ArgMatches.html |
| </span><span class="kw">pub fn </span>subcommand_matches<S: AsRef<str>>(<span class="kw-2">&</span><span class="self">self</span>, name: S) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>ArgMatches<<span class="lifetime">'a</span>>> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>s) = <span class="self">self</span>.subcommand { |
| <span class="kw">if </span>s.name == name.as_ref() { |
| <span class="kw">return </span><span class="prelude-val">Some</span>(<span class="kw-2">&</span>s.matches); |
| } |
| } |
| <span class="prelude-val">None |
| </span>} |
| |
| <span class="doccomment">/// Because [`Subcommand`]s are essentially "sub-[`App`]s" they have their own [`ArgMatches`] |
| /// as well.But simply getting the sub-[`ArgMatches`] doesn't help much if we don't also know |
| /// which subcommand was actually used. This method returns the name of the subcommand that was |
| /// used at runtime, or `None` if one wasn't. |
| /// |
| /// *NOTE*: Subcommands form a hierarchy, where multiple subcommands can be used at runtime, |
| /// but only a single subcommand from any group of sibling commands may used at once. |
| /// |
| /// An ASCII art depiction may help explain this better...Using a fictional version of `git` as |
| /// the demo subject. Imagine the following are all subcommands of `git` (note, the author is |
| /// aware these aren't actually all subcommands in the real `git` interface, but it makes |
| /// explanation easier) |
| /// |
| /// ```notrust |
| /// Top Level App (git) TOP |
| /// | |
| /// ----------------------------------------- |
| /// / | \ \ |
| /// clone push add commit LEVEL 1 |
| /// | / \ / \ | |
| /// url origin remote ref name message LEVEL 2 |
| /// / /\ |
| /// path remote local LEVEL 3 |
| /// ``` |
| /// |
| /// Given the above fictional subcommand hierarchy, valid runtime uses would be (not an all |
| /// inclusive list, and not including argument options per command for brevity and clarity): |
| /// |
| /// ```sh |
| /// $ git clone url |
| /// $ git push origin path |
| /// $ git add ref local |
| /// $ git commit message |
| /// ``` |
| /// |
| /// Notice only one command per "level" may be used. You could not, for example, do `$ git |
| /// clone url push origin path` |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, SubCommand}; |
| /// let app_m = App::new("git") |
| /// .subcommand(SubCommand::with_name("clone")) |
| /// .subcommand(SubCommand::with_name("push")) |
| /// .subcommand(SubCommand::with_name("commit")) |
| /// .get_matches(); |
| /// |
| /// match app_m.subcommand_name() { |
| /// Some("clone") => {}, // clone was used |
| /// Some("push") => {}, // push was used |
| /// Some("commit") => {}, // commit was used |
| /// _ => {}, // Either no subcommand or one not tested for... |
| /// } |
| /// ``` |
| /// [`Subcommand`]: ./struct.SubCommand.html |
| /// [`App`]: ./struct.App.html |
| /// [`ArgMatches`]: ./struct.ArgMatches.html |
| </span><span class="kw">pub fn </span>subcommand_name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str> { |
| <span class="self">self</span>.subcommand.as_ref().map(|sc| <span class="kw-2">&</span>sc.name[..]) |
| } |
| |
| <span class="doccomment">/// This brings together [`ArgMatches::subcommand_matches`] and [`ArgMatches::subcommand_name`] |
| /// by returning a tuple with both pieces of information. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, SubCommand}; |
| /// let app_m = App::new("git") |
| /// .subcommand(SubCommand::with_name("clone")) |
| /// .subcommand(SubCommand::with_name("push")) |
| /// .subcommand(SubCommand::with_name("commit")) |
| /// .get_matches(); |
| /// |
| /// match app_m.subcommand() { |
| /// ("clone", Some(sub_m)) => {}, // clone was used |
| /// ("push", Some(sub_m)) => {}, // push was used |
| /// ("commit", Some(sub_m)) => {}, // commit was used |
| /// _ => {}, // Either no subcommand or one not tested for... |
| /// } |
| /// ``` |
| /// |
| /// Another useful scenario is when you want to support third party, or external, subcommands. |
| /// In these cases you can't know the subcommand name ahead of time, so use a variable instead |
| /// with pattern matching! |
| /// |
| /// ```rust |
| /// # use clap::{App, AppSettings}; |
| /// // Assume there is an external subcommand named "subcmd" |
| /// let app_m = App::new("myprog") |
| /// .setting(AppSettings::AllowExternalSubcommands) |
| /// .get_matches_from(vec![ |
| /// "myprog", "subcmd", "--option", "value", "-fff", "--flag" |
| /// ]); |
| /// |
| /// // All trailing arguments will be stored under the subcommand's sub-matches using an empty |
| /// // string argument name |
| /// match app_m.subcommand() { |
| /// (external, Some(sub_m)) => { |
| /// let ext_args: Vec<&str> = sub_m.values_of("").unwrap().collect(); |
| /// assert_eq!(external, "subcmd"); |
| /// assert_eq!(ext_args, ["--option", "value", "-fff", "--flag"]); |
| /// }, |
| /// _ => {}, |
| /// } |
| /// ``` |
| /// [`ArgMatches::subcommand_matches`]: ./struct.ArgMatches.html#method.subcommand_matches |
| /// [`ArgMatches::subcommand_name`]: ./struct.ArgMatches.html#method.subcommand_name |
| </span><span class="kw">pub fn </span>subcommand(<span class="kw-2">&</span><span class="self">self</span>) -> (<span class="kw-2">&</span>str, <span class="prelude-ty">Option</span><<span class="kw-2">&</span>ArgMatches<<span class="lifetime">'a</span>>>) { |
| <span class="self">self</span>.subcommand |
| .as_ref() |
| .map_or((<span class="string">""</span>, <span class="prelude-val">None</span>), |sc| (<span class="kw-2">&</span>sc.name[..], <span class="prelude-val">Some</span>(<span class="kw-2">&</span>sc.matches))) |
| } |
| |
| <span class="doccomment">/// Returns a string slice of the usage statement for the [`App`] or [`SubCommand`] |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, SubCommand}; |
| /// let app_m = App::new("myprog") |
| /// .subcommand(SubCommand::with_name("test")) |
| /// .get_matches(); |
| /// |
| /// println!("{}", app_m.usage()); |
| /// ``` |
| /// [`Subcommand`]: ./struct.SubCommand.html |
| /// [`App`]: ./struct.App.html |
| </span><span class="kw">pub fn </span>usage(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <span class="self">self</span>.usage.as_ref().map_or(<span class="string">""</span>, |u| <span class="kw-2">&</span>u[..]) |
| } |
| } |
| |
| <span class="comment">// The following were taken and adapated from vec_map source |
| // repo: https://github.com/contain-rs/vec-map |
| // commit: be5e1fa3c26e351761b33010ddbdaf5f05dbcc33 |
| // license: MIT - Copyright (c) 2015 The Rust Project Developers |
| |
| </span><span class="doccomment">/// An iterator for getting multiple values out of an argument via the [`ArgMatches::values_of`] |
| /// method. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("output") |
| /// .short("o") |
| /// .multiple(true) |
| /// .takes_value(true)) |
| /// .get_matches_from(vec!["myapp", "-o", "val1", "val2"]); |
| /// |
| /// let mut values = m.values_of("output").unwrap(); |
| /// |
| /// assert_eq!(values.next(), Some("val1")); |
| /// assert_eq!(values.next(), Some("val2")); |
| /// assert_eq!(values.next(), None); |
| /// ``` |
| /// [`ArgMatches::values_of`]: ./struct.ArgMatches.html#method.values_of |
| </span><span class="attribute">#[derive(Debug, Clone)] |
| </span><span class="kw">pub struct </span>Values<<span class="lifetime">'a</span>> { |
| iter: Map<Iter<<span class="lifetime">'a</span>, OsString>, <span class="kw">fn</span>(<span class="kw-2">&</span><span class="lifetime">'a </span>OsString) -> <span class="kw-2">&</span><span class="lifetime">'a </span>str>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Iterator <span class="kw">for </span>Values<<span class="lifetime">'a</span>> { |
| <span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'a </span>str; |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>str> { |
| <span class="self">self</span>.iter.next() |
| } |
| <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) { |
| <span class="self">self</span>.iter.size_hint() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> DoubleEndedIterator <span class="kw">for </span>Values<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>next_back(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>str> { |
| <span class="self">self</span>.iter.next_back() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> ExactSizeIterator <span class="kw">for </span>Values<<span class="lifetime">'a</span>> {} |
| |
| <span class="doccomment">/// Creates an empty iterator. |
| </span><span class="kw">impl</span><<span class="lifetime">'a</span>> Default <span class="kw">for </span>Values<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="kw">static </span>EMPTY: [OsString; <span class="number">0</span>] = []; |
| <span class="comment">// This is never called because the iterator is empty: |
| </span><span class="kw">fn </span>to_str_slice(<span class="kw">_</span>: <span class="kw-2">&</span>OsString) -> <span class="kw-2">&</span>str { |
| <span class="macro">unreachable!</span>() |
| } |
| Values { |
| iter: EMPTY[..].iter().map(to_str_slice), |
| } |
| } |
| } |
| |
| <span class="doccomment">/// An iterator for getting multiple values out of an argument via the [`ArgMatches::values_of_os`] |
| /// method. Usage of this iterator allows values which contain invalid UTF-8 code points unlike |
| /// [`Values`]. |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(not(unix), doc = <span class="string">" ```ignore"</span>)] |
| #[cfg_attr(unix, doc = <span class="string">" ```"</span>)] |
| </span><span class="doccomment">/// # use clap::{App, Arg}; |
| /// use std::ffi::OsString; |
| /// use std::os::unix::ffi::{OsStrExt,OsStringExt}; |
| /// |
| /// let m = App::new("utf8") |
| /// .arg(Arg::from_usage("<arg> 'some arg'")) |
| /// .get_matches_from(vec![OsString::from("myprog"), |
| /// // "Hi {0xe9}!" |
| /// OsString::from_vec(vec![b'H', b'i', b' ', 0xe9, b'!'])]); |
| /// assert_eq!(&*m.value_of_os("arg").unwrap().as_bytes(), [b'H', b'i', b' ', 0xe9, b'!']); |
| /// ``` |
| /// [`ArgMatches::values_of_os`]: ./struct.ArgMatches.html#method.values_of_os |
| /// [`Values`]: ./struct.Values.html |
| </span><span class="attribute">#[derive(Debug, Clone)] |
| </span><span class="kw">pub struct </span>OsValues<<span class="lifetime">'a</span>> { |
| iter: Map<Iter<<span class="lifetime">'a</span>, OsString>, <span class="kw">fn</span>(<span class="kw-2">&</span><span class="lifetime">'a </span>OsString) -> <span class="kw-2">&</span><span class="lifetime">'a </span>OsStr>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Iterator <span class="kw">for </span>OsValues<<span class="lifetime">'a</span>> { |
| <span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'a </span>OsStr; |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>OsStr> { |
| <span class="self">self</span>.iter.next() |
| } |
| <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) { |
| <span class="self">self</span>.iter.size_hint() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> DoubleEndedIterator <span class="kw">for </span>OsValues<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>next_back(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>OsStr> { |
| <span class="self">self</span>.iter.next_back() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> ExactSizeIterator <span class="kw">for </span>OsValues<<span class="lifetime">'a</span>> {} |
| |
| <span class="doccomment">/// Creates an empty iterator. |
| </span><span class="kw">impl</span><<span class="lifetime">'a</span>> Default <span class="kw">for </span>OsValues<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="kw">static </span>EMPTY: [OsString; <span class="number">0</span>] = []; |
| <span class="comment">// This is never called because the iterator is empty: |
| </span><span class="kw">fn </span>to_str_slice(<span class="kw">_</span>: <span class="kw-2">&</span>OsString) -> <span class="kw-2">&</span>OsStr { |
| <span class="macro">unreachable!</span>() |
| } |
| OsValues { |
| iter: EMPTY[..].iter().map(to_str_slice), |
| } |
| } |
| } |
| |
| <span class="doccomment">/// An iterator for getting multiple indices out of an argument via the [`ArgMatches::indices_of`] |
| /// method. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("myapp") |
| /// .arg(Arg::with_name("output") |
| /// .short("o") |
| /// .multiple(true) |
| /// .takes_value(true)) |
| /// .get_matches_from(vec!["myapp", "-o", "val1", "val2"]); |
| /// |
| /// let mut indices = m.indices_of("output").unwrap(); |
| /// |
| /// assert_eq!(indices.next(), Some(2)); |
| /// assert_eq!(indices.next(), Some(3)); |
| /// assert_eq!(indices.next(), None); |
| /// ``` |
| /// [`ArgMatches::indices_of`]: ./struct.ArgMatches.html#method.indices_of |
| </span><span class="attribute">#[derive(Debug, Clone)] |
| </span><span class="kw">pub struct </span>Indices<<span class="lifetime">'a</span>> { |
| <span class="comment">// would rather use '_, but: https://github.com/rust-lang/rust/issues/48469 |
| </span>iter: Map<Iter<<span class="lifetime">'a</span>, usize>, <span class="kw">fn</span>(<span class="kw-2">&</span><span class="lifetime">'a </span>usize) -> usize>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Iterator <span class="kw">for </span>Indices<<span class="lifetime">'a</span>> { |
| <span class="kw">type </span>Item = usize; |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><usize> { |
| <span class="self">self</span>.iter.next() |
| } |
| <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) { |
| <span class="self">self</span>.iter.size_hint() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> DoubleEndedIterator <span class="kw">for </span>Indices<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>next_back(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><usize> { |
| <span class="self">self</span>.iter.next_back() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> ExactSizeIterator <span class="kw">for </span>Indices<<span class="lifetime">'a</span>> {} |
| |
| <span class="doccomment">/// Creates an empty iterator. |
| </span><span class="kw">impl</span><<span class="lifetime">'a</span>> Default <span class="kw">for </span>Indices<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="kw">static </span>EMPTY: [usize; <span class="number">0</span>] = []; |
| <span class="comment">// This is never called because the iterator is empty: |
| </span><span class="kw">fn </span>to_usize(<span class="kw">_</span>: <span class="kw-2">&</span>usize) -> usize { |
| <span class="macro">unreachable!</span>() |
| } |
| Indices { |
| iter: EMPTY[..].iter().map(to_usize), |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_default_values() { |
| <span class="kw">let </span><span class="kw-2">mut </span>values: Values = Values::default(); |
| <span class="macro">assert_eq!</span>(values.next(), <span class="prelude-val">None</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_default_values_with_shorter_lifetime() { |
| <span class="kw">let </span>matches = ArgMatches::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>values = matches.values_of(<span class="string">""</span>).unwrap_or_default(); |
| <span class="macro">assert_eq!</span>(values.next(), <span class="prelude-val">None</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_default_osvalues() { |
| <span class="kw">let </span><span class="kw-2">mut </span>values: OsValues = OsValues::default(); |
| <span class="macro">assert_eq!</span>(values.next(), <span class="prelude-val">None</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_default_osvalues_with_shorter_lifetime() { |
| <span class="kw">let </span>matches = ArgMatches::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>values = matches.values_of_os(<span class="string">""</span>).unwrap_or_default(); |
| <span class="macro">assert_eq!</span>(values.next(), <span class="prelude-val">None</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_default_indices() { |
| <span class="kw">let </span><span class="kw-2">mut </span>indices: Indices = Indices::default(); |
| <span class="macro">assert_eq!</span>(indices.next(), <span class="prelude-val">None</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_default_indices_with_shorter_lifetime() { |
| <span class="kw">let </span>matches = ArgMatches::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>indices = matches.indices_of(<span class="string">""</span>).unwrap_or_default(); |
| <span class="macro">assert_eq!</span>(indices.next(), <span class="prelude-val">None</span>); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |