<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../clap_builder/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Enum <ahref="../index.html">clap_builder</a>::<wbr><ahref="index.html">builder</a>::<wbr><aclass="enum"href="#">ArgAction</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../src/clap_builder/builder/action.rs.html#32-339">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code><divclass="code-attribute">#[non_exhaustive]</div>pub enum ArgAction {
Set,
Append,
SetTrue,
SetFalse,
Count,
Help,
HelpShort,
HelpLong,
Version,
}</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Behavior of arguments when they are encountered while parsing</p>
</div></details><h2id="variants"class="variants section-header">Variants (Non-exhaustive)<ahref="#variants"class="anchor">§</a></h2><detailsclass="toggle non-exhaustive"><summaryclass="hideme"><span>This enum is marked as non-exhaustive</span></summary><divclass="docblock">Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.</div></details><divclass="variants"><sectionid="variant.Set"class="variant"><ahref="#variant.Set"class="anchor">§</a><h3class="code-header">Set</h3></section><divclass="docblock"><p>When encountered, store the associated value(s) in <ahref="../parser/struct.ArgMatches.html"title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a></p>
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
<ahref="struct.Command.html#method.args_override_self"title="method clap_builder::builder::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</p>
</div><sectionid="variant.Append"class="variant"><ahref="#variant.Append"class="anchor">§</a><h3class="code-header">Append</h3></section><divclass="docblock"><p>When encountered, store the associated value(s) in <ahref="../parser/struct.ArgMatches.html"title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a></p>
</div><sectionid="variant.SetTrue"class="variant"><ahref="#variant.SetTrue"class="anchor">§</a><h3class="code-header">SetTrue</h3></section><divclass="docblock"><p>When encountered, act as if <code>"true"</code> was encountered on the command-line</p>
<p>If no <ahref="struct.Arg.html#method.default_value"title="method clap_builder::builder::Arg::default_value"><code>default_value</code></a> is set, it will be <code>false</code>.</p>
<p>No value is allowed. To optionally accept a value, see
<ahref="struct.Command.html#method.args_override_self"title="method clap_builder::builder::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</p>
<p>You can use <ahref="trait.TypedValueParser.html#method.map"title="method clap_builder::builder::TypedValueParser::map"><code>TypedValueParser::map</code></a> to have the
</div><sectionid="variant.SetFalse"class="variant"><ahref="#variant.SetFalse"class="anchor">§</a><h3class="code-header">SetFalse</h3></section><divclass="docblock"><p>When encountered, act as if <code>"false"</code> was encountered on the command-line</p>
<p>If no <ahref="struct.Arg.html#method.default_value"title="method clap_builder::builder::Arg::default_value"><code>default_value</code></a> is set, it will be <code>true</code>.</p>
<p>No value is allowed. To optionally accept a value, see
<ahref="struct.Command.html#method.args_override_self"title="method clap_builder::builder::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</p>
</div><sectionid="variant.Count"class="variant"><ahref="#variant.Count"class="anchor">§</a><h3class="code-header">Count</h3></section><divclass="docblock"><p>When encountered, increment a <code>u8</code> counter</p>
<p>If no <ahref="struct.Arg.html#method.default_value"title="method clap_builder::builder::Arg::default_value"><code>default_value</code></a> is set, it will be <code>0</code>.</p>
<p>No value is allowed. To optionally accept a value, see
<p>Depending on the flag, <ahref="struct.Command.html#method.print_long_help"title="method clap_builder::builder::Command::print_long_help"><code>Command::print_long_help</code></a> may be shown</p>
<p>Depending on the flag, <ahref="struct.Command.html#method.long_version"title="method clap_builder::builder::Command::long_version"><code>Command::long_version</code></a> may be shown</p>
<p><ahref="struct.Arg.html#method.default_values"title="method clap_builder::builder::Arg::default_values"><code>default_values</code></a> and [<code>env</code>][super::Arg::env] may still be
<code><ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-ToOwned-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/alloc/borrow.rs.html#83-85">source</a><ahref="#impl-ToOwned-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T<divclass="where">where
T: <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Owned"class="associatedtype trait-impl"><ahref="#associatedtype.Owned"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned"class="associatedtype">Owned</a> = T</h4></section></summary><divclass='docblock'>The resulting type after obtaining ownership.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.to_owned"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/alloc/borrow.rs.html#88">source</a><ahref="#method.to_owned"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned"class="fn">to_owned</a>(&self) -> T</h4></section></summary><divclass='docblock'>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.clone_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/alloc/borrow.rs.html#92">source</a><ahref="#method.clone_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fn">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&mut T</a>)</h4></section></summary><divclass='docblock'>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#805-807">source</a><ahref="#impl-TryFrom%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#812">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#790-792">source</a><ahref="#impl-TryInto%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#797">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
