| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-2.34.0/src/args/group.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>group.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> |
| </pre><pre class="rust"><code><span class="attribute">#[cfg(feature = <span class="string">"yaml"</span>)] |
| </span><span class="kw">use </span>std::collections::BTreeMap; |
| <span class="kw">use </span>std::fmt::{Debug, Formatter, <span class="prelude-ty">Result</span>}; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"yaml"</span>)] |
| </span><span class="kw">use </span>yaml_rust::Yaml; |
| |
| <span class="doccomment">/// `ArgGroup`s are a family of related [arguments] and way for you to express, "Any of these |
| /// arguments". By placing arguments in a logical group, you can create easier requirement and |
| /// exclusion rules instead of having to list each argument individually, or when you want a rule |
| /// to apply "any but not all" arguments. |
| /// |
| /// For instance, you can make an entire `ArgGroup` required. If [`ArgGroup::multiple(true)`] is |
| /// set, this means that at least one argument from that group must be present. If |
| /// [`ArgGroup::multiple(false)`] is set (the default), one and *only* one must be present. |
| /// |
| /// You can also do things such as name an entire `ArgGroup` as a [conflict] or [requirement] for |
| /// another argument, meaning any of the arguments that belong to that group will cause a failure |
| /// if present, or must present respectively. |
| /// |
| /// Perhaps the most common use of `ArgGroup`s is to require one and *only* one argument to be |
| /// present out of a given set. Imagine that you had multiple arguments, and you want one of them |
| /// to be required, but making all of them required isn't feasible because perhaps they conflict |
| /// with each other. For example, lets say that you were building an application where one could |
| /// set a given version number by supplying a string with an option argument, i.e. |
| /// `--set-ver v1.2.3`, you also wanted to support automatically using a previous version number |
| /// and simply incrementing one of the three numbers. So you create three flags `--major`, |
| /// `--minor`, and `--patch`. All of these arguments shouldn't be used at one time but you want to |
| /// specify that *at least one* of them is used. For this, you can create a group. |
| /// |
| /// Finally, you may use `ArgGroup`s to pull a value from a group of arguments when you don't care |
| /// exactly which argument was actually used at runtime. |
| /// |
| /// # 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. |
| /// |
| /// ```rust |
| /// # use clap::{App, ArgGroup, ErrorKind}; |
| /// let result = 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)) |
| /// .get_matches_from_safe(vec!["app", "--major", "--patch"]); |
| /// // Because we used two args in the group it's an error |
| /// assert!(result.is_err()); |
| /// let err = result.unwrap_err(); |
| /// assert_eq!(err.kind, ErrorKind::ArgumentConflict); |
| /// ``` |
| /// This next example shows a passing parse of the same scenario |
| /// |
| /// ```rust |
| /// # use clap::{App, ArgGroup}; |
| /// let result = 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)) |
| /// .get_matches_from_safe(vec!["app", "--major"]); |
| /// assert!(result.is_ok()); |
| /// let matches = result.unwrap(); |
| /// // We may not know which of the args was used, so we can test for the group... |
| /// assert!(matches.is_present("vers")); |
| /// // we could also alternatively check each arg individually (not shown here) |
| /// ``` |
| /// [`ArgGroup::multiple(true)`]: ./struct.ArgGroup.html#method.multiple |
| /// [arguments]: ./struct.Arg.html |
| /// [conflict]: ./struct.Arg.html#method.conflicts_with |
| /// [requirement]: ./struct.Arg.html#method.requires |
| </span><span class="attribute">#[derive(Default)] |
| </span><span class="kw">pub struct </span>ArgGroup<<span class="lifetime">'a</span>> { |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub </span>name: <span class="kw-2">&</span><span class="lifetime">'a </span>str, |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub </span>args: Vec<<span class="kw-2">&</span><span class="lifetime">'a </span>str>, |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub </span>required: bool, |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub </span>requires: <span class="prelude-ty">Option</span><Vec<<span class="kw-2">&</span><span class="lifetime">'a </span>str>>, |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub </span>conflicts: <span class="prelude-ty">Option</span><Vec<<span class="kw-2">&</span><span class="lifetime">'a </span>str>>, |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub </span>multiple: bool, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> ArgGroup<<span class="lifetime">'a</span>> { |
| <span class="doccomment">/// Creates a new instance of `ArgGroup` using a unique string name. The name will be used to |
| /// get values from the group or refer to the group inside of conflict and requirement rules. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, ArgGroup}; |
| /// ArgGroup::with_name("config") |
| /// # ; |
| /// ``` |
| </span><span class="kw">pub fn </span>with_name(n: <span class="kw-2">&</span><span class="lifetime">'a </span>str) -> <span class="self">Self </span>{ |
| ArgGroup { |
| name: n, |
| required: <span class="bool-val">false</span>, |
| args: <span class="macro">vec!</span>[], |
| requires: <span class="prelude-val">None</span>, |
| conflicts: <span class="prelude-val">None</span>, |
| multiple: <span class="bool-val">false</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Creates a new instance of `ArgGroup` from a .yml (YAML) file. |
| /// |
| /// # Examples |
| /// |
| /// ```ignore |
| /// # #[macro_use] |
| /// # extern crate clap; |
| /// # use clap::ArgGroup; |
| /// # fn main() { |
| /// let yml = load_yaml!("group.yml"); |
| /// let ag = ArgGroup::from_yaml(yml); |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[cfg(feature = <span class="string">"yaml"</span>)] |
| </span><span class="kw">pub fn </span>from_yaml(y: <span class="kw-2">&</span><span class="lifetime">'a </span>Yaml) -> ArgGroup<<span class="lifetime">'a</span>> { |
| ArgGroup::from(y.as_hash().unwrap()) |
| } |
| |
| <span class="doccomment">/// Adds an [argument] to this group by name |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, ArgGroup}; |
| /// let m = App::new("myprog") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("color") |
| /// .short("c")) |
| /// .group(ArgGroup::with_name("req_flags") |
| /// .arg("flag") |
| /// .arg("color")) |
| /// .get_matches_from(vec!["myprog", "-f"]); |
| /// // maybe we don't know which of the two flags was used... |
| /// assert!(m.is_present("req_flags")); |
| /// // but we can also check individually if needed |
| /// assert!(m.is_present("flag")); |
| /// ``` |
| /// [argument]: ./struct.Arg.html |
| </span><span class="kw">pub fn </span>arg(<span class="kw-2">mut </span><span class="self">self</span>, n: <span class="kw-2">&</span><span class="lifetime">'a </span>str) -> <span class="self">Self </span>{ |
| <span class="macro">assert!</span>( |
| <span class="self">self</span>.name != n, |
| <span class="string">"ArgGroup '{}' can not have same name as arg inside it"</span>, |
| <span class="kw-2">&*</span><span class="self">self</span>.name |
| ); |
| <span class="self">self</span>.args.push(n); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Adds multiple [arguments] to this group by name |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, ArgGroup}; |
| /// let m = App::new("myprog") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("color") |
| /// .short("c")) |
| /// .group(ArgGroup::with_name("req_flags") |
| /// .args(&["flag", "color"])) |
| /// .get_matches_from(vec!["myprog", "-f"]); |
| /// // maybe we don't know which of the two flags was used... |
| /// assert!(m.is_present("req_flags")); |
| /// // but we can also check individually if needed |
| /// assert!(m.is_present("flag")); |
| /// ``` |
| /// [arguments]: ./struct.Arg.html |
| </span><span class="kw">pub fn </span>args(<span class="kw-2">mut </span><span class="self">self</span>, ns: <span class="kw-2">&</span>[<span class="kw-2">&</span><span class="lifetime">'a </span>str]) -> <span class="self">Self </span>{ |
| <span class="kw">for </span>n <span class="kw">in </span>ns { |
| <span class="self">self </span>= <span class="self">self</span>.arg(n); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Allows more than one of the ['Arg']s in this group to be used. (Default: `false`) |
| /// |
| /// # Examples |
| /// |
| /// Notice in this example we use *both* the `-f` and `-c` flags which are both part of the |
| /// group |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, ArgGroup}; |
| /// let m = App::new("myprog") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("color") |
| /// .short("c")) |
| /// .group(ArgGroup::with_name("req_flags") |
| /// .args(&["flag", "color"]) |
| /// .multiple(true)) |
| /// .get_matches_from(vec!["myprog", "-f", "-c"]); |
| /// // maybe we don't know which of the two flags was used... |
| /// assert!(m.is_present("req_flags")); |
| /// ``` |
| /// In this next example, we show the default behavior (i.e. `multiple(false)) which will throw |
| /// an error if more than one of the args in the group was used. |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, ArgGroup, ErrorKind}; |
| /// let result = App::new("myprog") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("color") |
| /// .short("c")) |
| /// .group(ArgGroup::with_name("req_flags") |
| /// .args(&["flag", "color"])) |
| /// .get_matches_from_safe(vec!["myprog", "-f", "-c"]); |
| /// // Because we used both args in the group it's an error |
| /// assert!(result.is_err()); |
| /// let err = result.unwrap_err(); |
| /// assert_eq!(err.kind, ErrorKind::ArgumentConflict); |
| /// ``` |
| /// ['Arg']: ./struct.Arg.html |
| </span><span class="kw">pub fn </span>multiple(<span class="kw-2">mut </span><span class="self">self</span>, m: bool) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.multiple = m; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the group as required or not. A required group will be displayed in the usage string |
| /// of the application in the format `<arg|arg2|arg3>`. A required `ArgGroup` simply states |
| /// that one argument from this group *must* be present at runtime (unless |
| /// conflicting with another argument). |
| /// |
| /// **NOTE:** This setting only applies to the current [`App`] / [`SubCommand`], and not |
| /// globally. |
| /// |
| /// **NOTE:** By default, [`ArgGroup::multiple`] is set to `false` which when combined with |
| /// `ArgGroup::required(true)` states, "One and *only one* arg must be used from this group. |
| /// Use of more than one arg is an error." Vice setting `ArgGroup::multiple(true)` which |
| /// states, '*At least* one arg from this group must be used. Using multiple is OK." |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, ArgGroup, ErrorKind}; |
| /// let result = App::new("myprog") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("color") |
| /// .short("c")) |
| /// .group(ArgGroup::with_name("req_flags") |
| /// .args(&["flag", "color"]) |
| /// .required(true)) |
| /// .get_matches_from_safe(vec!["myprog"]); |
| /// // Because we didn't use any of the args in the group, it's an error |
| /// assert!(result.is_err()); |
| /// let err = result.unwrap_err(); |
| /// assert_eq!(err.kind, ErrorKind::MissingRequiredArgument); |
| /// ``` |
| /// [`App`]: ./struct.App.html |
| /// [`SubCommand`]: ./struct.SubCommand.html |
| /// [`ArgGroup::multiple`]: ./struct.ArgGroup.html#method.multiple |
| </span><span class="kw">pub fn </span>required(<span class="kw-2">mut </span><span class="self">self</span>, r: bool) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.required = r; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the requirement rules of this group. This is not to be confused with a |
| /// [required group]. Requirement rules function just like [argument requirement rules], you |
| /// can name other arguments or groups that must be present when any one of the arguments from |
| /// this group is used. |
| /// |
| /// **NOTE:** The name provided may be an argument, or group name |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, ArgGroup, ErrorKind}; |
| /// let result = App::new("myprog") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("color") |
| /// .short("c")) |
| /// .arg(Arg::with_name("debug") |
| /// .short("d")) |
| /// .group(ArgGroup::with_name("req_flags") |
| /// .args(&["flag", "color"]) |
| /// .requires("debug")) |
| /// .get_matches_from_safe(vec!["myprog", "-c"]); |
| /// // because we used an arg from the group, and the group requires "-d" to be used, it's an |
| /// // error |
| /// assert!(result.is_err()); |
| /// let err = result.unwrap_err(); |
| /// assert_eq!(err.kind, ErrorKind::MissingRequiredArgument); |
| /// ``` |
| /// [required group]: ./struct.ArgGroup.html#method.required |
| /// [argument requirement rules]: ./struct.Arg.html#method.requires |
| </span><span class="kw">pub fn </span>requires(<span class="kw-2">mut </span><span class="self">self</span>, n: <span class="kw-2">&</span><span class="lifetime">'a </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>reqs) = <span class="self">self</span>.requires { |
| reqs.push(n); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.requires = <span class="prelude-val">Some</span>(<span class="macro">vec!</span>[n]); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the requirement rules of this group. This is not to be confused with a |
| /// [required group]. Requirement rules function just like [argument requirement rules], you |
| /// can name other arguments or groups that must be present when one of the arguments from this |
| /// group is used. |
| /// |
| /// **NOTE:** The names provided may be an argument, or group name |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, ArgGroup, ErrorKind}; |
| /// let result = App::new("myprog") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("color") |
| /// .short("c")) |
| /// .arg(Arg::with_name("debug") |
| /// .short("d")) |
| /// .arg(Arg::with_name("verb") |
| /// .short("v")) |
| /// .group(ArgGroup::with_name("req_flags") |
| /// .args(&["flag", "color"]) |
| /// .requires_all(&["debug", "verb"])) |
| /// .get_matches_from_safe(vec!["myprog", "-c", "-d"]); |
| /// // because we used an arg from the group, and the group requires "-d" and "-v" to be used, |
| /// // yet we only used "-d" it's an error |
| /// assert!(result.is_err()); |
| /// let err = result.unwrap_err(); |
| /// assert_eq!(err.kind, ErrorKind::MissingRequiredArgument); |
| /// ``` |
| /// [required group]: ./struct.ArgGroup.html#method.required |
| /// [argument requirement rules]: ./struct.Arg.html#method.requires_all |
| </span><span class="kw">pub fn </span>requires_all(<span class="kw-2">mut </span><span class="self">self</span>, ns: <span class="kw-2">&</span>[<span class="kw-2">&</span><span class="lifetime">'a </span>str]) -> <span class="self">Self </span>{ |
| <span class="kw">for </span>n <span class="kw">in </span>ns { |
| <span class="self">self </span>= <span class="self">self</span>.requires(n); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the exclusion rules of this group. Exclusion (aka conflict) rules function just like |
| /// [argument exclusion rules], you can name other arguments or groups that must *not* be |
| /// present when one of the arguments from this group are used. |
| /// |
| /// **NOTE:** The name provided may be an argument, or group name |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, ArgGroup, ErrorKind}; |
| /// let result = App::new("myprog") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("color") |
| /// .short("c")) |
| /// .arg(Arg::with_name("debug") |
| /// .short("d")) |
| /// .group(ArgGroup::with_name("req_flags") |
| /// .args(&["flag", "color"]) |
| /// .conflicts_with("debug")) |
| /// .get_matches_from_safe(vec!["myprog", "-c", "-d"]); |
| /// // because we used an arg from the group, and the group conflicts with "-d", it's an error |
| /// assert!(result.is_err()); |
| /// let err = result.unwrap_err(); |
| /// assert_eq!(err.kind, ErrorKind::ArgumentConflict); |
| /// ``` |
| /// [argument exclusion rules]: ./struct.Arg.html#method.conflicts_with |
| </span><span class="kw">pub fn </span>conflicts_with(<span class="kw-2">mut </span><span class="self">self</span>, n: <span class="kw-2">&</span><span class="lifetime">'a </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>confs) = <span class="self">self</span>.conflicts { |
| confs.push(n); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.conflicts = <span class="prelude-val">Some</span>(<span class="macro">vec!</span>[n]); |
| } |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the exclusion rules of this group. Exclusion rules function just like |
| /// [argument exclusion rules], you can name other arguments or groups that must *not* be |
| /// present when one of the arguments from this group are used. |
| /// |
| /// **NOTE:** The names provided may be an argument, or group name |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// # use clap::{App, Arg, ArgGroup, ErrorKind}; |
| /// let result = App::new("myprog") |
| /// .arg(Arg::with_name("flag") |
| /// .short("f")) |
| /// .arg(Arg::with_name("color") |
| /// .short("c")) |
| /// .arg(Arg::with_name("debug") |
| /// .short("d")) |
| /// .arg(Arg::with_name("verb") |
| /// .short("v")) |
| /// .group(ArgGroup::with_name("req_flags") |
| /// .args(&["flag", "color"]) |
| /// .conflicts_with_all(&["debug", "verb"])) |
| /// .get_matches_from_safe(vec!["myprog", "-c", "-v"]); |
| /// // because we used an arg from the group, and the group conflicts with either "-v" or "-d" |
| /// // it's an error |
| /// assert!(result.is_err()); |
| /// let err = result.unwrap_err(); |
| /// assert_eq!(err.kind, ErrorKind::ArgumentConflict); |
| /// ``` |
| /// [argument exclusion rules]: ./struct.Arg.html#method.conflicts_with_all |
| </span><span class="kw">pub fn </span>conflicts_with_all(<span class="kw-2">mut </span><span class="self">self</span>, ns: <span class="kw-2">&</span>[<span class="kw-2">&</span><span class="lifetime">'a </span>str]) -> <span class="self">Self </span>{ |
| <span class="kw">for </span>n <span class="kw">in </span>ns { |
| <span class="self">self </span>= <span class="self">self</span>.conflicts_with(n); |
| } |
| <span class="self">self |
| </span>} |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Debug <span class="kw">for </span>ArgGroup<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>Formatter) -> <span class="prelude-ty">Result </span>{ |
| <span class="macro">write!</span>( |
| f, |
| <span class="string">"{{\n\ |
| \tname: {:?},\n\ |
| \targs: {:?},\n\ |
| \trequired: {:?},\n\ |
| \trequires: {:?},\n\ |
| \tconflicts: {:?},\n\ |
| }}"</span>, |
| <span class="self">self</span>.name, <span class="self">self</span>.args, <span class="self">self</span>.required, <span class="self">self</span>.requires, <span class="self">self</span>.conflicts |
| ) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'z</span>> From<<span class="kw-2">&</span><span class="lifetime">'z </span>ArgGroup<<span class="lifetime">'a</span>>> <span class="kw">for </span>ArgGroup<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>from(g: <span class="kw-2">&</span><span class="lifetime">'z </span>ArgGroup<<span class="lifetime">'a</span>>) -> <span class="self">Self </span>{ |
| ArgGroup { |
| name: g.name, |
| required: g.required, |
| args: g.args.clone(), |
| requires: g.requires.clone(), |
| conflicts: g.conflicts.clone(), |
| multiple: g.multiple, |
| } |
| } |
| } |
| |
| <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>BTreeMap<Yaml, Yaml>> <span class="kw">for </span>ArgGroup<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>from(b: <span class="kw-2">&</span><span class="lifetime">'a </span>BTreeMap<Yaml, Yaml>) -> <span class="self">Self </span>{ |
| <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>a = ArgGroup::default(); |
| <span class="kw">let </span>group_settings = <span class="kw">if </span>b.len() == <span class="number">1 </span>{ |
| <span class="kw">let </span>name_yml = b.keys().nth(<span class="number">0</span>).expect(<span class="string">"failed to get name"</span>); |
| <span class="kw">let </span>name_str = name_yml |
| .as_str() |
| .expect(<span class="string">"failed to convert arg YAML name to str"</span>); |
| a.name = name_str; |
| b.get(name_yml) |
| .expect(<span class="string">"failed to get name_str"</span>) |
| .as_hash() |
| .expect(<span class="string">"failed to convert to a hash"</span>) |
| } <span class="kw">else </span>{ |
| b |
| }; |
| |
| <span class="kw">for </span>(k, v) <span class="kw">in </span>group_settings { |
| a = <span class="kw">match </span>k.as_str().unwrap() { |
| <span class="string">"required" </span>=> a.required(v.as_bool().unwrap()), |
| <span class="string">"multiple" </span>=> a.multiple(v.as_bool().unwrap()), |
| <span class="string">"args" </span>=> <span class="macro">yaml_vec_or_str!</span>(v, a, arg), |
| <span class="string">"arg" </span>=> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(ys) = v.as_str() { |
| a = a.arg(ys); |
| } |
| a |
| } |
| <span class="string">"requires" </span>=> <span class="macro">yaml_vec_or_str!</span>(v, a, requires), |
| <span class="string">"conflicts_with" </span>=> <span class="macro">yaml_vec_or_str!</span>(v, a, conflicts_with), |
| <span class="string">"name" </span>=> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(ys) = v.as_str() { |
| a.name = ys; |
| } |
| a |
| } |
| s => <span class="macro">panic!</span>( |
| <span class="string">"Unknown ArgGroup setting '{}' in YAML file for \ |
| ArgGroup '{}'"</span>, |
| s, a.name |
| ), |
| } |
| } |
| |
| a |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>test { |
| <span class="kw">use </span><span class="kw">super</span>::ArgGroup; |
| <span class="attribute">#[cfg(feature = <span class="string">"yaml"</span>)] |
| </span><span class="kw">use </span>yaml_rust::YamlLoader; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>groups() { |
| <span class="kw">let </span>g = ArgGroup::with_name(<span class="string">"test"</span>) |
| .arg(<span class="string">"a1"</span>) |
| .arg(<span class="string">"a4"</span>) |
| .args(<span class="kw-2">&</span>[<span class="string">"a2"</span>, <span class="string">"a3"</span>]) |
| .required(<span class="bool-val">true</span>) |
| .conflicts_with(<span class="string">"c1"</span>) |
| .conflicts_with_all(<span class="kw-2">&</span>[<span class="string">"c2"</span>, <span class="string">"c3"</span>]) |
| .conflicts_with(<span class="string">"c4"</span>) |
| .requires(<span class="string">"r1"</span>) |
| .requires_all(<span class="kw-2">&</span>[<span class="string">"r2"</span>, <span class="string">"r3"</span>]) |
| .requires(<span class="string">"r4"</span>); |
| |
| <span class="kw">let </span>args = <span class="macro">vec!</span>[<span class="string">"a1"</span>, <span class="string">"a4"</span>, <span class="string">"a2"</span>, <span class="string">"a3"</span>]; |
| <span class="kw">let </span>reqs = <span class="macro">vec!</span>[<span class="string">"r1"</span>, <span class="string">"r2"</span>, <span class="string">"r3"</span>, <span class="string">"r4"</span>]; |
| <span class="kw">let </span>confs = <span class="macro">vec!</span>[<span class="string">"c1"</span>, <span class="string">"c2"</span>, <span class="string">"c3"</span>, <span class="string">"c4"</span>]; |
| |
| <span class="macro">assert_eq!</span>(g.args, args); |
| <span class="macro">assert_eq!</span>(g.requires, <span class="prelude-val">Some</span>(reqs)); |
| <span class="macro">assert_eq!</span>(g.conflicts, <span class="prelude-val">Some</span>(confs)); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_debug() { |
| <span class="kw">let </span>g = ArgGroup::with_name(<span class="string">"test"</span>) |
| .arg(<span class="string">"a1"</span>) |
| .arg(<span class="string">"a4"</span>) |
| .args(<span class="kw-2">&</span>[<span class="string">"a2"</span>, <span class="string">"a3"</span>]) |
| .required(<span class="bool-val">true</span>) |
| .conflicts_with(<span class="string">"c1"</span>) |
| .conflicts_with_all(<span class="kw-2">&</span>[<span class="string">"c2"</span>, <span class="string">"c3"</span>]) |
| .conflicts_with(<span class="string">"c4"</span>) |
| .requires(<span class="string">"r1"</span>) |
| .requires_all(<span class="kw-2">&</span>[<span class="string">"r2"</span>, <span class="string">"r3"</span>]) |
| .requires(<span class="string">"r4"</span>); |
| |
| <span class="kw">let </span>args = <span class="macro">vec!</span>[<span class="string">"a1"</span>, <span class="string">"a4"</span>, <span class="string">"a2"</span>, <span class="string">"a3"</span>]; |
| <span class="kw">let </span>reqs = <span class="macro">vec!</span>[<span class="string">"r1"</span>, <span class="string">"r2"</span>, <span class="string">"r3"</span>, <span class="string">"r4"</span>]; |
| <span class="kw">let </span>confs = <span class="macro">vec!</span>[<span class="string">"c1"</span>, <span class="string">"c2"</span>, <span class="string">"c3"</span>, <span class="string">"c4"</span>]; |
| |
| <span class="kw">let </span>debug_str = <span class="macro">format!</span>( |
| <span class="string">"{{\n\ |
| \tname: \"test\",\n\ |
| \targs: {:?},\n\ |
| \trequired: {:?},\n\ |
| \trequires: {:?},\n\ |
| \tconflicts: {:?},\n\ |
| }}"</span>, |
| args, |
| <span class="bool-val">true</span>, |
| <span class="prelude-val">Some</span>(reqs), |
| <span class="prelude-val">Some</span>(confs) |
| ); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">&*</span><span class="macro">format!</span>(<span class="string">"{:?}"</span>, g), <span class="kw-2">&*</span>debug_str); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_from() { |
| <span class="kw">let </span>g = ArgGroup::with_name(<span class="string">"test"</span>) |
| .arg(<span class="string">"a1"</span>) |
| .arg(<span class="string">"a4"</span>) |
| .args(<span class="kw-2">&</span>[<span class="string">"a2"</span>, <span class="string">"a3"</span>]) |
| .required(<span class="bool-val">true</span>) |
| .conflicts_with(<span class="string">"c1"</span>) |
| .conflicts_with_all(<span class="kw-2">&</span>[<span class="string">"c2"</span>, <span class="string">"c3"</span>]) |
| .conflicts_with(<span class="string">"c4"</span>) |
| .requires(<span class="string">"r1"</span>) |
| .requires_all(<span class="kw-2">&</span>[<span class="string">"r2"</span>, <span class="string">"r3"</span>]) |
| .requires(<span class="string">"r4"</span>); |
| |
| <span class="kw">let </span>args = <span class="macro">vec!</span>[<span class="string">"a1"</span>, <span class="string">"a4"</span>, <span class="string">"a2"</span>, <span class="string">"a3"</span>]; |
| <span class="kw">let </span>reqs = <span class="macro">vec!</span>[<span class="string">"r1"</span>, <span class="string">"r2"</span>, <span class="string">"r3"</span>, <span class="string">"r4"</span>]; |
| <span class="kw">let </span>confs = <span class="macro">vec!</span>[<span class="string">"c1"</span>, <span class="string">"c2"</span>, <span class="string">"c3"</span>, <span class="string">"c4"</span>]; |
| |
| <span class="kw">let </span>g2 = ArgGroup::from(<span class="kw-2">&</span>g); |
| <span class="macro">assert_eq!</span>(g2.args, args); |
| <span class="macro">assert_eq!</span>(g2.requires, <span class="prelude-val">Some</span>(reqs)); |
| <span class="macro">assert_eq!</span>(g2.conflicts, <span class="prelude-val">Some</span>(confs)); |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"yaml"</span>)] |
| #[cfg_attr(feature = <span class="string">"yaml"</span>, test)] |
| </span><span class="kw">fn </span>test_yaml() { |
| <span class="kw">let </span>g_yaml = <span class="string">"name: test |
| args: |
| - a1 |
| - a4 |
| - a2 |
| - a3 |
| conflicts_with: |
| - c1 |
| - c2 |
| - c3 |
| - c4 |
| requires: |
| - r1 |
| - r2 |
| - r3 |
| - r4"</span>; |
| <span class="kw">let </span>yml = <span class="kw-2">&</span>YamlLoader::load_from_str(g_yaml).expect(<span class="string">"failed to load YAML file"</span>)[<span class="number">0</span>]; |
| <span class="kw">let </span>g = ArgGroup::from_yaml(yml); |
| <span class="kw">let </span>args = <span class="macro">vec!</span>[<span class="string">"a1"</span>, <span class="string">"a4"</span>, <span class="string">"a2"</span>, <span class="string">"a3"</span>]; |
| <span class="kw">let </span>reqs = <span class="macro">vec!</span>[<span class="string">"r1"</span>, <span class="string">"r2"</span>, <span class="string">"r3"</span>, <span class="string">"r4"</span>]; |
| <span class="kw">let </span>confs = <span class="macro">vec!</span>[<span class="string">"c1"</span>, <span class="string">"c2"</span>, <span class="string">"c3"</span>, <span class="string">"c4"</span>]; |
| <span class="macro">assert_eq!</span>(g.args, args); |
| <span class="macro">assert_eq!</span>(g.requires, <span class="prelude-val">Some</span>(reqs)); |
| <span class="macro">assert_eq!</span>(g.conflicts, <span class="prelude-val">Some</span>(confs)); |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Clone <span class="kw">for </span>ArgGroup<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| ArgGroup { |
| name: <span class="self">self</span>.name, |
| required: <span class="self">self</span>.required, |
| args: <span class="self">self</span>.args.clone(), |
| requires: <span class="self">self</span>.requires.clone(), |
| conflicts: <span class="self">self</span>.conflicts.clone(), |
| multiple: <span class="self">self</span>.multiple, |
| } |
| } |
| } |
| </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> |
