| <!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/app/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../clap/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <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> |
| <span id="1002">1002</span> |
| <span id="1003">1003</span> |
| <span id="1004">1004</span> |
| <span id="1005">1005</span> |
| <span id="1006">1006</span> |
| <span id="1007">1007</span> |
| <span id="1008">1008</span> |
| <span id="1009">1009</span> |
| <span id="1010">1010</span> |
| <span id="1011">1011</span> |
| <span id="1012">1012</span> |
| <span id="1013">1013</span> |
| <span id="1014">1014</span> |
| <span id="1015">1015</span> |
| <span id="1016">1016</span> |
| <span id="1017">1017</span> |
| <span id="1018">1018</span> |
| <span id="1019">1019</span> |
| <span id="1020">1020</span> |
| <span id="1021">1021</span> |
| <span id="1022">1022</span> |
| <span id="1023">1023</span> |
| <span id="1024">1024</span> |
| <span id="1025">1025</span> |
| <span id="1026">1026</span> |
| <span id="1027">1027</span> |
| <span id="1028">1028</span> |
| <span id="1029">1029</span> |
| <span id="1030">1030</span> |
| <span id="1031">1031</span> |
| <span id="1032">1032</span> |
| <span id="1033">1033</span> |
| <span id="1034">1034</span> |
| <span id="1035">1035</span> |
| <span id="1036">1036</span> |
| <span id="1037">1037</span> |
| <span id="1038">1038</span> |
| <span id="1039">1039</span> |
| <span id="1040">1040</span> |
| <span id="1041">1041</span> |
| <span id="1042">1042</span> |
| <span id="1043">1043</span> |
| <span id="1044">1044</span> |
| <span id="1045">1045</span> |
| <span id="1046">1046</span> |
| <span id="1047">1047</span> |
| <span id="1048">1048</span> |
| <span id="1049">1049</span> |
| <span id="1050">1050</span> |
| <span id="1051">1051</span> |
| <span id="1052">1052</span> |
| <span id="1053">1053</span> |
| <span id="1054">1054</span> |
| <span id="1055">1055</span> |
| <span id="1056">1056</span> |
| <span id="1057">1057</span> |
| <span id="1058">1058</span> |
| <span id="1059">1059</span> |
| <span id="1060">1060</span> |
| <span id="1061">1061</span> |
| <span id="1062">1062</span> |
| <span id="1063">1063</span> |
| <span id="1064">1064</span> |
| <span id="1065">1065</span> |
| <span id="1066">1066</span> |
| <span id="1067">1067</span> |
| <span id="1068">1068</span> |
| <span id="1069">1069</span> |
| <span id="1070">1070</span> |
| <span id="1071">1071</span> |
| <span id="1072">1072</span> |
| <span id="1073">1073</span> |
| <span id="1074">1074</span> |
| <span id="1075">1075</span> |
| <span id="1076">1076</span> |
| <span id="1077">1077</span> |
| <span id="1078">1078</span> |
| <span id="1079">1079</span> |
| <span id="1080">1080</span> |
| <span id="1081">1081</span> |
| <span id="1082">1082</span> |
| <span id="1083">1083</span> |
| <span id="1084">1084</span> |
| <span id="1085">1085</span> |
| <span id="1086">1086</span> |
| <span id="1087">1087</span> |
| <span id="1088">1088</span> |
| <span id="1089">1089</span> |
| <span id="1090">1090</span> |
| <span id="1091">1091</span> |
| <span id="1092">1092</span> |
| <span id="1093">1093</span> |
| <span id="1094">1094</span> |
| <span id="1095">1095</span> |
| <span id="1096">1096</span> |
| <span id="1097">1097</span> |
| <span id="1098">1098</span> |
| <span id="1099">1099</span> |
| <span id="1100">1100</span> |
| <span id="1101">1101</span> |
| <span id="1102">1102</span> |
| <span id="1103">1103</span> |
| <span id="1104">1104</span> |
| <span id="1105">1105</span> |
| <span id="1106">1106</span> |
| <span id="1107">1107</span> |
| <span id="1108">1108</span> |
| <span id="1109">1109</span> |
| <span id="1110">1110</span> |
| <span id="1111">1111</span> |
| <span id="1112">1112</span> |
| <span id="1113">1113</span> |
| <span id="1114">1114</span> |
| <span id="1115">1115</span> |
| <span id="1116">1116</span> |
| <span id="1117">1117</span> |
| <span id="1118">1118</span> |
| <span id="1119">1119</span> |
| <span id="1120">1120</span> |
| <span id="1121">1121</span> |
| <span id="1122">1122</span> |
| <span id="1123">1123</span> |
| <span id="1124">1124</span> |
| <span id="1125">1125</span> |
| <span id="1126">1126</span> |
| <span id="1127">1127</span> |
| <span id="1128">1128</span> |
| <span id="1129">1129</span> |
| <span id="1130">1130</span> |
| <span id="1131">1131</span> |
| <span id="1132">1132</span> |
| <span id="1133">1133</span> |
| <span id="1134">1134</span> |
| <span id="1135">1135</span> |
| <span id="1136">1136</span> |
| <span id="1137">1137</span> |
| <span id="1138">1138</span> |
| <span id="1139">1139</span> |
| <span id="1140">1140</span> |
| <span id="1141">1141</span> |
| <span id="1142">1142</span> |
| <span id="1143">1143</span> |
| <span id="1144">1144</span> |
| <span id="1145">1145</span> |
| <span id="1146">1146</span> |
| <span id="1147">1147</span> |
| <span id="1148">1148</span> |
| <span id="1149">1149</span> |
| <span id="1150">1150</span> |
| <span id="1151">1151</span> |
| <span id="1152">1152</span> |
| <span id="1153">1153</span> |
| <span id="1154">1154</span> |
| <span id="1155">1155</span> |
| <span id="1156">1156</span> |
| <span id="1157">1157</span> |
| <span id="1158">1158</span> |
| <span id="1159">1159</span> |
| <span id="1160">1160</span> |
| <span id="1161">1161</span> |
| <span id="1162">1162</span> |
| <span id="1163">1163</span> |
| <span id="1164">1164</span> |
| <span id="1165">1165</span> |
| <span id="1166">1166</span> |
| <span id="1167">1167</span> |
| <span id="1168">1168</span> |
| <span id="1169">1169</span> |
| <span id="1170">1170</span> |
| <span id="1171">1171</span> |
| <span id="1172">1172</span> |
| <span id="1173">1173</span> |
| <span id="1174">1174</span> |
| <span id="1175">1175</span> |
| <span id="1176">1176</span> |
| <span id="1177">1177</span> |
| <span id="1178">1178</span> |
| <span id="1179">1179</span> |
| <span id="1180">1180</span> |
| <span id="1181">1181</span> |
| <span id="1182">1182</span> |
| <span id="1183">1183</span> |
| <span id="1184">1184</span> |
| <span id="1185">1185</span> |
| <span id="1186">1186</span> |
| <span id="1187">1187</span> |
| <span id="1188">1188</span> |
| <span id="1189">1189</span> |
| <span id="1190">1190</span> |
| <span id="1191">1191</span> |
| <span id="1192">1192</span> |
| <span id="1193">1193</span> |
| <span id="1194">1194</span> |
| <span id="1195">1195</span> |
| <span id="1196">1196</span> |
| <span id="1197">1197</span> |
| <span id="1198">1198</span> |
| <span id="1199">1199</span> |
| <span id="1200">1200</span> |
| <span id="1201">1201</span> |
| <span id="1202">1202</span> |
| <span id="1203">1203</span> |
| <span id="1204">1204</span> |
| <span id="1205">1205</span> |
| <span id="1206">1206</span> |
| <span id="1207">1207</span> |
| <span id="1208">1208</span> |
| <span id="1209">1209</span> |
| <span id="1210">1210</span> |
| <span id="1211">1211</span> |
| <span id="1212">1212</span> |
| <span id="1213">1213</span> |
| <span id="1214">1214</span> |
| <span id="1215">1215</span> |
| <span id="1216">1216</span> |
| <span id="1217">1217</span> |
| <span id="1218">1218</span> |
| <span id="1219">1219</span> |
| <span id="1220">1220</span> |
| <span id="1221">1221</span> |
| <span id="1222">1222</span> |
| <span id="1223">1223</span> |
| <span id="1224">1224</span> |
| <span id="1225">1225</span> |
| <span id="1226">1226</span> |
| <span id="1227">1227</span> |
| <span id="1228">1228</span> |
| <span id="1229">1229</span> |
| <span id="1230">1230</span> |
| <span id="1231">1231</span> |
| <span id="1232">1232</span> |
| <span id="1233">1233</span> |
| <span id="1234">1234</span> |
| <span id="1235">1235</span> |
| <span id="1236">1236</span> |
| <span id="1237">1237</span> |
| <span id="1238">1238</span> |
| <span id="1239">1239</span> |
| <span id="1240">1240</span> |
| <span id="1241">1241</span> |
| <span id="1242">1242</span> |
| <span id="1243">1243</span> |
| <span id="1244">1244</span> |
| <span id="1245">1245</span> |
| <span id="1246">1246</span> |
| <span id="1247">1247</span> |
| <span id="1248">1248</span> |
| <span id="1249">1249</span> |
| <span id="1250">1250</span> |
| <span id="1251">1251</span> |
| <span id="1252">1252</span> |
| <span id="1253">1253</span> |
| <span id="1254">1254</span> |
| <span id="1255">1255</span> |
| <span id="1256">1256</span> |
| <span id="1257">1257</span> |
| <span id="1258">1258</span> |
| <span id="1259">1259</span> |
| <span id="1260">1260</span> |
| <span id="1261">1261</span> |
| <span id="1262">1262</span> |
| <span id="1263">1263</span> |
| <span id="1264">1264</span> |
| <span id="1265">1265</span> |
| <span id="1266">1266</span> |
| <span id="1267">1267</span> |
| <span id="1268">1268</span> |
| <span id="1269">1269</span> |
| <span id="1270">1270</span> |
| <span id="1271">1271</span> |
| <span id="1272">1272</span> |
| <span id="1273">1273</span> |
| <span id="1274">1274</span> |
| <span id="1275">1275</span> |
| <span id="1276">1276</span> |
| <span id="1277">1277</span> |
| <span id="1278">1278</span> |
| <span id="1279">1279</span> |
| <span id="1280">1280</span> |
| <span id="1281">1281</span> |
| <span id="1282">1282</span> |
| <span id="1283">1283</span> |
| <span id="1284">1284</span> |
| <span id="1285">1285</span> |
| <span id="1286">1286</span> |
| <span id="1287">1287</span> |
| <span id="1288">1288</span> |
| <span id="1289">1289</span> |
| <span id="1290">1290</span> |
| <span id="1291">1291</span> |
| <span id="1292">1292</span> |
| <span id="1293">1293</span> |
| <span id="1294">1294</span> |
| <span id="1295">1295</span> |
| <span id="1296">1296</span> |
| <span id="1297">1297</span> |
| <span id="1298">1298</span> |
| <span id="1299">1299</span> |
| <span id="1300">1300</span> |
| <span id="1301">1301</span> |
| <span id="1302">1302</span> |
| <span id="1303">1303</span> |
| <span id="1304">1304</span> |
| <span id="1305">1305</span> |
| <span id="1306">1306</span> |
| <span id="1307">1307</span> |
| <span id="1308">1308</span> |
| <span id="1309">1309</span> |
| <span id="1310">1310</span> |
| <span id="1311">1311</span> |
| <span id="1312">1312</span> |
| <span id="1313">1313</span> |
| <span id="1314">1314</span> |
| <span id="1315">1315</span> |
| <span id="1316">1316</span> |
| <span id="1317">1317</span> |
| <span id="1318">1318</span> |
| <span id="1319">1319</span> |
| <span id="1320">1320</span> |
| <span id="1321">1321</span> |
| <span id="1322">1322</span> |
| <span id="1323">1323</span> |
| <span id="1324">1324</span> |
| <span id="1325">1325</span> |
| <span id="1326">1326</span> |
| <span id="1327">1327</span> |
| <span id="1328">1328</span> |
| <span id="1329">1329</span> |
| <span id="1330">1330</span> |
| <span id="1331">1331</span> |
| <span id="1332">1332</span> |
| <span id="1333">1333</span> |
| <span id="1334">1334</span> |
| <span id="1335">1335</span> |
| <span id="1336">1336</span> |
| <span id="1337">1337</span> |
| <span id="1338">1338</span> |
| <span id="1339">1339</span> |
| <span id="1340">1340</span> |
| <span id="1341">1341</span> |
| <span id="1342">1342</span> |
| <span id="1343">1343</span> |
| <span id="1344">1344</span> |
| <span id="1345">1345</span> |
| <span id="1346">1346</span> |
| <span id="1347">1347</span> |
| <span id="1348">1348</span> |
| <span id="1349">1349</span> |
| <span id="1350">1350</span> |
| <span id="1351">1351</span> |
| <span id="1352">1352</span> |
| <span id="1353">1353</span> |
| <span id="1354">1354</span> |
| <span id="1355">1355</span> |
| <span id="1356">1356</span> |
| <span id="1357">1357</span> |
| <span id="1358">1358</span> |
| <span id="1359">1359</span> |
| <span id="1360">1360</span> |
| <span id="1361">1361</span> |
| <span id="1362">1362</span> |
| <span id="1363">1363</span> |
| <span id="1364">1364</span> |
| <span id="1365">1365</span> |
| <span id="1366">1366</span> |
| <span id="1367">1367</span> |
| <span id="1368">1368</span> |
| <span id="1369">1369</span> |
| <span id="1370">1370</span> |
| <span id="1371">1371</span> |
| <span id="1372">1372</span> |
| <span id="1373">1373</span> |
| <span id="1374">1374</span> |
| <span id="1375">1375</span> |
| <span id="1376">1376</span> |
| <span id="1377">1377</span> |
| <span id="1378">1378</span> |
| <span id="1379">1379</span> |
| <span id="1380">1380</span> |
| <span id="1381">1381</span> |
| <span id="1382">1382</span> |
| <span id="1383">1383</span> |
| <span id="1384">1384</span> |
| <span id="1385">1385</span> |
| <span id="1386">1386</span> |
| <span id="1387">1387</span> |
| <span id="1388">1388</span> |
| <span id="1389">1389</span> |
| <span id="1390">1390</span> |
| <span id="1391">1391</span> |
| <span id="1392">1392</span> |
| <span id="1393">1393</span> |
| <span id="1394">1394</span> |
| <span id="1395">1395</span> |
| <span id="1396">1396</span> |
| <span id="1397">1397</span> |
| <span id="1398">1398</span> |
| <span id="1399">1399</span> |
| <span id="1400">1400</span> |
| <span id="1401">1401</span> |
| <span id="1402">1402</span> |
| <span id="1403">1403</span> |
| <span id="1404">1404</span> |
| <span id="1405">1405</span> |
| <span id="1406">1406</span> |
| <span id="1407">1407</span> |
| <span id="1408">1408</span> |
| <span id="1409">1409</span> |
| <span id="1410">1410</span> |
| <span id="1411">1411</span> |
| <span id="1412">1412</span> |
| <span id="1413">1413</span> |
| <span id="1414">1414</span> |
| <span id="1415">1415</span> |
| <span id="1416">1416</span> |
| <span id="1417">1417</span> |
| <span id="1418">1418</span> |
| <span id="1419">1419</span> |
| <span id="1420">1420</span> |
| <span id="1421">1421</span> |
| <span id="1422">1422</span> |
| <span id="1423">1423</span> |
| <span id="1424">1424</span> |
| <span id="1425">1425</span> |
| <span id="1426">1426</span> |
| <span id="1427">1427</span> |
| <span id="1428">1428</span> |
| <span id="1429">1429</span> |
| <span id="1430">1430</span> |
| <span id="1431">1431</span> |
| <span id="1432">1432</span> |
| <span id="1433">1433</span> |
| <span id="1434">1434</span> |
| <span id="1435">1435</span> |
| <span id="1436">1436</span> |
| <span id="1437">1437</span> |
| <span id="1438">1438</span> |
| <span id="1439">1439</span> |
| <span id="1440">1440</span> |
| <span id="1441">1441</span> |
| <span id="1442">1442</span> |
| <span id="1443">1443</span> |
| <span id="1444">1444</span> |
| <span id="1445">1445</span> |
| <span id="1446">1446</span> |
| <span id="1447">1447</span> |
| <span id="1448">1448</span> |
| <span id="1449">1449</span> |
| <span id="1450">1450</span> |
| <span id="1451">1451</span> |
| <span id="1452">1452</span> |
| <span id="1453">1453</span> |
| <span id="1454">1454</span> |
| <span id="1455">1455</span> |
| <span id="1456">1456</span> |
| <span id="1457">1457</span> |
| <span id="1458">1458</span> |
| <span id="1459">1459</span> |
| <span id="1460">1460</span> |
| <span id="1461">1461</span> |
| <span id="1462">1462</span> |
| <span id="1463">1463</span> |
| <span id="1464">1464</span> |
| <span id="1465">1465</span> |
| <span id="1466">1466</span> |
| <span id="1467">1467</span> |
| <span id="1468">1468</span> |
| <span id="1469">1469</span> |
| <span id="1470">1470</span> |
| <span id="1471">1471</span> |
| <span id="1472">1472</span> |
| <span id="1473">1473</span> |
| <span id="1474">1474</span> |
| <span id="1475">1475</span> |
| <span id="1476">1476</span> |
| <span id="1477">1477</span> |
| <span id="1478">1478</span> |
| <span id="1479">1479</span> |
| <span id="1480">1480</span> |
| <span id="1481">1481</span> |
| <span id="1482">1482</span> |
| <span id="1483">1483</span> |
| <span id="1484">1484</span> |
| <span id="1485">1485</span> |
| <span id="1486">1486</span> |
| <span id="1487">1487</span> |
| <span id="1488">1488</span> |
| <span id="1489">1489</span> |
| <span id="1490">1490</span> |
| <span id="1491">1491</span> |
| <span id="1492">1492</span> |
| <span id="1493">1493</span> |
| <span id="1494">1494</span> |
| <span id="1495">1495</span> |
| <span id="1496">1496</span> |
| <span id="1497">1497</span> |
| <span id="1498">1498</span> |
| <span id="1499">1499</span> |
| <span id="1500">1500</span> |
| <span id="1501">1501</span> |
| <span id="1502">1502</span> |
| <span id="1503">1503</span> |
| <span id="1504">1504</span> |
| <span id="1505">1505</span> |
| <span id="1506">1506</span> |
| <span id="1507">1507</span> |
| <span id="1508">1508</span> |
| <span id="1509">1509</span> |
| <span id="1510">1510</span> |
| <span id="1511">1511</span> |
| <span id="1512">1512</span> |
| <span id="1513">1513</span> |
| <span id="1514">1514</span> |
| <span id="1515">1515</span> |
| <span id="1516">1516</span> |
| <span id="1517">1517</span> |
| <span id="1518">1518</span> |
| <span id="1519">1519</span> |
| <span id="1520">1520</span> |
| <span id="1521">1521</span> |
| <span id="1522">1522</span> |
| <span id="1523">1523</span> |
| <span id="1524">1524</span> |
| <span id="1525">1525</span> |
| <span id="1526">1526</span> |
| <span id="1527">1527</span> |
| <span id="1528">1528</span> |
| <span id="1529">1529</span> |
| <span id="1530">1530</span> |
| <span id="1531">1531</span> |
| <span id="1532">1532</span> |
| <span id="1533">1533</span> |
| <span id="1534">1534</span> |
| <span id="1535">1535</span> |
| <span id="1536">1536</span> |
| <span id="1537">1537</span> |
| <span id="1538">1538</span> |
| <span id="1539">1539</span> |
| <span id="1540">1540</span> |
| <span id="1541">1541</span> |
| <span id="1542">1542</span> |
| <span id="1543">1543</span> |
| <span id="1544">1544</span> |
| <span id="1545">1545</span> |
| <span id="1546">1546</span> |
| <span id="1547">1547</span> |
| <span id="1548">1548</span> |
| <span id="1549">1549</span> |
| <span id="1550">1550</span> |
| <span id="1551">1551</span> |
| <span id="1552">1552</span> |
| <span id="1553">1553</span> |
| <span id="1554">1554</span> |
| <span id="1555">1555</span> |
| <span id="1556">1556</span> |
| <span id="1557">1557</span> |
| <span id="1558">1558</span> |
| <span id="1559">1559</span> |
| <span id="1560">1560</span> |
| <span id="1561">1561</span> |
| <span id="1562">1562</span> |
| <span id="1563">1563</span> |
| <span id="1564">1564</span> |
| <span id="1565">1565</span> |
| <span id="1566">1566</span> |
| <span id="1567">1567</span> |
| <span id="1568">1568</span> |
| <span id="1569">1569</span> |
| <span id="1570">1570</span> |
| <span id="1571">1571</span> |
| <span id="1572">1572</span> |
| <span id="1573">1573</span> |
| <span id="1574">1574</span> |
| <span id="1575">1575</span> |
| <span id="1576">1576</span> |
| <span id="1577">1577</span> |
| <span id="1578">1578</span> |
| <span id="1579">1579</span> |
| <span id="1580">1580</span> |
| <span id="1581">1581</span> |
| <span id="1582">1582</span> |
| <span id="1583">1583</span> |
| <span id="1584">1584</span> |
| <span id="1585">1585</span> |
| <span id="1586">1586</span> |
| <span id="1587">1587</span> |
| <span id="1588">1588</span> |
| <span id="1589">1589</span> |
| <span id="1590">1590</span> |
| <span id="1591">1591</span> |
| <span id="1592">1592</span> |
| <span id="1593">1593</span> |
| <span id="1594">1594</span> |
| <span id="1595">1595</span> |
| <span id="1596">1596</span> |
| <span id="1597">1597</span> |
| <span id="1598">1598</span> |
| <span id="1599">1599</span> |
| <span id="1600">1600</span> |
| <span id="1601">1601</span> |
| <span id="1602">1602</span> |
| <span id="1603">1603</span> |
| <span id="1604">1604</span> |
| <span id="1605">1605</span> |
| <span id="1606">1606</span> |
| <span id="1607">1607</span> |
| <span id="1608">1608</span> |
| <span id="1609">1609</span> |
| <span id="1610">1610</span> |
| <span id="1611">1611</span> |
| <span id="1612">1612</span> |
| <span id="1613">1613</span> |
| <span id="1614">1614</span> |
| <span id="1615">1615</span> |
| <span id="1616">1616</span> |
| <span id="1617">1617</span> |
| <span id="1618">1618</span> |
| <span id="1619">1619</span> |
| <span id="1620">1620</span> |
| <span id="1621">1621</span> |
| <span id="1622">1622</span> |
| <span id="1623">1623</span> |
| <span id="1624">1624</span> |
| <span id="1625">1625</span> |
| <span id="1626">1626</span> |
| <span id="1627">1627</span> |
| <span id="1628">1628</span> |
| <span id="1629">1629</span> |
| <span id="1630">1630</span> |
| <span id="1631">1631</span> |
| <span id="1632">1632</span> |
| <span id="1633">1633</span> |
| <span id="1634">1634</span> |
| <span id="1635">1635</span> |
| <span id="1636">1636</span> |
| <span id="1637">1637</span> |
| <span id="1638">1638</span> |
| <span id="1639">1639</span> |
| <span id="1640">1640</span> |
| <span id="1641">1641</span> |
| <span id="1642">1642</span> |
| <span id="1643">1643</span> |
| <span id="1644">1644</span> |
| <span id="1645">1645</span> |
| <span id="1646">1646</span> |
| <span id="1647">1647</span> |
| <span id="1648">1648</span> |
| <span id="1649">1649</span> |
| <span id="1650">1650</span> |
| <span id="1651">1651</span> |
| <span id="1652">1652</span> |
| <span id="1653">1653</span> |
| <span id="1654">1654</span> |
| <span id="1655">1655</span> |
| <span id="1656">1656</span> |
| <span id="1657">1657</span> |
| <span id="1658">1658</span> |
| <span id="1659">1659</span> |
| <span id="1660">1660</span> |
| <span id="1661">1661</span> |
| <span id="1662">1662</span> |
| <span id="1663">1663</span> |
| <span id="1664">1664</span> |
| <span id="1665">1665</span> |
| <span id="1666">1666</span> |
| <span id="1667">1667</span> |
| <span id="1668">1668</span> |
| <span id="1669">1669</span> |
| <span id="1670">1670</span> |
| <span id="1671">1671</span> |
| <span id="1672">1672</span> |
| <span id="1673">1673</span> |
| <span id="1674">1674</span> |
| <span id="1675">1675</span> |
| <span id="1676">1676</span> |
| <span id="1677">1677</span> |
| <span id="1678">1678</span> |
| <span id="1679">1679</span> |
| <span id="1680">1680</span> |
| <span id="1681">1681</span> |
| <span id="1682">1682</span> |
| <span id="1683">1683</span> |
| <span id="1684">1684</span> |
| <span id="1685">1685</span> |
| <span id="1686">1686</span> |
| <span id="1687">1687</span> |
| <span id="1688">1688</span> |
| <span id="1689">1689</span> |
| <span id="1690">1690</span> |
| <span id="1691">1691</span> |
| <span id="1692">1692</span> |
| <span id="1693">1693</span> |
| <span id="1694">1694</span> |
| <span id="1695">1695</span> |
| <span id="1696">1696</span> |
| <span id="1697">1697</span> |
| <span id="1698">1698</span> |
| <span id="1699">1699</span> |
| <span id="1700">1700</span> |
| <span id="1701">1701</span> |
| <span id="1702">1702</span> |
| <span id="1703">1703</span> |
| <span id="1704">1704</span> |
| <span id="1705">1705</span> |
| <span id="1706">1706</span> |
| <span id="1707">1707</span> |
| <span id="1708">1708</span> |
| <span id="1709">1709</span> |
| <span id="1710">1710</span> |
| <span id="1711">1711</span> |
| <span id="1712">1712</span> |
| <span id="1713">1713</span> |
| <span id="1714">1714</span> |
| <span id="1715">1715</span> |
| <span id="1716">1716</span> |
| <span id="1717">1717</span> |
| <span id="1718">1718</span> |
| <span id="1719">1719</span> |
| <span id="1720">1720</span> |
| <span id="1721">1721</span> |
| <span id="1722">1722</span> |
| <span id="1723">1723</span> |
| <span id="1724">1724</span> |
| <span id="1725">1725</span> |
| <span id="1726">1726</span> |
| <span id="1727">1727</span> |
| <span id="1728">1728</span> |
| <span id="1729">1729</span> |
| <span id="1730">1730</span> |
| <span id="1731">1731</span> |
| <span id="1732">1732</span> |
| <span id="1733">1733</span> |
| <span id="1734">1734</span> |
| <span id="1735">1735</span> |
| <span id="1736">1736</span> |
| <span id="1737">1737</span> |
| <span id="1738">1738</span> |
| <span id="1739">1739</span> |
| <span id="1740">1740</span> |
| <span id="1741">1741</span> |
| <span id="1742">1742</span> |
| <span id="1743">1743</span> |
| <span id="1744">1744</span> |
| <span id="1745">1745</span> |
| <span id="1746">1746</span> |
| <span id="1747">1747</span> |
| <span id="1748">1748</span> |
| <span id="1749">1749</span> |
| <span id="1750">1750</span> |
| <span id="1751">1751</span> |
| <span id="1752">1752</span> |
| <span id="1753">1753</span> |
| <span id="1754">1754</span> |
| <span id="1755">1755</span> |
| <span id="1756">1756</span> |
| <span id="1757">1757</span> |
| <span id="1758">1758</span> |
| <span id="1759">1759</span> |
| <span id="1760">1760</span> |
| <span id="1761">1761</span> |
| <span id="1762">1762</span> |
| <span id="1763">1763</span> |
| <span id="1764">1764</span> |
| <span id="1765">1765</span> |
| <span id="1766">1766</span> |
| <span id="1767">1767</span> |
| <span id="1768">1768</span> |
| <span id="1769">1769</span> |
| <span id="1770">1770</span> |
| <span id="1771">1771</span> |
| <span id="1772">1772</span> |
| <span id="1773">1773</span> |
| <span id="1774">1774</span> |
| <span id="1775">1775</span> |
| <span id="1776">1776</span> |
| <span id="1777">1777</span> |
| <span id="1778">1778</span> |
| <span id="1779">1779</span> |
| <span id="1780">1780</span> |
| <span id="1781">1781</span> |
| <span id="1782">1782</span> |
| <span id="1783">1783</span> |
| <span id="1784">1784</span> |
| <span id="1785">1785</span> |
| <span id="1786">1786</span> |
| <span id="1787">1787</span> |
| <span id="1788">1788</span> |
| <span id="1789">1789</span> |
| <span id="1790">1790</span> |
| <span id="1791">1791</span> |
| <span id="1792">1792</span> |
| <span id="1793">1793</span> |
| <span id="1794">1794</span> |
| <span id="1795">1795</span> |
| <span id="1796">1796</span> |
| <span id="1797">1797</span> |
| <span id="1798">1798</span> |
| <span id="1799">1799</span> |
| <span id="1800">1800</span> |
| <span id="1801">1801</span> |
| <span id="1802">1802</span> |
| <span id="1803">1803</span> |
| <span id="1804">1804</span> |
| <span id="1805">1805</span> |
| <span id="1806">1806</span> |
| <span id="1807">1807</span> |
| <span id="1808">1808</span> |
| <span id="1809">1809</span> |
| <span id="1810">1810</span> |
| <span id="1811">1811</span> |
| <span id="1812">1812</span> |
| <span id="1813">1813</span> |
| <span id="1814">1814</span> |
| <span id="1815">1815</span> |
| <span id="1816">1816</span> |
| <span id="1817">1817</span> |
| <span id="1818">1818</span> |
| <span id="1819">1819</span> |
| <span id="1820">1820</span> |
| <span id="1821">1821</span> |
| <span id="1822">1822</span> |
| <span id="1823">1823</span> |
| <span id="1824">1824</span> |
| <span id="1825">1825</span> |
| <span id="1826">1826</span> |
| <span id="1827">1827</span> |
| <span id="1828">1828</span> |
| <span id="1829">1829</span> |
| <span id="1830">1830</span> |
| <span id="1831">1831</span> |
| <span id="1832">1832</span> |
| <span id="1833">1833</span> |
| <span id="1834">1834</span> |
| <span id="1835">1835</span> |
| <span id="1836">1836</span> |
| <span id="1837">1837</span> |
| <span id="1838">1838</span> |
| <span id="1839">1839</span> |
| <span id="1840">1840</span> |
| <span id="1841">1841</span> |
| <span id="1842">1842</span> |
| <span id="1843">1843</span> |
| <span id="1844">1844</span> |
| <span id="1845">1845</span> |
| <span id="1846">1846</span> |
| <span id="1847">1847</span> |
| <span id="1848">1848</span> |
| <span id="1849">1849</span> |
| <span id="1850">1850</span> |
| <span id="1851">1851</span> |
| <span id="1852">1852</span> |
| <span id="1853">1853</span> |
| <span id="1854">1854</span> |
| <span id="1855">1855</span> |
| <span id="1856">1856</span> |
| <span id="1857">1857</span> |
| <span id="1858">1858</span> |
| <span id="1859">1859</span> |
| <span id="1860">1860</span> |
| <span id="1861">1861</span> |
| <span id="1862">1862</span> |
| <span id="1863">1863</span> |
| <span id="1864">1864</span> |
| <span id="1865">1865</span> |
| <span id="1866">1866</span> |
| <span id="1867">1867</span> |
| <span id="1868">1868</span> |
| <span id="1869">1869</span> |
| <span id="1870">1870</span> |
| <span id="1871">1871</span> |
| <span id="1872">1872</span> |
| <span id="1873">1873</span> |
| <span id="1874">1874</span> |
| <span id="1875">1875</span> |
| <span id="1876">1876</span> |
| <span id="1877">1877</span> |
| <span id="1878">1878</span> |
| <span id="1879">1879</span> |
| <span id="1880">1880</span> |
| <span id="1881">1881</span> |
| <span id="1882">1882</span> |
| <span id="1883">1883</span> |
| <span id="1884">1884</span> |
| <span id="1885">1885</span> |
| <span id="1886">1886</span> |
| <span id="1887">1887</span> |
| <span id="1888">1888</span> |
| <span id="1889">1889</span> |
| <span id="1890">1890</span> |
| <span id="1891">1891</span> |
| <span id="1892">1892</span> |
| <span id="1893">1893</span> |
| <span id="1894">1894</span> |
| <span id="1895">1895</span> |
| <span id="1896">1896</span> |
| <span id="1897">1897</span> |
| <span id="1898">1898</span> |
| <span id="1899">1899</span> |
| <span id="1900">1900</span> |
| <span id="1901">1901</span> |
| <span id="1902">1902</span> |
| <span id="1903">1903</span> |
| <span id="1904">1904</span> |
| <span id="1905">1905</span> |
| <span id="1906">1906</span> |
| <span id="1907">1907</span> |
| <span id="1908">1908</span> |
| <span id="1909">1909</span> |
| </pre><pre class="rust"><code><span class="kw">mod </span>help; |
| <span class="kw">mod </span>meta; |
| <span class="kw">pub mod </span>parser; |
| <span class="kw">mod </span>settings; |
| <span class="kw">mod </span>usage; |
| <span class="kw">mod </span>validator; |
| |
| <span class="comment">// Std |
| </span><span class="kw">use </span>std::result::Result <span class="kw">as </span>StdResult; |
| <span class="kw">use </span>std::{ |
| env, |
| ffi::{OsStr, OsString}, |
| fmt, |
| io::{<span class="self">self</span>, BufRead, BufWriter, Write}, |
| path::Path, |
| process, |
| rc::Rc, |
| }; |
| |
| <span class="comment">// Third Party |
| </span><span class="attribute">#[cfg(feature = <span class="string">"yaml"</span>)] |
| </span><span class="kw">use </span>yaml_rust::Yaml; |
| |
| <span class="comment">// Internal |
| </span><span class="kw">use </span><span class="kw">crate</span>::errors::Result <span class="kw">as </span>ClapResult; |
| <span class="kw">use crate</span>::{ |
| app::{help::Help, parser::Parser}, |
| args::{AnyArg, Arg, ArgGroup, ArgMatcher, ArgMatches, ArgSettings}, |
| completions::Shell, |
| map::{<span class="self">self</span>, VecMap}, |
| }; |
| <span class="kw">pub use </span>settings::AppSettings; |
| |
| <span class="doccomment">/// Used to create a representation of a command line program and all possible command line |
| /// arguments. Application settings are set using the "builder pattern" with the |
| /// [`App::get_matches`] family of methods being the terminal methods that starts the |
| /// runtime-parsing process. These methods then return information about the user supplied |
| /// arguments (or lack there of). |
| /// |
| /// **NOTE:** There aren't any mandatory "options" that one must set. The "options" may |
| /// also appear in any order (so long as one of the [`App::get_matches`] methods is the last method |
| /// called). |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// let m = App::new("My Program") |
| /// .author("Me, me@mail.com") |
| /// .version("1.0.2") |
| /// .about("Explains in brief what the program does") |
| /// .arg( |
| /// Arg::with_name("in_file").index(1) |
| /// ) |
| /// .after_help("Longer explanation to appear after the options when \ |
| /// displaying the help information from --help or -h") |
| /// .get_matches(); |
| /// |
| /// // Your program logic starts here... |
| /// ``` |
| /// [`App::get_matches`]: ./struct.App.html#method.get_matches |
| </span><span class="attribute">#[allow(missing_debug_implementations)] |
| </span><span class="kw">pub struct </span>App<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> |
| <span class="kw">where |
| </span><span class="lifetime">'a</span>: <span class="lifetime">'b</span>, |
| { |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub </span>p: Parser<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> App<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> { |
| <span class="doccomment">/// Creates a new instance of an application requiring a name. The name may be, but doesn't |
| /// have to be same as the binary. The name will be displayed to the user when they request to |
| /// print version or help and usage information. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// let prog = App::new("My Program") |
| /// # ; |
| /// ``` |
| </span><span class="kw">pub fn </span>new<S: Into<String>>(n: S) -> <span class="self">Self </span>{ |
| App { |
| p: Parser::with_name(n.into()), |
| } |
| } |
| |
| <span class="doccomment">/// Get the name of the app |
| </span><span class="kw">pub fn </span>get_name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <span class="kw-2">&</span><span class="self">self</span>.p.meta.name |
| } |
| |
| <span class="doccomment">/// Get the name of the binary |
| </span><span class="kw">pub fn </span>get_bin_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>.p.meta.bin_name.as_deref() |
| } |
| |
| <span class="doccomment">/// Creates a new instance of an application requiring a name, but uses the [`crate_authors!`] |
| /// and [`crate_version!`] macros to fill in the [`App::author`] and [`App::version`] fields. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// let prog = App::with_defaults("My Program") |
| /// # ; |
| /// ``` |
| /// [`crate_authors!`]: ./macro.crate_authors!.html |
| /// [`crate_version!`]: ./macro.crate_version!.html |
| /// [`App::author`]: ./struct.App.html#method.author |
| /// [`App::version`]: ./struct.App.html#method.author |
| </span><span class="attribute">#[deprecated( |
| since = <span class="string">"2.14.1"</span>, |
| note = <span class="string">"Can never work; use explicit App::author() and App::version() calls instead" |
| </span>)] |
| </span><span class="kw">pub fn </span>with_defaults<S: Into<String>>(n: S) -> <span class="self">Self </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>a = App { |
| p: Parser::with_name(n.into()), |
| }; |
| a.p.meta.author = <span class="prelude-val">Some</span>(<span class="string">"Kevin K. <kbknapp@gmail.com>"</span>); |
| a.p.meta.version = <span class="prelude-val">Some</span>(<span class="string">"2.19.2"</span>); |
| a |
| } |
| |
| <span class="doccomment">/// Creates a new instance of [`App`] from a .yml (YAML) file. A full example of supported YAML |
| /// objects can be found in [`examples/17_yaml.rs`] and [`examples/17_yaml.yml`]. One great use |
| /// for using YAML is when supporting multiple languages and dialects, as each language could |
| /// be a distinct YAML file and determined at compiletime via `cargo` "features" in your |
| /// `Cargo.toml` |
| /// |
| /// In order to use this function you must compile `clap` with the `features = ["yaml"]` in |
| /// your settings for the `[dependencies.clap]` table of your `Cargo.toml` |
| /// |
| /// **NOTE:** Due to how the YAML objects are built there is a convenience macro for loading |
| /// the YAML file at compile time (relative to the current file, like modules work). That YAML |
| /// object can then be passed to this function. |
| /// |
| /// # Panics |
| /// |
| /// The YAML file must be properly formatted or this function will [`panic!`]. A good way to |
| /// ensure this doesn't happen is to run your program with the `--help` switch. If this passes |
| /// without error, you needn't worry because the YAML is properly formatted. |
| /// |
| /// # Examples |
| /// |
| /// The following example shows how to load a properly formatted YAML file to build an instance |
| /// of an [`App`] struct. |
| /// |
| /// ```ignore |
| /// # #[macro_use] |
| /// # extern crate clap; |
| /// # use clap::App; |
| /// # fn main() { |
| /// let yml = load_yaml!("app.yml"); |
| /// let app = App::from_yaml(yml); |
| /// |
| /// // continued logic goes here, such as `app.get_matches()` etc. |
| /// # } |
| /// ``` |
| /// [`App`]: ./struct.App.html |
| /// [`examples/17_yaml.rs`]: https://github.com/clap-rs/clap/blob/v2.33.1/examples/17_yaml.rs |
| /// [`examples/17_yaml.yml`]: https://github.com/clap-rs/clap/blob/v2.33.1/examples/17_yaml.yml |
| /// [`panic!`]: https://doc.rust-lang.org/std/macro.panic!.html |
| </span><span class="attribute">#[cfg(feature = <span class="string">"yaml"</span>)] |
| </span><span class="kw">pub fn </span>from_yaml(yaml: <span class="kw-2">&</span><span class="lifetime">'a </span>Yaml) -> App<<span class="lifetime">'a</span>, <span class="lifetime">'a</span>> { |
| App::from(yaml) |
| } |
| |
| <span class="doccomment">/// Sets a string of author(s) that will be displayed to the user when they |
| /// request the help information with `--help` or `-h`. |
| /// |
| /// **Pro-tip:** Use `clap`s convenience macro [`crate_authors!`] to automatically set your |
| /// application's author(s) to the same thing as your crate at compile time. See the [`examples/`] |
| /// directory for more information |
| /// |
| /// See the [`examples/`] |
| /// directory for more information |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .author("Me, me@mymain.com") |
| /// # ; |
| /// ``` |
| /// [`crate_authors!`]: ./macro.crate_authors!.html |
| /// [`examples/`]: https://github.com/clap-rs/clap/tree/v2.33.1/examples |
| </span><span class="kw">pub fn </span>author<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, author: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.author = <span class="prelude-val">Some</span>(author.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Overrides the system-determined binary name. This should only be used when absolutely |
| /// necessary, such as when the binary name for your application is misleading, or perhaps |
| /// *not* how the user should invoke your program. |
| /// |
| /// **Pro-tip:** When building things such as third party `cargo` subcommands, this setting |
| /// **should** be used! |
| /// |
| /// **NOTE:** This command **should not** be used for [`SubCommand`]s. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("My Program") |
| /// .bin_name("my_binary") |
| /// # ; |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| </span><span class="kw">pub fn </span>bin_name<S: Into<String>>(<span class="kw-2">mut </span><span class="self">self</span>, name: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.bin_name = <span class="prelude-val">Some</span>(name.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets a string describing what the program does. This will be displayed when displaying help |
| /// information with `-h`. |
| /// |
| /// **NOTE:** If only `about` is provided, and not [`App::long_about`] but the user requests |
| /// `--help` clap will still display the contents of `about` appropriately |
| /// |
| /// **NOTE:** Only [`App::about`] is used in completion script generation in order to be |
| /// concise |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .about("Does really amazing things to great people") |
| /// # ; |
| /// ``` |
| /// [`App::long_about`]: ./struct.App.html#method.long_about |
| </span><span class="kw">pub fn </span>about<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, about: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.about = <span class="prelude-val">Some</span>(about.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets a string describing what the program does. This will be displayed when displaying help |
| /// information. |
| /// |
| /// **NOTE:** If only `long_about` is provided, and not [`App::about`] but the user requests |
| /// `-h` clap will still display the contents of `long_about` appropriately |
| /// |
| /// **NOTE:** Only [`App::about`] is used in completion script generation in order to be |
| /// concise |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .long_about( |
| /// "Does really amazing things to great people. Now let's talk a little |
| /// more in depth about how this subcommand really works. It may take about |
| /// a few lines of text, but that's ok!") |
| /// # ; |
| /// ``` |
| /// [`App::about`]: ./struct.App.html#method.about |
| </span><span class="kw">pub fn </span>long_about<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, about: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.long_about = <span class="prelude-val">Some</span>(about.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the program's name. This will be displayed when displaying help information. |
| /// |
| /// **Pro-top:** This function is particularly useful when configuring a program via |
| /// [`App::from_yaml`] in conjunction with the [`crate_name!`] macro to derive the program's |
| /// name from its `Cargo.toml`. |
| /// |
| /// # Examples |
| /// ```ignore |
| /// # #[macro_use] |
| /// # extern crate clap; |
| /// # use clap::App; |
| /// # fn main() { |
| /// let yml = load_yaml!("app.yml"); |
| /// let app = App::from_yaml(yml) |
| /// .name(crate_name!()); |
| /// |
| /// // continued logic goes here, such as `app.get_matches()` etc. |
| /// # } |
| /// ``` |
| /// |
| /// [`App::from_yaml`]: ./struct.App.html#method.from_yaml |
| /// [`crate_name!`]: ./macro.crate_name.html |
| </span><span class="kw">pub fn </span>name<S: Into<String>>(<span class="kw-2">mut </span><span class="self">self</span>, name: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.name = name.into(); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Adds additional help information to be displayed in addition to auto-generated help. This |
| /// information is displayed **after** the auto-generated help information. This is often used |
| /// to describe how to use the arguments, or caveats to be noted. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::App; |
| /// App::new("myprog") |
| /// .after_help("Does really amazing things to great people...but be careful with -R") |
| /// # ; |
| /// ``` |
| </span><span class="kw">pub fn </span>after_help<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, help: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.more_help = <span class="prelude-val">Some</span>(help.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Adds additional help information to be displayed in addition to auto-generated help. This |
| /// information is displayed **before** the auto-generated help information. This is often used |
| /// for header information. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::App; |
| /// App::new("myprog") |
| /// .before_help("Some info I'd like to appear before the help info") |
| /// # ; |
| /// ``` |
| </span><span class="kw">pub fn </span>before_help<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, help: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.pre_help = <span class="prelude-val">Some</span>(help.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets a string of the version number to be displayed when displaying version or help |
| /// information with `-V`. |
| /// |
| /// **NOTE:** If only `version` is provided, and not [`App::long_version`] but the user |
| /// requests `--version` clap will still display the contents of `version` appropriately |
| /// |
| /// **Pro-tip:** Use `clap`s convenience macro [`crate_version!`] to automatically set your |
| /// application's version to the same thing as your crate at compile time. See the [`examples/`] |
| /// directory for more information |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .version("v0.1.24") |
| /// # ; |
| /// ``` |
| /// [`crate_version!`]: ./macro.crate_version!.html |
| /// [`examples/`]: https://github.com/clap-rs/clap/tree/v2.33.1/examples |
| /// [`App::long_version`]: ./struct.App.html#method.long_version |
| </span><span class="kw">pub fn </span>version<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, ver: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.version = <span class="prelude-val">Some</span>(ver.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets a string of the version number to be displayed when displaying version or help |
| /// information with `--version`. |
| /// |
| /// **NOTE:** If only `long_version` is provided, and not [`App::version`] but the user |
| /// requests `-V` clap will still display the contents of `long_version` appropriately |
| /// |
| /// **Pro-tip:** Use `clap`s convenience macro [`crate_version!`] to automatically set your |
| /// application's version to the same thing as your crate at compile time. See the [`examples/`] |
| /// directory for more information |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .long_version( |
| /// "v0.1.24 |
| /// commit: abcdef89726d |
| /// revision: 123 |
| /// release: 2 |
| /// binary: myprog") |
| /// # ; |
| /// ``` |
| /// [`crate_version!`]: ./macro.crate_version!.html |
| /// [`examples/`]: https://github.com/clap-rs/clap/tree/v2.33.1/examples |
| /// [`App::version`]: ./struct.App.html#method.version |
| </span><span class="kw">pub fn </span>long_version<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, ver: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.long_version = <span class="prelude-val">Some</span>(ver.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets a custom usage string to override the auto-generated usage string. |
| /// |
| /// This will be displayed to the user when errors are found in argument parsing, or when you |
| /// call [`ArgMatches::usage`] |
| /// |
| /// **CAUTION:** Using this setting disables `clap`s "context-aware" usage strings. After this |
| /// setting is set, this will be the only usage string displayed to the user! |
| /// |
| /// **NOTE:** You do not need to specify the "USAGE: \n\t" portion, as that will |
| /// still be applied by `clap`, you only need to specify the portion starting |
| /// with the binary name. |
| /// |
| /// **NOTE:** This will not replace the entire help message, *only* the portion |
| /// showing the usage. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .usage("myapp [-clDas] <some_file>") |
| /// # ; |
| /// ``` |
| /// [`ArgMatches::usage`]: ./struct.ArgMatches.html#method.usage |
| </span><span class="kw">pub fn </span>usage<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, usage: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.usage_str = <span class="prelude-val">Some</span>(usage.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets a custom help message and overrides the auto-generated one. This should only be used |
| /// when the auto-generated message does not suffice. |
| /// |
| /// This will be displayed to the user when they use `--help` or `-h` |
| /// |
| /// **NOTE:** This replaces the **entire** help message, so nothing will be auto-generated. |
| /// |
| /// **NOTE:** This **only** replaces the help message for the current command, meaning if you |
| /// are using subcommands, those help messages will still be auto-generated unless you |
| /// specify a [`Arg::help`] for them as well. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myapp") |
| /// .help("myapp v1.0\n\ |
| /// Does awesome things\n\ |
| /// (C) me@mail.com\n\n\ |
| /// |
| /// USAGE: myapp <opts> <command>\n\n\ |
| /// |
| /// Options:\n\ |
| /// -h, --help Display this message\n\ |
| /// -V, --version Display version info\n\ |
| /// -s <stuff> Do something with stuff\n\ |
| /// -v Be verbose\n\n\ |
| /// |
| /// Commmands:\n\ |
| /// help Prints this message\n\ |
| /// work Do some work") |
| /// # ; |
| /// ``` |
| /// [`Arg::help`]: ./struct.Arg.html#method.help |
| </span><span class="kw">pub fn </span>help<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, help: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.help_str = <span class="prelude-val">Some</span>(help.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the [`short`] for the auto-generated `help` argument. |
| /// |
| /// By default `clap` automatically assigns `h`, but this can be overridden if you have a |
| /// different argument which you'd prefer to use the `-h` short with. This can be done by |
| /// defining your own argument with a lowercase `h` as the [`short`]. |
| /// |
| /// `clap` lazily generates these `help` arguments **after** you've defined any arguments of |
| /// your own. |
| /// |
| /// **NOTE:** Any leading `-` characters will be stripped, and only the first |
| /// non `-` character will be used as the [`short`] version |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .help_short("H") // Using an uppercase `H` instead of the default lowercase `h` |
| /// # ; |
| /// ``` |
| /// [`short`]: ./struct.Arg.html#method.short |
| </span><span class="kw">pub fn </span>help_short<S: AsRef<str> + <span class="lifetime">'b</span>>(<span class="kw-2">mut </span><span class="self">self</span>, s: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.help_short(s.as_ref()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the [`short`] for the auto-generated `version` argument. |
| /// |
| /// By default `clap` automatically assigns `V`, but this can be overridden if you have a |
| /// different argument which you'd prefer to use the `-V` short with. This can be done by |
| /// defining your own argument with an uppercase `V` as the [`short`]. |
| /// |
| /// `clap` lazily generates these `version` arguments **after** you've defined any arguments of |
| /// your own. |
| /// |
| /// **NOTE:** Any leading `-` characters will be stripped, and only the first |
| /// non `-` character will be used as the `short` version |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .version_short("v") // Using a lowercase `v` instead of the default capital `V` |
| /// # ; |
| /// ``` |
| /// [`short`]: ./struct.Arg.html#method.short |
| </span><span class="kw">pub fn </span>version_short<S: AsRef<str>>(<span class="kw-2">mut </span><span class="self">self</span>, s: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.version_short(s.as_ref()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the help text for the auto-generated `help` argument. |
| /// |
| /// By default `clap` sets this to `"Prints help information"`, but if you're using a |
| /// different convention for your help messages and would prefer a different phrasing you can |
| /// override it. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .help_message("Print help information") // Perhaps you want imperative help messages |
| /// |
| /// # ; |
| /// ``` |
| </span><span class="kw">pub fn </span>help_message<S: Into<<span class="kw-2">&</span><span class="lifetime">'a </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, s: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.help_message = <span class="prelude-val">Some</span>(s.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the help text for the auto-generated `version` argument. |
| /// |
| /// By default `clap` sets this to `"Prints version information"`, but if you're using a |
| /// different convention for your help messages and would prefer a different phrasing then you |
| /// can change it. |
| /// |
| /// # Examples |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .version_message("Print version information") // Perhaps you want imperative help messages |
| /// # ; |
| /// ``` |
| </span><span class="kw">pub fn </span>version_message<S: Into<<span class="kw-2">&</span><span class="lifetime">'a </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, s: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.version_message = <span class="prelude-val">Some</span>(s.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the help template to be used, overriding the default format. |
| /// |
| /// Tags arg given inside curly brackets. |
| /// |
| /// Valid tags are: |
| /// |
| /// * `{bin}` - Binary name. |
| /// * `{version}` - Version number. |
| /// * `{author}` - Author information. |
| /// * `{about}` - General description (from [`App::about`]) |
| /// * `{usage}` - Automatically generated or given usage string. |
| /// * `{all-args}` - Help for all arguments (options, flags, positionals arguments, |
| /// and subcommands) including titles. |
| /// * `{unified}` - Unified help for options and flags. Note, you must *also* set |
| /// [`AppSettings::UnifiedHelpMessage`] to fully merge both options and |
| /// flags, otherwise the ordering is "best effort" |
| /// * `{flags}` - Help for flags. |
| /// * `{options}` - Help for options. |
| /// * `{positionals}` - Help for positionals arguments. |
| /// * `{subcommands}` - Help for subcommands. |
| /// * `{after-help}` - Help from [`App::after_help`] |
| /// * `{before-help}` - Help from [`App::before_help`] |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .version("1.0") |
| /// .template("{bin} ({version}) - {usage}") |
| /// # ; |
| /// ``` |
| /// **NOTE:** The template system is, on purpose, very simple. Therefore the tags have to be |
| /// written in lowercase and without spacing. |
| /// |
| /// [`App::about`]: ./struct.App.html#method.about |
| /// [`App::after_help`]: ./struct.App.html#method.after_help |
| /// [`App::before_help`]: ./struct.App.html#method.before_help |
| /// [`AppSettings::UnifiedHelpMessage`]: ./enum.AppSettings.html#variant.UnifiedHelpMessage |
| </span><span class="kw">pub fn </span>template<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, s: S) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.template = <span class="prelude-val">Some</span>(s.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Enables a single command, or [`SubCommand`], level settings. |
| /// |
| /// See [`AppSettings`] for a full list of possibilities and examples. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, AppSettings}; |
| /// App::new("myprog") |
| /// .setting(AppSettings::SubcommandRequired) |
| /// .setting(AppSettings::WaitOnError) |
| /// # ; |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`AppSettings`]: ./enum.AppSettings.html |
| </span><span class="kw">pub fn </span>setting(<span class="kw-2">mut </span><span class="self">self</span>, setting: AppSettings) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.set(setting); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Enables multiple command, or [`SubCommand`], level settings |
| /// |
| /// See [`AppSettings`] for a full list of possibilities and examples. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, AppSettings}; |
| /// App::new("myprog") |
| /// .settings(&[AppSettings::SubcommandRequired, |
| /// AppSettings::WaitOnError]) |
| /// # ; |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`AppSettings`]: ./enum.AppSettings.html |
| </span><span class="kw">pub fn </span>settings(<span class="kw-2">mut </span><span class="self">self</span>, settings: <span class="kw-2">&</span>[AppSettings]) -> <span class="self">Self </span>{ |
| <span class="kw">for </span>s <span class="kw">in </span>settings { |
| <span class="self">self</span>.p.set(<span class="kw-2">*</span>s); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Enables a single setting that is propagated down through all child [`SubCommand`]s. |
| /// |
| /// See [`AppSettings`] for a full list of possibilities and examples. |
| /// |
| /// **NOTE**: The setting is *only* propagated *down* and not up through parent commands. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, AppSettings}; |
| /// App::new("myprog") |
| /// .global_setting(AppSettings::SubcommandRequired) |
| /// # ; |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`AppSettings`]: ./enum.AppSettings.html |
| </span><span class="kw">pub fn </span>global_setting(<span class="kw-2">mut </span><span class="self">self</span>, setting: AppSettings) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.set(setting); |
| <span class="self">self</span>.p.g_settings.set(setting); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Enables multiple settings which are propagated *down* through all child [`SubCommand`]s. |
| /// |
| /// See [`AppSettings`] for a full list of possibilities and examples. |
| /// |
| /// **NOTE**: The setting is *only* propagated *down* and not up through parent commands. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, AppSettings}; |
| /// App::new("myprog") |
| /// .global_settings(&[AppSettings::SubcommandRequired, |
| /// AppSettings::ColoredHelp]) |
| /// # ; |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`AppSettings`]: ./enum.AppSettings.html |
| </span><span class="kw">pub fn </span>global_settings(<span class="kw-2">mut </span><span class="self">self</span>, settings: <span class="kw-2">&</span>[AppSettings]) -> <span class="self">Self </span>{ |
| <span class="kw">for </span>s <span class="kw">in </span>settings { |
| <span class="self">self</span>.p.set(<span class="kw-2">*</span>s); |
| <span class="self">self</span>.p.g_settings.set(<span class="kw-2">*</span>s) |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Disables a single command, or [`SubCommand`], level setting. |
| /// |
| /// See [`AppSettings`] for a full list of possibilities and examples. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, AppSettings}; |
| /// App::new("myprog") |
| /// .unset_setting(AppSettings::ColorAuto) |
| /// # ; |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`AppSettings`]: ./enum.AppSettings.html |
| </span><span class="kw">pub fn </span>unset_setting(<span class="kw-2">mut </span><span class="self">self</span>, setting: AppSettings) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.unset(setting); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Disables multiple command, or [`SubCommand`], level settings. |
| /// |
| /// See [`AppSettings`] for a full list of possibilities and examples. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, AppSettings}; |
| /// App::new("myprog") |
| /// .unset_settings(&[AppSettings::ColorAuto, |
| /// AppSettings::AllowInvalidUtf8]) |
| /// # ; |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`AppSettings`]: ./enum.AppSettings.html |
| </span><span class="kw">pub fn </span>unset_settings(<span class="kw-2">mut </span><span class="self">self</span>, settings: <span class="kw-2">&</span>[AppSettings]) -> <span class="self">Self </span>{ |
| <span class="kw">for </span>s <span class="kw">in </span>settings { |
| <span class="self">self</span>.p.unset(<span class="kw-2">*</span>s); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the terminal width at which to wrap help messages. Defaults to `120`. Using `0` will |
| /// ignore terminal widths and use source formatting. |
| /// |
| /// `clap` automatically tries to determine the terminal width on Unix, Linux, macOS and Windows |
| /// if the `wrap_help` cargo "feature" has been used while compiling. If the terminal width |
| /// cannot be determined, `clap` defaults to `120`. |
| /// |
| /// **NOTE:** This setting applies globally and *not* on a per-command basis. |
| /// |
| /// **NOTE:** This setting must be set **before** any subcommands are added! |
| /// |
| /// # Platform Specific |
| /// |
| /// Only Unix, Linux, macOS and Windows support automatic determination of terminal width. |
| /// Even on those platforms, this setting is useful if for any reason the terminal width |
| /// cannot be determined. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::App; |
| /// App::new("myprog") |
| /// .set_term_width(80) |
| /// # ; |
| /// ``` |
| </span><span class="kw">pub fn </span>set_term_width(<span class="kw-2">mut </span><span class="self">self</span>, width: usize) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.term_w = <span class="prelude-val">Some</span>(width); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the max terminal width at which to wrap help messages. Using `0` will ignore terminal |
| /// widths and use source formatting. |
| /// |
| /// `clap` automatically tries to determine the terminal width on Unix, Linux, macOS and Windows |
| /// if the `wrap_help` cargo "feature" has been used while compiling, but one might want to |
| /// limit the size (e.g. when the terminal is running fullscreen). |
| /// |
| /// **NOTE:** This setting applies globally and *not* on a per-command basis. |
| /// |
| /// **NOTE:** This setting must be set **before** any subcommands are added! |
| /// |
| /// # Platform Specific |
| /// |
| /// Only Unix, Linux, macOS and Windows support automatic determination of terminal width. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::App; |
| /// App::new("myprog") |
| /// .max_term_width(100) |
| /// # ; |
| /// ``` |
| </span><span class="kw">pub fn </span>max_term_width(<span class="kw-2">mut </span><span class="self">self</span>, w: usize) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.max_w = <span class="prelude-val">Some</span>(w); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Adds an [argument] to the list of valid possibilities. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// // Adding a single "flag" argument with a short and help text, using Arg::with_name() |
| /// .arg( |
| /// Arg::with_name("debug") |
| /// .short("d") |
| /// .help("turns on debugging mode") |
| /// ) |
| /// // Adding a single "option" argument with a short, a long, and help text using the less |
| /// // verbose Arg::from_usage() |
| /// .arg( |
| /// Arg::from_usage("-c --config=[CONFIG] 'Optionally sets a config file to use'") |
| /// ) |
| /// # ; |
| /// ``` |
| /// [argument]: ./struct.Arg.html |
| </span><span class="kw">pub fn </span>arg<A: Into<Arg<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>>>(<span class="kw-2">mut </span><span class="self">self</span>, a: A) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.add_arg(a.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Adds multiple [arguments] to the list of valid possibilities |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .args( |
| /// &[Arg::from_usage("[debug] -d 'turns on debugging info'"), |
| /// Arg::with_name("input").index(1).help("the input file to use")] |
| /// ) |
| /// # ; |
| /// ``` |
| /// [arguments]: ./struct.Arg.html |
| </span><span class="kw">pub fn </span>args(<span class="kw-2">mut </span><span class="self">self</span>, args: <span class="kw-2">&</span>[Arg<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>]) -> <span class="self">Self </span>{ |
| <span class="kw">for </span>arg <span class="kw">in </span>args { |
| <span class="self">self</span>.p.add_arg_ref(arg); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// A convenience method for adding a single [argument] from a usage type string. The string |
| /// used follows the same rules and syntax as [`Arg::from_usage`] |
| /// |
| /// **NOTE:** The downside to using this method is that you can not set any additional |
| /// properties of the [`Arg`] other than what [`Arg::from_usage`] supports. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .arg_from_usage("-c --config=<FILE> 'Sets a configuration file to use'") |
| /// # ; |
| /// ``` |
| /// [argument]: ./struct.Arg.html |
| /// [`Arg`]: ./struct.Arg.html |
| /// [`Arg::from_usage`]: ./struct.Arg.html#method.from_usage |
| </span><span class="kw">pub fn </span>arg_from_usage(<span class="kw-2">mut </span><span class="self">self</span>, usage: <span class="kw-2">&</span><span class="lifetime">'a </span>str) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.add_arg(Arg::from_usage(usage)); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Adds multiple [arguments] at once from a usage string, one per line. See |
| /// [`Arg::from_usage`] for details on the syntax and rules supported. |
| /// |
| /// **NOTE:** Like [`App::arg_from_usage`] the downside is you only set properties for the |
| /// [`Arg`]s which [`Arg::from_usage`] supports. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// App::new("myprog") |
| /// .args_from_usage( |
| /// "-c --config=[FILE] 'Sets a configuration file to use' |
| /// [debug]... -d 'Sets the debugging level' |
| /// <FILE> 'The input file to use'" |
| /// ) |
| /// # ; |
| /// ``` |
| /// [arguments]: ./struct.Arg.html |
| /// [`Arg::from_usage`]: ./struct.Arg.html#method.from_usage |
| /// [`App::arg_from_usage`]: ./struct.App.html#method.arg_from_usage |
| /// [`Arg`]: ./struct.Arg.html |
| </span><span class="kw">pub fn </span>args_from_usage(<span class="kw-2">mut </span><span class="self">self</span>, usage: <span class="kw-2">&</span><span class="lifetime">'a </span>str) -> <span class="self">Self </span>{ |
| <span class="kw">for </span>line <span class="kw">in </span>usage.lines() { |
| <span class="kw">let </span>l = line.trim(); |
| <span class="kw">if </span>l.is_empty() { |
| <span class="kw">continue</span>; |
| } |
| <span class="self">self</span>.p.add_arg(Arg::from_usage(l)); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Allows adding a [`SubCommand`] alias, which function as "hidden" subcommands that |
| /// automatically dispatch as if this subcommand was used. This is more efficient, and easier |
| /// than creating multiple hidden subcommands as one only needs to check for the existence of |
| /// this command, and not all variants. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, SubCommand}; |
| /// let m = App::new("myprog") |
| /// .subcommand(SubCommand::with_name("test") |
| /// .alias("do-stuff")) |
| /// .get_matches_from(vec!["myprog", "do-stuff"]); |
| /// assert_eq!(m.subcommand_name(), Some("test")); |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| </span><span class="kw">pub fn </span>alias<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, name: S) -> <span class="self">Self </span>{ |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>als) = <span class="self">self</span>.p.meta.aliases { |
| als.push((name.into(), <span class="bool-val">false</span>)); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.p.meta.aliases = <span class="prelude-val">Some</span>(<span class="macro">vec!</span>[(name.into(), <span class="bool-val">false</span>)]); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Allows adding [`SubCommand`] aliases, which function as "hidden" subcommands that |
| /// automatically dispatch as if this subcommand was used. This is more efficient, and easier |
| /// than creating multiple hidden subcommands as one only needs to check for the existence of |
| /// this command, and not all variants. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, SubCommand}; |
| /// let m = App::new("myprog") |
| /// .subcommand(SubCommand::with_name("test") |
| /// .aliases(&["do-stuff", "do-tests", "tests"])) |
| /// .arg(Arg::with_name("input") |
| /// .help("the file to add") |
| /// .index(1) |
| /// .required(false)) |
| /// .get_matches_from(vec!["myprog", "do-tests"]); |
| /// assert_eq!(m.subcommand_name(), Some("test")); |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| </span><span class="kw">pub fn </span>aliases(<span class="kw-2">mut </span><span class="self">self</span>, names: <span class="kw-2">&</span>[<span class="kw-2">&</span><span class="lifetime">'b </span>str]) -> <span class="self">Self </span>{ |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>als) = <span class="self">self</span>.p.meta.aliases { |
| <span class="kw">for </span>n <span class="kw">in </span>names { |
| als.push((n, <span class="bool-val">false</span>)); |
| } |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.p.meta.aliases = <span class="prelude-val">Some</span>(names.iter().map(|n| (<span class="kw-2">*</span>n, <span class="bool-val">false</span>)).collect::<Vec<<span class="kw">_</span>>>()); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Allows adding a [`SubCommand`] alias that functions exactly like those defined with |
| /// [`App::alias`], except that they are visible inside the help message. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, SubCommand}; |
| /// let m = App::new("myprog") |
| /// .subcommand(SubCommand::with_name("test") |
| /// .visible_alias("do-stuff")) |
| /// .get_matches_from(vec!["myprog", "do-stuff"]); |
| /// assert_eq!(m.subcommand_name(), Some("test")); |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`App::alias`]: ./struct.App.html#method.alias |
| </span><span class="kw">pub fn </span>visible_alias<S: Into<<span class="kw-2">&</span><span class="lifetime">'b </span>str>>(<span class="kw-2">mut </span><span class="self">self</span>, name: S) -> <span class="self">Self </span>{ |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>als) = <span class="self">self</span>.p.meta.aliases { |
| als.push((name.into(), <span class="bool-val">true</span>)); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.p.meta.aliases = <span class="prelude-val">Some</span>(<span class="macro">vec!</span>[(name.into(), <span class="bool-val">true</span>)]); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Allows adding multiple [`SubCommand`] aliases that functions exactly like those defined |
| /// with [`App::aliases`], except that they are visible inside the help message. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, SubCommand}; |
| /// let m = App::new("myprog") |
| /// .subcommand(SubCommand::with_name("test") |
| /// .visible_aliases(&["do-stuff", "tests"])) |
| /// .get_matches_from(vec!["myprog", "do-stuff"]); |
| /// assert_eq!(m.subcommand_name(), Some("test")); |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`App::aliases`]: ./struct.App.html#method.aliases |
| </span><span class="kw">pub fn </span>visible_aliases(<span class="kw-2">mut </span><span class="self">self</span>, names: <span class="kw-2">&</span>[<span class="kw-2">&</span><span class="lifetime">'b </span>str]) -> <span class="self">Self </span>{ |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>als) = <span class="self">self</span>.p.meta.aliases { |
| <span class="kw">for </span>n <span class="kw">in </span>names { |
| als.push((n, <span class="bool-val">true</span>)); |
| } |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.p.meta.aliases = <span class="prelude-val">Some</span>(names.iter().map(|n| (<span class="kw-2">*</span>n, <span class="bool-val">true</span>)).collect::<Vec<<span class="kw">_</span>>>()); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Adds an [`ArgGroup`] to the application. [`ArgGroup`]s are a family of related arguments. |
| /// By placing them in a logical group, you can build easier requirement and exclusion rules. |
| /// For instance, you can make an entire [`ArgGroup`] required, meaning that one (and *only* |
| /// one) argument from that group must be present at runtime. |
| /// |
| /// You can also do things such as name an [`ArgGroup`] as a conflict to another argument. |
| /// Meaning any of the arguments that belong to that group will cause a failure if present with |
| /// the conflicting argument. |
| /// |
| /// Another added benefit of [`ArgGroup`]s is that you can extract a value from a group instead |
| /// of determining exactly which argument was used. |
| /// |
| /// Finally, using [`ArgGroup`]s to ensure exclusion between arguments is another very common |
| /// use |
| /// |
| /// # Examples |
| /// |
| /// The following example demonstrates using an [`ArgGroup`] to ensure that one, and only one, |
| /// of the arguments from the specified group is present at runtime. |
| /// |
| /// ```no_run |
| /// # use clap::{App, ArgGroup}; |
| /// App::new("app") |
| /// .args_from_usage( |
| /// "--set-ver [ver] 'set the version manually' |
| /// --major 'auto increase major' |
| /// --minor 'auto increase minor' |
| /// --patch 'auto increase patch'") |
| /// .group(ArgGroup::with_name("vers") |
| /// .args(&["set-ver", "major", "minor","patch"]) |
| /// .required(true)) |
| /// # ; |
| /// ``` |
| /// [`ArgGroup`]: ./struct.ArgGroup.html |
| </span><span class="kw">pub fn </span>group(<span class="kw-2">mut </span><span class="self">self</span>, group: ArgGroup<<span class="lifetime">'a</span>>) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.add_group(group); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Adds multiple [`ArgGroup`]s to the [`App`] at once. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, ArgGroup}; |
| /// App::new("app") |
| /// .args_from_usage( |
| /// "--set-ver [ver] 'set the version manually' |
| /// --major 'auto increase major' |
| /// --minor 'auto increase minor' |
| /// --patch 'auto increase patch' |
| /// -c [FILE] 'a config file' |
| /// -i [IFACE] 'an interface'") |
| /// .groups(&[ |
| /// ArgGroup::with_name("vers") |
| /// .args(&["set-ver", "major", "minor","patch"]) |
| /// .required(true), |
| /// ArgGroup::with_name("input") |
| /// .args(&["c", "i"]) |
| /// ]) |
| /// # ; |
| /// ``` |
| /// [`ArgGroup`]: ./struct.ArgGroup.html |
| /// [`App`]: ./struct.App.html |
| </span><span class="kw">pub fn </span>groups(<span class="kw-2">mut </span><span class="self">self</span>, groups: <span class="kw-2">&</span>[ArgGroup<<span class="lifetime">'a</span>>]) -> <span class="self">Self </span>{ |
| <span class="kw">for </span>g <span class="kw">in </span>groups { |
| <span class="self">self </span>= <span class="self">self</span>.group(g.into()); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Adds a [`SubCommand`] to the list of valid possibilities. Subcommands are effectively |
| /// sub-[`App`]s, because they can contain their own arguments, subcommands, version, usage, |
| /// etc. They also function just like [`App`]s, in that they get their own auto generated help, |
| /// version, and usage. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg, SubCommand}; |
| /// App::new("myprog") |
| /// .subcommand(SubCommand::with_name("config") |
| /// .about("Controls configuration features") |
| /// .arg_from_usage("<config> 'Required configuration file to use'")) |
| /// # ; |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`App`]: ./struct.App.html |
| </span><span class="kw">pub fn </span>subcommand(<span class="kw-2">mut </span><span class="self">self</span>, subcmd: App<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.add_subcommand(subcmd); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Adds multiple subcommands to the list of valid possibilities by iterating over an |
| /// [`IntoIterator`] of [`SubCommand`]s |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, SubCommand}; |
| /// # App::new("myprog") |
| /// .subcommands( vec![ |
| /// SubCommand::with_name("config").about("Controls configuration functionality") |
| /// .arg(Arg::with_name("config_file").index(1)), |
| /// SubCommand::with_name("debug").about("Controls debug functionality")]) |
| /// # ; |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`IntoIterator`]: https://doc.rust-lang.org/std/iter/trait.IntoIterator.html |
| </span><span class="kw">pub fn </span>subcommands<I>(<span class="kw-2">mut </span><span class="self">self</span>, subcmds: I) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>I: IntoIterator<Item = App<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>>, |
| { |
| <span class="kw">for </span>subcmd <span class="kw">in </span>subcmds { |
| <span class="self">self</span>.p.add_subcommand(subcmd); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Allows custom ordering of [`SubCommand`]s within the help message. Subcommands with a lower |
| /// value will be displayed first in the help message. This is helpful when one would like to |
| /// emphasise frequently used subcommands, or prioritize those towards the top of the list. |
| /// Duplicate values **are** allowed. Subcommands with duplicate display orders will be |
| /// displayed in alphabetical order. |
| /// |
| /// **NOTE:** The default is 999 for all subcommands. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, SubCommand}; |
| /// let m = App::new("cust-ord") |
| /// .subcommand(SubCommand::with_name("alpha") // typically subcommands are grouped |
| /// // alphabetically by name. Subcommands |
| /// // without a display_order have a value of |
| /// // 999 and are displayed alphabetically with |
| /// // all other 999 subcommands |
| /// .about("Some help and text")) |
| /// .subcommand(SubCommand::with_name("beta") |
| /// .display_order(1) // In order to force this subcommand to appear *first* |
| /// // all we have to do is give it a value lower than 999. |
| /// // Any other subcommands with a value of 1 will be displayed |
| /// // alphabetically with this one...then 2 values, then 3, etc. |
| /// .about("I should be first!")) |
| /// .get_matches_from(vec![ |
| /// "cust-ord", "--help" |
| /// ]); |
| /// ``` |
| /// |
| /// The above example displays the following help message |
| /// |
| /// ```text |
| /// cust-ord |
| /// |
| /// USAGE: |
| /// cust-ord [FLAGS] [OPTIONS] |
| /// |
| /// FLAGS: |
| /// -h, --help Prints help information |
| /// -V, --version Prints version information |
| /// |
| /// SUBCOMMANDS: |
| /// beta I should be first! |
| /// alpha Some help and text |
| /// ``` |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| </span><span class="kw">pub fn </span>display_order(<span class="kw-2">mut </span><span class="self">self</span>, ord: usize) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.p.meta.disp_ord = ord; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Prints the full help message to [`io::stdout()`] using a [`BufWriter`] using the same |
| /// method as if someone ran `-h` to request the help message |
| /// |
| /// **NOTE:** clap has the ability to distinguish between "short" and "long" help messages |
| /// depending on if the user ran [`-h` (short)] or [`--help` (long)] |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::App; |
| /// let mut app = App::new("myprog"); |
| /// app.print_help(); |
| /// ``` |
| /// [`io::stdout()`]: https://doc.rust-lang.org/std/io/fn.stdout.html |
| /// [`BufWriter`]: https://doc.rust-lang.org/std/io/struct.BufWriter.html |
| /// [`-h` (short)]: ./struct.Arg.html#method.help |
| /// [`--help` (long)]: ./struct.Arg.html#method.long_help |
| </span><span class="kw">pub fn </span>print_help(<span class="kw-2">&mut </span><span class="self">self</span>) -> ClapResult<()> { |
| <span class="comment">// If there are global arguments, or settings we need to propagate them down to subcommands |
| // before parsing incase we run into a subcommand |
| </span><span class="self">self</span>.p.propagate_globals(); |
| <span class="self">self</span>.p.propagate_settings(); |
| <span class="self">self</span>.p.derive_display_order(); |
| |
| <span class="self">self</span>.p.create_help_and_version(); |
| <span class="kw">let </span>out = io::stdout(); |
| <span class="kw">let </span><span class="kw-2">mut </span>buf_w = BufWriter::new(out.lock()); |
| <span class="self">self</span>.write_help(<span class="kw-2">&mut </span>buf_w) |
| } |
| |
| <span class="doccomment">/// Prints the full help message to [`io::stdout()`] using a [`BufWriter`] using the same |
| /// method as if someone ran `--help` to request the help message |
| /// |
| /// **NOTE:** clap has the ability to distinguish between "short" and "long" help messages |
| /// depending on if the user ran [`-h` (short)] or [`--help` (long)] |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::App; |
| /// let mut app = App::new("myprog"); |
| /// app.print_long_help(); |
| /// ``` |
| /// [`io::stdout()`]: https://doc.rust-lang.org/std/io/fn.stdout.html |
| /// [`BufWriter`]: https://doc.rust-lang.org/std/io/struct.BufWriter.html |
| /// [`-h` (short)]: ./struct.Arg.html#method.help |
| /// [`--help` (long)]: ./struct.Arg.html#method.long_help |
| </span><span class="kw">pub fn </span>print_long_help(<span class="kw-2">&mut </span><span class="self">self</span>) -> ClapResult<()> { |
| <span class="kw">let </span>out = io::stdout(); |
| <span class="kw">let </span><span class="kw-2">mut </span>buf_w = BufWriter::new(out.lock()); |
| <span class="self">self</span>.write_long_help(<span class="kw-2">&mut </span>buf_w) |
| } |
| |
| <span class="doccomment">/// Writes the full help message to the user to a [`io::Write`] object in the same method as if |
| /// the user ran `-h` |
| /// |
| /// **NOTE:** clap has the ability to distinguish between "short" and "long" help messages |
| /// depending on if the user ran [`-h` (short)] or [`--help` (long)] |
| /// |
| /// **NOTE:** There is a known bug where this method does not write propagated global arguments |
| /// or autogenerated arguments (i.e. the default help/version args). Prefer |
| /// [`App::write_long_help`] instead if possible! |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::App; |
| /// use std::io; |
| /// let mut app = App::new("myprog"); |
| /// let mut out = io::stdout(); |
| /// app.write_help(&mut out).expect("failed to write to stdout"); |
| /// ``` |
| /// [`io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html |
| /// [`-h` (short)]: ./struct.Arg.html#method.help |
| /// [`--help` (long)]: ./struct.Arg.html#method.long_help |
| </span><span class="kw">pub fn </span>write_help<W: Write>(<span class="kw-2">&</span><span class="self">self</span>, w: <span class="kw-2">&mut </span>W) -> ClapResult<()> { |
| <span class="comment">// PENDING ISSUE: 808 |
| // https://github.com/clap-rs/clap/issues/808 |
| // If there are global arguments, or settings we need to propagate them down to subcommands |
| // before parsing incase we run into a subcommand |
| // self.p.propagate_globals(); |
| // self.p.propagate_settings(); |
| // self.p.derive_display_order(); |
| // self.p.create_help_and_version(); |
| |
| </span>Help::write_app_help(w, <span class="self">self</span>, <span class="bool-val">false</span>) |
| } |
| |
| <span class="doccomment">/// Writes the full help message to the user to a [`io::Write`] object in the same method as if |
| /// the user ran `--help` |
| /// |
| /// **NOTE:** clap has the ability to distinguish between "short" and "long" help messages |
| /// depending on if the user ran [`-h` (short)] or [`--help` (long)] |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::App; |
| /// use std::io; |
| /// let mut app = App::new("myprog"); |
| /// let mut out = io::stdout(); |
| /// app.write_long_help(&mut out).expect("failed to write to stdout"); |
| /// ``` |
| /// [`io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html |
| /// [`-h` (short)]: ./struct.Arg.html#method.help |
| /// [`--help` (long)]: ./struct.Arg.html#method.long_help |
| </span><span class="kw">pub fn </span>write_long_help<W: Write>(<span class="kw-2">&mut </span><span class="self">self</span>, w: <span class="kw-2">&mut </span>W) -> ClapResult<()> { |
| <span class="comment">// If there are global arguments, or settings we need to propagate them down to subcommands |
| // before parsing incase we run into a subcommand |
| </span><span class="self">self</span>.p.propagate_globals(); |
| <span class="self">self</span>.p.propagate_settings(); |
| <span class="self">self</span>.p.derive_display_order(); |
| <span class="self">self</span>.p.create_help_and_version(); |
| |
| Help::write_app_help(w, <span class="self">self</span>, <span class="bool-val">true</span>) |
| } |
| |
| <span class="doccomment">/// Writes the version message to the user to a [`io::Write`] object as if the user ran `-V`. |
| /// |
| /// **NOTE:** clap has the ability to distinguish between "short" and "long" version messages |
| /// depending on if the user ran [`-V` (short)] or [`--version` (long)] |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::App; |
| /// use std::io; |
| /// let mut app = App::new("myprog"); |
| /// let mut out = io::stdout(); |
| /// app.write_version(&mut out).expect("failed to write to stdout"); |
| /// ``` |
| /// [`io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html |
| /// [`-V` (short)]: ./struct.App.html#method.version |
| /// [`--version` (long)]: ./struct.App.html#method.long_version |
| </span><span class="kw">pub fn </span>write_version<W: Write>(<span class="kw-2">&</span><span class="self">self</span>, w: <span class="kw-2">&mut </span>W) -> ClapResult<()> { |
| <span class="self">self</span>.p.write_version(w, <span class="bool-val">false</span>).map_err(From::from) |
| } |
| |
| <span class="doccomment">/// Writes the version message to the user to a [`io::Write`] object |
| /// |
| /// **NOTE:** clap has the ability to distinguish between "short" and "long" version messages |
| /// depending on if the user ran [`-V` (short)] or [`--version` (long)] |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::App; |
| /// use std::io; |
| /// let mut app = App::new("myprog"); |
| /// let mut out = io::stdout(); |
| /// app.write_long_version(&mut out).expect("failed to write to stdout"); |
| /// ``` |
| /// [`io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html |
| /// [`-V` (short)]: ./struct.App.html#method.version |
| /// [`--version` (long)]: ./struct.App.html#method.long_version |
| </span><span class="kw">pub fn </span>write_long_version<W: Write>(<span class="kw-2">&</span><span class="self">self</span>, w: <span class="kw-2">&mut </span>W) -> ClapResult<()> { |
| <span class="self">self</span>.p.write_version(w, <span class="bool-val">true</span>).map_err(From::from) |
| } |
| |
| <span class="doccomment">/// Generate a completions file for a specified shell at compile time. |
| /// |
| /// **NOTE:** to generate the file at compile time you must use a `build.rs` "Build Script" |
| /// |
| /// # Examples |
| /// |
| /// The following example generates a bash completion script via a `build.rs` script. In this |
| /// simple example, we'll demo a very small application with only a single subcommand and two |
| /// args. Real applications could be many multiple levels deep in subcommands, and have tens or |
| /// potentially hundreds of arguments. |
| /// |
| /// First, it helps if we separate out our `App` definition into a separate file. Whether you |
| /// do this as a function, or bare App definition is a matter of personal preference. |
| /// |
| /// ``` |
| /// // src/cli.rs |
| /// |
| /// use clap::{App, Arg, SubCommand}; |
| /// |
| /// pub fn build_cli() -> App<'static, 'static> { |
| /// App::new("compl") |
| /// .about("Tests completions") |
| /// .arg(Arg::with_name("file") |
| /// .help("some input file")) |
| /// .subcommand(SubCommand::with_name("test") |
| /// .about("tests things") |
| /// .arg(Arg::with_name("case") |
| /// .long("case") |
| /// .takes_value(true) |
| /// .help("the case to test"))) |
| /// } |
| /// ``` |
| /// |
| /// In our regular code, we can simply call this `build_cli()` function, then call |
| /// `get_matches()`, or any of the other normal methods directly after. For example: |
| /// |
| /// ```ignore |
| /// // src/main.rs |
| /// |
| /// mod cli; |
| /// |
| /// fn main() { |
| /// let m = cli::build_cli().get_matches(); |
| /// |
| /// // normal logic continues... |
| /// } |
| /// ``` |
| /// |
| /// Next, we set up our `Cargo.toml` to use a `build.rs` build script. |
| /// |
| /// ```toml |
| /// # Cargo.toml |
| /// build = "build.rs" |
| /// |
| /// [build-dependencies] |
| /// clap = "2.23" |
| /// ``` |
| /// |
| /// Next, we place a `build.rs` in our project root. |
| /// |
| /// ```ignore |
| /// extern crate clap; |
| /// |
| /// use clap::Shell; |
| /// |
| /// include!("src/cli.rs"); |
| /// |
| /// fn main() { |
| /// let outdir = match env::var_os("OUT_DIR") { |
| /// None => return, |
| /// Some(outdir) => outdir, |
| /// }; |
| /// let mut app = build_cli(); |
| /// app.gen_completions("myapp", // We need to specify the bin name manually |
| /// Shell::Bash, // Then say which shell to build completions for |
| /// outdir); // Then say where write the completions to |
| /// } |
| /// ``` |
| /// Now, once we compile there will be a `{bin_name}.bash` file in the directory. |
| /// Assuming we compiled with debug mode, it would be somewhere similar to |
| /// `<project>/target/debug/build/myapp-<hash>/out/myapp.bash`. |
| /// |
| /// Fish shell completions will use the file format `{bin_name}.fish` |
| </span><span class="kw">pub fn </span>gen_completions<T: Into<OsString>, S: Into<String>>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| bin_name: S, |
| for_shell: Shell, |
| out_dir: T, |
| ) { |
| <span class="self">self</span>.p.meta.bin_name = <span class="prelude-val">Some</span>(bin_name.into()); |
| <span class="self">self</span>.p.gen_completions(for_shell, out_dir.into()); |
| } |
| |
| <span class="doccomment">/// Generate a completions file for a specified shell at runtime. Until `cargo install` can |
| /// install extra files like a completion script, this may be used e.g. in a command that |
| /// outputs the contents of the completion script, to be redirected into a file by the user. |
| /// |
| /// # Examples |
| /// |
| /// Assuming a separate `cli.rs` like the [example above](./struct.App.html#method.gen_completions), |
| /// we can let users generate a completion script using a command: |
| /// |
| /// ```ignore |
| /// // src/main.rs |
| /// |
| /// mod cli; |
| /// use std::io; |
| /// |
| /// fn main() { |
| /// let matches = cli::build_cli().get_matches(); |
| /// |
| /// if matches.is_present("generate-bash-completions") { |
| /// cli::build_cli().gen_completions_to("myapp", Shell::Bash, &mut io::stdout()); |
| /// } |
| /// |
| /// // normal logic continues... |
| /// } |
| /// |
| /// ``` |
| /// |
| /// Usage: |
| /// |
| /// ```shell |
| /// $ myapp generate-bash-completions > /usr/share/bash-completion/completions/myapp.bash |
| /// ``` |
| </span><span class="kw">pub fn </span>gen_completions_to<W: Write, S: Into<String>>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| bin_name: S, |
| for_shell: Shell, |
| buf: <span class="kw-2">&mut </span>W, |
| ) { |
| <span class="self">self</span>.p.meta.bin_name = <span class="prelude-val">Some</span>(bin_name.into()); |
| <span class="self">self</span>.p.gen_completions_to(for_shell, buf); |
| } |
| |
| <span class="doccomment">/// Starts the parsing process, upon a failed parse an error will be displayed to the user and |
| /// the process will exit with the appropriate error code. By default this method gets all user |
| /// provided arguments from [`env::args_os`] in order to allow for invalid UTF-8 code points, |
| /// which are legal on many platforms. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// let matches = App::new("myprog") |
| /// // Args and options go here... |
| /// .get_matches(); |
| /// ``` |
| /// [`env::args_os`]: https://doc.rust-lang.org/std/env/fn.args_os.html |
| </span><span class="kw">pub fn </span>get_matches(<span class="self">self</span>) -> ArgMatches<<span class="lifetime">'a</span>> { |
| <span class="self">self</span>.get_matches_from(<span class="kw-2">&mut </span>env::args_os()) |
| } |
| |
| <span class="doccomment">/// Starts the parsing process. This method will return a [`clap::Result`] type instead of exiting |
| /// the process on failed parse. By default this method gets matches from [`env::args_os`] |
| /// |
| /// **NOTE:** This method WILL NOT exit when `--help` or `--version` (or short versions) are |
| /// used. It will return a [`clap::Error`], where the [`kind`] is a |
| /// [`ErrorKind::HelpDisplayed`] or [`ErrorKind::VersionDisplayed`] respectively. You must call |
| /// [`Error::exit`] or perform a [`std::process::exit`]. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// let matches = App::new("myprog") |
| /// // Args and options go here... |
| /// .get_matches_safe() |
| /// .unwrap_or_else( |e| e.exit() ); |
| /// ``` |
| /// [`env::args_os`]: https://doc.rust-lang.org/std/env/fn.args_os.html |
| /// [`ErrorKind::HelpDisplayed`]: ./enum.ErrorKind.html#variant.HelpDisplayed |
| /// [`ErrorKind::VersionDisplayed`]: ./enum.ErrorKind.html#variant.VersionDisplayed |
| /// [`Error::exit`]: ./struct.Error.html#method.exit |
| /// [`std::process::exit`]: https://doc.rust-lang.org/std/process/fn.exit.html |
| /// [`clap::Result`]: ./type.Result.html |
| /// [`clap::Error`]: ./struct.Error.html |
| /// [`kind`]: ./struct.Error.html |
| </span><span class="kw">pub fn </span>get_matches_safe(<span class="self">self</span>) -> ClapResult<ArgMatches<<span class="lifetime">'a</span>>> { |
| <span class="comment">// Start the parsing |
| </span><span class="self">self</span>.get_matches_from_safe(<span class="kw-2">&mut </span>env::args_os()) |
| } |
| |
| <span class="doccomment">/// Starts the parsing process. Like [`App::get_matches`] this method does not return a [`clap::Result`] |
| /// and will automatically exit with an error message. This method, however, lets you specify |
| /// what iterator to use when performing matches, such as a [`Vec`] of your making. |
| /// |
| /// **NOTE:** The first argument will be parsed as the binary name unless |
| /// [`AppSettings::NoBinaryName`] is used |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// let arg_vec = vec!["my_prog", "some", "args", "to", "parse"]; |
| /// |
| /// let matches = App::new("myprog") |
| /// // Args and options go here... |
| /// .get_matches_from(arg_vec); |
| /// ``` |
| /// [`App::get_matches`]: ./struct.App.html#method.get_matches |
| /// [`clap::Result`]: ./type.Result.html |
| /// [`Vec`]: https://doc.rust-lang.org/std/vec/struct.Vec.html |
| /// [`AppSettings::NoBinaryName`]: ./enum.AppSettings.html#variant.NoBinaryName |
| </span><span class="kw">pub fn </span>get_matches_from<I, T>(<span class="kw-2">mut </span><span class="self">self</span>, itr: I) -> ArgMatches<<span class="lifetime">'a</span>> |
| <span class="kw">where |
| </span>I: IntoIterator<Item = T>, |
| T: Into<OsString> + Clone, |
| { |
| <span class="self">self</span>.get_matches_from_safe_borrow(itr).unwrap_or_else(|e| { |
| <span class="comment">// Otherwise, write to stderr and exit |
| </span><span class="kw">if </span>e.use_stderr() { |
| <span class="macro">wlnerr!</span>(<span class="string">"{}"</span>, e.message); |
| <span class="kw">if </span><span class="self">self</span>.p.is_set(AppSettings::WaitOnError) { |
| <span class="macro">wlnerr!</span>(<span class="string">"\nPress [ENTER] / [RETURN] to continue..."</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>s = String::new(); |
| <span class="kw">let </span>i = io::stdin(); |
| i.lock().read_line(<span class="kw-2">&mut </span>s).unwrap(); |
| } |
| drop(<span class="self">self</span>); |
| drop(e); |
| process::exit(<span class="number">1</span>); |
| } |
| |
| drop(<span class="self">self</span>); |
| e.exit() |
| }) |
| } |
| |
| <span class="doccomment">/// Starts the parsing process. A combination of [`App::get_matches_from`], and |
| /// [`App::get_matches_safe`] |
| /// |
| /// **NOTE:** This method WILL NOT exit when `--help` or `--version` (or short versions) are |
| /// used. It will return a [`clap::Error`], where the [`kind`] is a [`ErrorKind::HelpDisplayed`] |
| /// or [`ErrorKind::VersionDisplayed`] respectively. You must call [`Error::exit`] or |
| /// perform a [`std::process::exit`] yourself. |
| /// |
| /// **NOTE:** The first argument will be parsed as the binary name unless |
| /// [`AppSettings::NoBinaryName`] is used |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// let arg_vec = vec!["my_prog", "some", "args", "to", "parse"]; |
| /// |
| /// let matches = App::new("myprog") |
| /// // Args and options go here... |
| /// .get_matches_from_safe(arg_vec) |
| /// .unwrap_or_else( |e| { panic!("An error occurs: {}", e) }); |
| /// ``` |
| /// [`App::get_matches_from`]: ./struct.App.html#method.get_matches_from |
| /// [`App::get_matches_safe`]: ./struct.App.html#method.get_matches_safe |
| /// [`ErrorKind::HelpDisplayed`]: ./enum.ErrorKind.html#variant.HelpDisplayed |
| /// [`ErrorKind::VersionDisplayed`]: ./enum.ErrorKind.html#variant.VersionDisplayed |
| /// [`Error::exit`]: ./struct.Error.html#method.exit |
| /// [`std::process::exit`]: https://doc.rust-lang.org/std/process/fn.exit.html |
| /// [`clap::Error`]: ./struct.Error.html |
| /// [`Error::exit`]: ./struct.Error.html#method.exit |
| /// [`kind`]: ./struct.Error.html |
| /// [`AppSettings::NoBinaryName`]: ./enum.AppSettings.html#variant.NoBinaryName |
| </span><span class="kw">pub fn </span>get_matches_from_safe<I, T>(<span class="kw-2">mut </span><span class="self">self</span>, itr: I) -> ClapResult<ArgMatches<<span class="lifetime">'a</span>>> |
| <span class="kw">where |
| </span>I: IntoIterator<Item = T>, |
| T: Into<OsString> + Clone, |
| { |
| <span class="self">self</span>.get_matches_from_safe_borrow(itr) |
| } |
| |
| <span class="doccomment">/// Starts the parsing process without consuming the [`App`] struct `self`. This is normally not |
| /// the desired functionality, instead prefer [`App::get_matches_from_safe`] which *does* |
| /// consume `self`. |
| /// |
| /// **NOTE:** The first argument will be parsed as the binary name unless |
| /// [`AppSettings::NoBinaryName`] is used |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// # use clap::{App, Arg}; |
| /// let arg_vec = vec!["my_prog", "some", "args", "to", "parse"]; |
| /// |
| /// let mut app = App::new("myprog"); |
| /// // Args and options go here... |
| /// let matches = app.get_matches_from_safe_borrow(arg_vec) |
| /// .unwrap_or_else( |e| { panic!("An error occurs: {}", e) }); |
| /// ``` |
| /// [`App`]: ./struct.App.html |
| /// [`App::get_matches_from_safe`]: ./struct.App.html#method.get_matches_from_safe |
| /// [`AppSettings::NoBinaryName`]: ./enum.AppSettings.html#variant.NoBinaryName |
| </span><span class="kw">pub fn </span>get_matches_from_safe_borrow<I, T>(<span class="kw-2">&mut </span><span class="self">self</span>, itr: I) -> ClapResult<ArgMatches<<span class="lifetime">'a</span>>> |
| <span class="kw">where |
| </span>I: IntoIterator<Item = T>, |
| T: Into<OsString> + Clone, |
| { |
| <span class="comment">// If there are global arguments, or settings we need to propagate them down to subcommands |
| // before parsing incase we run into a subcommand |
| </span><span class="kw">if </span>!<span class="self">self</span>.p.is_set(AppSettings::Propagated) { |
| <span class="self">self</span>.p.propagate_globals(); |
| <span class="self">self</span>.p.propagate_settings(); |
| <span class="self">self</span>.p.derive_display_order(); |
| <span class="self">self</span>.p.set(AppSettings::Propagated); |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>matcher = ArgMatcher::new(); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>it = itr.into_iter(); |
| <span class="comment">// Get the name of the program (argument 1 of env::args()) and determine the |
| // actual file |
| // that was used to execute the program. This is because a program called |
| // ./target/release/my_prog -a |
| // will have two arguments, './target/release/my_prog', '-a' but we don't want |
| // to display |
| // the full path when displaying help messages and such |
| </span><span class="kw">if </span>!<span class="self">self</span>.p.is_set(AppSettings::NoBinaryName) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(name) = it.next() { |
| <span class="kw">let </span>bn_os = name.into(); |
| <span class="kw">let </span>p = Path::new(<span class="kw-2">&*</span>bn_os); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(f) = p.file_name() { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(s) = f.to_os_string().to_str() { |
| <span class="kw">if </span><span class="self">self</span>.p.meta.bin_name.is_none() { |
| <span class="self">self</span>.p.meta.bin_name = <span class="prelude-val">Some</span>(s.to_owned()); |
| } |
| } |
| } |
| } |
| } |
| |
| <span class="comment">// do the real parsing |
| </span><span class="kw">if let </span><span class="prelude-val">Err</span>(e) = <span class="self">self</span>.p.get_matches_with(<span class="kw-2">&mut </span>matcher, <span class="kw-2">&mut </span>it.peekable()) { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| |
| <span class="kw">let </span>global_arg_vec: Vec<<span class="kw-2">&</span>str> = <span class="self">self</span>.p.global_args.iter().map(|ga| ga.b.name).collect(); |
| matcher.propagate_globals(<span class="kw-2">&</span>global_arg_vec); |
| |
| <span class="prelude-val">Ok</span>(matcher.into()) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"yaml"</span>)] |
| </span><span class="kw">impl</span><<span class="lifetime">'a</span>> From<<span class="kw-2">&</span><span class="lifetime">'a </span>Yaml> <span class="kw">for </span>App<<span class="lifetime">'a</span>, <span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>from(<span class="kw-2">mut </span>yaml: <span class="kw-2">&</span><span class="lifetime">'a </span>Yaml) -> <span class="self">Self </span>{ |
| <span class="kw">use </span><span class="kw">crate</span>::args::SubCommand; |
| <span class="comment">// We WANT this to panic on error...so expect() is good. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>is_sc = <span class="prelude-val">None</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>a = <span class="kw">if let </span><span class="prelude-val">Some</span>(name) = yaml[<span class="string">"name"</span>].as_str() { |
| App::new(name) |
| } <span class="kw">else </span>{ |
| <span class="kw">let </span>yaml_hash = yaml.as_hash().unwrap(); |
| <span class="kw">let </span>sc_key = yaml_hash.keys().nth(<span class="number">0</span>).unwrap(); |
| is_sc = <span class="prelude-val">Some</span>(yaml_hash.get(sc_key).unwrap()); |
| App::new(sc_key.as_str().unwrap()) |
| }; |
| yaml = <span class="kw">if let </span><span class="prelude-val">Some</span>(sc) = is_sc { sc } <span class="kw">else </span>{ yaml }; |
| |
| <span class="macro">macro_rules! </span>yaml_str { |
| (<span class="macro-nonterminal">$a</span>:ident, <span class="macro-nonterminal">$y</span>:ident, <span class="macro-nonterminal">$i</span>:ident) => { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = <span class="macro-nonterminal">$y</span>[<span class="macro">stringify!</span>(<span class="macro-nonterminal">$i</span>)].as_str() { |
| <span class="macro-nonterminal">$a </span>= <span class="macro-nonterminal">$a</span>.<span class="macro-nonterminal">$i</span>(v); |
| } <span class="kw">else if </span><span class="macro-nonterminal">$y</span>[<span class="macro">stringify!</span>(<span class="macro-nonterminal">$i</span>)] != Yaml::BadValue { |
| <span class="macro">panic!</span>( |
| <span class="string">"Failed to convert YAML value {:?} to a string"</span>, |
| <span class="macro-nonterminal">$y</span>[<span class="macro">stringify!</span>(<span class="macro-nonterminal">$i</span>)] |
| ); |
| } |
| }; |
| } |
| |
| <span class="macro">yaml_str!</span>(a, yaml, version); |
| <span class="macro">yaml_str!</span>(a, yaml, long_version); |
| <span class="macro">yaml_str!</span>(a, yaml, author); |
| <span class="macro">yaml_str!</span>(a, yaml, bin_name); |
| <span class="macro">yaml_str!</span>(a, yaml, about); |
| <span class="macro">yaml_str!</span>(a, yaml, long_about); |
| <span class="macro">yaml_str!</span>(a, yaml, before_help); |
| <span class="macro">yaml_str!</span>(a, yaml, after_help); |
| <span class="macro">yaml_str!</span>(a, yaml, template); |
| <span class="macro">yaml_str!</span>(a, yaml, usage); |
| <span class="macro">yaml_str!</span>(a, yaml, help); |
| <span class="macro">yaml_str!</span>(a, yaml, help_short); |
| <span class="macro">yaml_str!</span>(a, yaml, version_short); |
| <span class="macro">yaml_str!</span>(a, yaml, help_message); |
| <span class="macro">yaml_str!</span>(a, yaml, version_message); |
| <span class="macro">yaml_str!</span>(a, yaml, alias); |
| <span class="macro">yaml_str!</span>(a, yaml, visible_alias); |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = yaml[<span class="string">"display_order"</span>].as_i64() { |
| a = a.display_order(v <span class="kw">as </span>usize); |
| } <span class="kw">else if </span>yaml[<span class="string">"display_order"</span>] != Yaml::BadValue { |
| <span class="macro">panic!</span>( |
| <span class="string">"Failed to convert YAML value {:?} to a u64"</span>, |
| yaml[<span class="string">"display_order"</span>] |
| ); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = yaml[<span class="string">"setting"</span>].as_str() { |
| a = a.setting(v.parse().expect(<span class="string">"unknown AppSetting found in YAML file"</span>)); |
| } <span class="kw">else if </span>yaml[<span class="string">"setting"</span>] != Yaml::BadValue { |
| <span class="macro">panic!</span>( |
| <span class="string">"Failed to convert YAML value {:?} to an AppSetting"</span>, |
| yaml[<span class="string">"setting"</span>] |
| ); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = yaml[<span class="string">"settings"</span>].as_vec() { |
| <span class="kw">for </span>ys <span class="kw">in </span>v { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(s) = ys.as_str() { |
| a = a.setting(s.parse().expect(<span class="string">"unknown AppSetting found in YAML file"</span>)); |
| } |
| } |
| } <span class="kw">else if let </span><span class="prelude-val">Some</span>(v) = yaml[<span class="string">"settings"</span>].as_str() { |
| a = a.setting(v.parse().expect(<span class="string">"unknown AppSetting found in YAML file"</span>)); |
| } <span class="kw">else if </span>yaml[<span class="string">"settings"</span>] != Yaml::BadValue { |
| <span class="macro">panic!</span>( |
| <span class="string">"Failed to convert YAML value {:?} to a string"</span>, |
| yaml[<span class="string">"settings"</span>] |
| ); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = yaml[<span class="string">"global_setting"</span>].as_str() { |
| a = a.setting(v.parse().expect(<span class="string">"unknown AppSetting found in YAML file"</span>)); |
| } <span class="kw">else if </span>yaml[<span class="string">"global_setting"</span>] != Yaml::BadValue { |
| <span class="macro">panic!</span>( |
| <span class="string">"Failed to convert YAML value {:?} to an AppSetting"</span>, |
| yaml[<span class="string">"setting"</span>] |
| ); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = yaml[<span class="string">"global_settings"</span>].as_vec() { |
| <span class="kw">for </span>ys <span class="kw">in </span>v { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(s) = ys.as_str() { |
| a = a.global_setting(s.parse().expect(<span class="string">"unknown AppSetting found in YAML file"</span>)); |
| } |
| } |
| } <span class="kw">else if let </span><span class="prelude-val">Some</span>(v) = yaml[<span class="string">"global_settings"</span>].as_str() { |
| a = a.global_setting(v.parse().expect(<span class="string">"unknown AppSetting found in YAML file"</span>)); |
| } <span class="kw">else if </span>yaml[<span class="string">"global_settings"</span>] != Yaml::BadValue { |
| <span class="macro">panic!</span>( |
| <span class="string">"Failed to convert YAML value {:?} to a string"</span>, |
| yaml[<span class="string">"global_settings"</span>] |
| ); |
| } |
| |
| <span class="macro">macro_rules! </span>vec_or_str { |
| (<span class="macro-nonterminal">$a</span>:ident, <span class="macro-nonterminal">$y</span>:ident, <span class="macro-nonterminal">$as_vec</span>:ident, <span class="macro-nonterminal">$as_single</span>:ident) => {{ |
| <span class="kw">let </span>maybe_vec = <span class="macro-nonterminal">$y</span>[<span class="macro">stringify!</span>(<span class="macro-nonterminal">$as_vec</span>)].as_vec(); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(vec) = maybe_vec { |
| <span class="kw">for </span>ys <span class="kw">in </span>vec { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(s) = ys.as_str() { |
| <span class="macro-nonterminal">$a </span>= <span class="macro-nonterminal">$a</span>.<span class="macro-nonterminal">$as_single</span>(s); |
| } <span class="kw">else </span>{ |
| <span class="macro">panic!</span>(<span class="string">"Failed to convert YAML value {:?} to a string"</span>, ys); |
| } |
| } |
| } <span class="kw">else </span>{ |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(s) = <span class="macro-nonterminal">$y</span>[<span class="macro">stringify!</span>(<span class="macro-nonterminal">$as_vec</span>)].as_str() { |
| <span class="macro-nonterminal">$a </span>= <span class="macro-nonterminal">$a</span>.<span class="macro-nonterminal">$as_single</span>(s); |
| } <span class="kw">else if </span><span class="macro-nonterminal">$y</span>[<span class="macro">stringify!</span>(<span class="macro-nonterminal">$as_vec</span>)] != Yaml::BadValue { |
| <span class="macro">panic!</span>( |
| <span class="string">"Failed to convert YAML value {:?} to either a vec or string"</span>, |
| <span class="macro-nonterminal">$y</span>[<span class="macro">stringify!</span>(<span class="macro-nonterminal">$as_vec</span>)] |
| ); |
| } |
| } |
| <span class="macro-nonterminal">$a |
| </span>}}; |
| } |
| |
| a = <span class="macro">vec_or_str!</span>(a, yaml, aliases, alias); |
| a = <span class="macro">vec_or_str!</span>(a, yaml, visible_aliases, visible_alias); |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = yaml[<span class="string">"args"</span>].as_vec() { |
| <span class="kw">for </span>arg_yaml <span class="kw">in </span>v { |
| a = a.arg(Arg::from_yaml(arg_yaml.as_hash().unwrap())); |
| } |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = yaml[<span class="string">"subcommands"</span>].as_vec() { |
| <span class="kw">for </span>sc_yaml <span class="kw">in </span>v { |
| a = a.subcommand(SubCommand::from_yaml(sc_yaml)); |
| } |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = yaml[<span class="string">"groups"</span>].as_vec() { |
| <span class="kw">for </span>ag_yaml <span class="kw">in </span>v { |
| a = a.group(ArgGroup::from(ag_yaml.as_hash().unwrap())); |
| } |
| } |
| |
| a |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> Clone <span class="kw">for </span>App<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> { |
| <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| App { p: <span class="self">self</span>.p.clone() } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'n</span>, <span class="lifetime">'e</span>> AnyArg<<span class="lifetime">'n</span>, <span class="lifetime">'e</span>> <span class="kw">for </span>App<<span class="lifetime">'n</span>, <span class="lifetime">'e</span>> { |
| <span class="kw">fn </span>name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'n </span>str { |
| <span class="string">"" |
| </span>} |
| <span class="kw">fn </span>overrides(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[<span class="kw-2">&</span><span class="lifetime">'e </span>str]> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>requires(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[(<span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'e </span>str>, <span class="kw-2">&</span><span class="lifetime">'n </span>str)]> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>blacklist(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[<span class="kw-2">&</span><span class="lifetime">'e </span>str]> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>required_unless(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[<span class="kw-2">&</span><span class="lifetime">'e </span>str]> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>val_names(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>VecMap<<span class="kw-2">&</span><span class="lifetime">'e </span>str>> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>is_set(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw">_</span>: ArgSettings) -> bool { |
| <span class="bool-val">false |
| </span>} |
| <span class="kw">fn </span>val_terminator(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'e </span>str> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>set(<span class="kw-2">&mut </span><span class="self">self</span>, <span class="kw">_</span>: ArgSettings) { |
| <span class="macro">unreachable!</span>(<span class="string">"App struct does not support AnyArg::set, this is a bug!"</span>) |
| } |
| <span class="kw">fn </span>has_switch(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="bool-val">false |
| </span>} |
| <span class="kw">fn </span>max_vals(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u64> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>num_vals(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u64> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>possible_vals(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[<span class="kw-2">&</span><span class="lifetime">'e </span>str]> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="attribute">#[cfg_attr(feature = <span class="string">"cargo-clippy"</span>, allow(clippy::type_complexity))] |
| </span><span class="kw">fn </span>validator(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>Rc<Fn(String) -> StdResult<(), String>>> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="attribute">#[cfg_attr(feature = <span class="string">"cargo-clippy"</span>, allow(clippy::type_complexity))] |
| </span><span class="kw">fn </span>validator_os(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>Rc<Fn(<span class="kw-2">&</span>OsStr) -> StdResult<(), OsString>>> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>min_vals(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u64> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>short(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><char> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>long(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'e </span>str> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>val_delim(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><char> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>takes_value(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="bool-val">true |
| </span>} |
| <span class="kw">fn </span>help(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'e </span>str> { |
| <span class="self">self</span>.p.meta.about |
| } |
| <span class="kw">fn </span>long_help(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'e </span>str> { |
| <span class="self">self</span>.p.meta.long_about |
| } |
| <span class="kw">fn </span>default_val(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'e </span>OsStr> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>default_vals_ifs(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><map::Values<(<span class="kw-2">&</span><span class="lifetime">'n </span>str, <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'e </span>OsStr>, <span class="kw-2">&</span><span class="lifetime">'e </span>OsStr)>> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>env<<span class="lifetime">'s</span>>(<span class="kw-2">&</span><span class="lifetime">'s </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><(<span class="kw-2">&</span><span class="lifetime">'n </span>OsStr, <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'s </span>OsString>)> { |
| <span class="prelude-val">None |
| </span>} |
| <span class="kw">fn </span>longest_filter(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="bool-val">true |
| </span>} |
| <span class="kw">fn </span>aliases(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Vec<<span class="kw-2">&</span><span class="lifetime">'e </span>str>> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>aliases) = <span class="self">self</span>.p.meta.aliases { |
| <span class="kw">let </span>vis_aliases: Vec<<span class="kw">_</span>> = aliases |
| .iter() |
| .filter_map(|<span class="kw-2">&</span>(n, v)| <span class="kw">if </span>v { <span class="prelude-val">Some</span>(n) } <span class="kw">else </span>{ <span class="prelude-val">None </span>}) |
| .collect(); |
| <span class="kw">if </span>vis_aliases.is_empty() { |
| <span class="prelude-val">None |
| </span>} <span class="kw">else </span>{ |
| <span class="prelude-val">Some</span>(vis_aliases) |
| } |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>} |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'n</span>, <span class="lifetime">'e</span>> fmt::Display <span class="kw">for </span>App<<span class="lifetime">'n</span>, <span class="lifetime">'e</span>> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="macro">write!</span>(f, <span class="string">"{}"</span>, <span class="self">self</span>.p.meta.name) |
| } |
| } |
| </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> |