228 lines
57 KiB
HTML
228 lines
57 KiB
HTML
<!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="Behavior of arguments when they are encountered while parsing"><meta name="keywords" content="rust, rustlang, rust-lang, ArgAction"><title>ArgAction in clap - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.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 enum"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../clap/index.html"><div class="logo-container">
|
||
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"><a href="#">ArgAction</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#variants">Variants</a></h3><ul><li><a href="#variant.Append">Append</a></li><li><a href="#variant.Count">Count</a></li><li><a href="#variant.Help">Help</a></li><li><a href="#variant.Set">Set</a></li><li><a href="#variant.SetFalse">SetFalse</a></li><li><a href="#variant.SetTrue">SetTrue</a></li><li><a href="#variant.Version">Version</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.takes_values">takes_values</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-Clone-for-ArgAction">Clone</a></li><li><a href="#impl-Debug-for-ArgAction">Debug</a></li><li><a href="#impl-IntoResettable%3CArgAction%3E-for-ArgAction">IntoResettable<ArgAction></a></li><li><a href="#impl-IntoResettable%3CArgAction%3E-for-Option%3CArgAction%3E">IntoResettable<ArgAction></a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><a href="#impl-RefUnwindSafe-for-ArgAction">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ArgAction">Send</a></li><li><a href="#impl-Sync-for-ArgAction">Sync</a></li><li><a href="#impl-Unpin-for-ArgAction">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ArgAction">UnwindSafe</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><ul><li><a href="#impl-Any-for-ArgAction">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ArgAction">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ArgAction">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ArgAction">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ArgAction">Into<U></a></li><li><a href="#impl-ToOwned-for-ArgAction">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ArgAction">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ArgAction">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In clap</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../clap/index.html">
|
||
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Enum <a href="index.html">clap</a>::<wbr><a class="enum" href="#">ArgAction</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/clap/builder/action.rs.html#27-273">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust enum"><code>#[non_exhaustive]
|
||
pub enum ArgAction {
|
||
Set,
|
||
Append,
|
||
SetTrue,
|
||
SetFalse,
|
||
Count,
|
||
Help,
|
||
Version,
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Behavior of arguments when they are encountered while parsing</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"special-help"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'?'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Help</span>)
|
||
);
|
||
|
||
<span class="comment">// Existing help still exists</span>
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-h"</span>]).<span class="ident">unwrap_err</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);
|
||
|
||
<span class="comment">// New help available</span>
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-?"</span>]).<span class="ident">unwrap_err</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);</code></pre></div>
|
||
</div></details><h2 id="variants" class="variants small-section-header">Variants (Non-exhaustive)<a href="#variants" class="anchor"></a></h2><details class="rustdoc-toggle non-exhaustive"><summary class="hideme"><span>This enum is marked as non-exhaustive</span></summary><div class="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><h3 id="variant.Set" class="variant small-section-header"><a href="#variant.Set" class="anchor field"></a><code>Set</code></h3><div class="docblock"><p>When encountered, store the associated value(s) in <a href="parser/struct.ArgMatches.html" title="crate::ArgMatches"><code>ArgMatches</code></a></p>
|
||
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
|
||
<a href="error/enum.ErrorKind.html#variant.ArgumentConflict" title="crate::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||
<a href="builder/struct.Command.html#method.args_override_self" title="crate::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</p>
|
||
<h4 id="examples-1"><a href="#examples-1">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Set</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"value"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">matches</span>.<span class="ident">get_many</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">unwrap_or_default</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">as_str</span>()).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>(),
|
||
<span class="macro">vec!</span>[<span class="string">"value"</span>]
|
||
);</code></pre></div>
|
||
</div><h3 id="variant.Append" class="variant small-section-header"><a href="#variant.Append" class="anchor field"></a><code>Append</code></h3><div class="docblock"><p>When encountered, store the associated value(s) in <a href="parser/struct.ArgMatches.html" title="crate::ArgMatches"><code>ArgMatches</code></a></p>
|
||
<h4 id="examples-2"><a href="#examples-2">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Append</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"value1"</span>, <span class="string">"--flag"</span>, <span class="string">"value2"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">matches</span>.<span class="ident">get_many</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">unwrap_or_default</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">as_str</span>()).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>(),
|
||
<span class="macro">vec!</span>[<span class="string">"value1"</span>, <span class="string">"value2"</span>]
|
||
);</code></pre></div>
|
||
</div><h3 id="variant.SetTrue" class="variant small-section-header"><a href="#variant.SetTrue" class="anchor field"></a><code>SetTrue</code></h3><div class="docblock"><p>When encountered, act as if <code>"true"</code> was encountered on the command-line</p>
|
||
<p>If no <a href="builder/struct.Arg.html#method.default_value" title="super::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
|
||
<a href="builder/struct.Arg.html#method.default_missing_value" title="super::Arg::default_missing_value"><code>Arg::default_missing_value</code></a></p>
|
||
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
|
||
<a href="error/enum.ErrorKind.html#variant.ArgumentConflict" title="crate::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||
<a href="builder/struct.Command.html#method.args_override_self" title="crate::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</p>
|
||
<h4 id="examples-3"><a href="#examples-3">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::SetTrue</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||
<span class="prelude-val">Some</span>(<span class="bool-val">true</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||
<span class="prelude-val">Some</span>(<span class="bool-val">false</span>)
|
||
);</code></pre></div>
|
||
<p>You can use <a href="builder/trait.TypedValueParser.html#method.map" title="crate::builder::TypedValueParser::map"><code>TypedValueParser::map</code></a> to have the
|
||
flag control an application-specific type:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::SetTrue</span>)
|
||
.<span class="ident">value_parser</span>(
|
||
<span class="ident">BoolishValueParser::new</span>()
|
||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">b</span><span class="op">|</span> -> <span class="ident">usize</span> {
|
||
<span class="kw">if</span> <span class="ident">b</span> { <span class="number">10</span> } <span class="kw">else</span> { <span class="number">5</span> }
|
||
})
|
||
)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">usize</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||
<span class="prelude-val">Some</span>(<span class="number">10</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">usize</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||
<span class="prelude-val">Some</span>(<span class="number">5</span>)
|
||
);</code></pre></div>
|
||
</div><h3 id="variant.SetFalse" class="variant small-section-header"><a href="#variant.SetFalse" class="anchor field"></a><code>SetFalse</code></h3><div class="docblock"><p>When encountered, act as if <code>"false"</code> was encountered on the command-line</p>
|
||
<p>If no <a href="builder/struct.Arg.html#method.default_value" title="super::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
|
||
<a href="builder/struct.Arg.html#method.default_missing_value" title="super::Arg::default_missing_value"><code>Arg::default_missing_value</code></a></p>
|
||
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
|
||
<a href="error/enum.ErrorKind.html#variant.ArgumentConflict" title="crate::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||
<a href="builder/struct.Command.html#method.args_override_self" title="crate::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</p>
|
||
<h4 id="examples-4"><a href="#examples-4">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::SetFalse</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||
<span class="prelude-val">Some</span>(<span class="bool-val">false</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">matches</span>.<span class="ident">get_one</span>::<span class="op"><</span><span class="ident">bool</span><span class="op">></span>(<span class="string">"flag"</span>).<span class="ident">copied</span>(),
|
||
<span class="prelude-val">Some</span>(<span class="bool-val">true</span>)
|
||
);</code></pre></div>
|
||
</div><h3 id="variant.Count" class="variant small-section-header"><a href="#variant.Count" class="anchor field"></a><code>Count</code></h3><div class="docblock"><p>When encountered, increment a <code>u8</code> counter</p>
|
||
<p>If no <a href="builder/struct.Arg.html#method.default_value" title="super::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
|
||
<a href="builder/struct.Arg.html#method.default_missing_value" title="super::Arg::default_missing_value"><code>Arg::default_missing_value</code></a></p>
|
||
<h4 id="examples-5"><a href="#examples-5">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Count</span>)
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"--flag"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">matches</span>.<span class="ident">get_count</span>(<span class="string">"flag"</span>),
|
||
<span class="number">2</span>
|
||
);
|
||
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">matches</span>.<span class="ident">get_count</span>(<span class="string">"flag"</span>),
|
||
<span class="number">0</span>
|
||
);</code></pre></div>
|
||
</div><h3 id="variant.Help" class="variant small-section-header"><a href="#variant.Help" class="anchor field"></a><code>Help</code></h3><div class="docblock"><p>When encountered, display <a href="builder/struct.Command.html#method.print_help" title="super::Command::print_help"><code>Command::print_help</code></a></p>
|
||
<p>Depending on the flag, <a href="builder/struct.Command.html#method.print_long_help" title="super::Command::print_long_help"><code>Command::print_long_help</code></a> may be shown</p>
|
||
<h4 id="examples-6"><a href="#examples-6">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"special-help"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'?'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Help</span>)
|
||
);
|
||
|
||
<span class="comment">// Existing help still exists</span>
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-h"</span>]).<span class="ident">unwrap_err</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);
|
||
|
||
<span class="comment">// New help available</span>
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"-?"</span>]).<span class="ident">unwrap_err</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayHelp</span>);</code></pre></div>
|
||
</div><h3 id="variant.Version" class="variant small-section-header"><a href="#variant.Version" class="anchor field"></a><code>Version</code></h3><div class="docblock"><p>When encountered, display <a href="builder/struct.Command.html#method.version" title="super::Command::version"><code>Command::version</code></a></p>
|
||
<p>Depending on the flag, <a href="builder/struct.Command.html#method.long_version" title="super::Command::long_version"><code>Command::long_version</code></a> may be shown</p>
|
||
<h4 id="examples-7"><a href="#examples-7">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"mycmd"</span>)
|
||
.<span class="ident">version</span>(<span class="string">"1.0.0"</span>)
|
||
.<span class="ident">arg</span>(
|
||
<span class="ident">Arg::new</span>(<span class="string">"special-version"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"special-version"</span>)
|
||
.<span class="ident">action</span>(<span class="ident">clap::ArgAction::Version</span>)
|
||
);
|
||
|
||
<span class="comment">// Existing help still exists</span>
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">clone</span>().<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--version"</span>]).<span class="ident">unwrap_err</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayVersion</span>);
|
||
|
||
<span class="comment">// New help available</span>
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">cmd</span>.<span class="ident">try_get_matches_from</span>([<span class="string">"mycmd"</span>, <span class="string">"--special-version"</span>]).<span class="ident">unwrap_err</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">kind</span>(), <span class="ident">clap::error::ErrorKind::DisplayVersion</span>);</code></pre></div>
|
||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/action.rs.html#275-342">source</a></span><a href="#impl-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.takes_values" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/action.rs.html#280-290">source</a></span><h4 class="code-header">pub fn <a href="#method.takes_values" class="fnname">takes_values</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether this action accepts values on the command-line</p>
|
||
<p><a href="builder/struct.Arg.html#method.default_values" title="super::Arg::default_values"><code>default_values</code></a> and [<code>env</code>][super::Arg::env] may still be
|
||
processed.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/action.rs.html#24">source</a></span><a href="#impl-Clone-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/action.rs.html#24">source</a></span><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h4></section></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/clone.rs.html#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/action.rs.html#24">source</a></span><a href="#impl-Debug-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/action.rs.html#24">source</a></span><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-IntoResettable%3CArgAction%3E-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/resettable.rs.html#159-163">source</a></span><a href="#impl-IntoResettable%3CArgAction%3E-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="builder/trait.IntoResettable.html" title="trait clap::builder::IntoResettable">IntoResettable</a><<a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a>> for <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_resettable-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/resettable.rs.html#160-162">source</a></span><a href="#method.into_resettable-1" class="anchor"></a><h4 class="code-header">fn <a href="builder/trait.IntoResettable.html#tymethod.into_resettable" class="fnname">into_resettable</a>(self) -> <a class="enum" href="builder/enum.Resettable.html" title="enum clap::builder::Resettable">Resettable</a><<a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a>></h4></section></summary><div class='docblock'><p>Convert to the intended resettable type</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-IntoResettable%3CArgAction%3E-for-Option%3CArgAction%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/resettable.rs.html#87-94">source</a></span><a href="#impl-IntoResettable%3CArgAction%3E-for-Option%3CArgAction%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="builder/trait.IntoResettable.html" title="trait clap::builder::IntoResettable">IntoResettable</a><<a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a>> for <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a>></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_resettable" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/resettable.rs.html#88-93">source</a></span><a href="#method.into_resettable" class="anchor"></a><h4 class="code-header">fn <a href="builder/trait.IntoResettable.html#tymethod.into_resettable" class="fnname">into_resettable</a>(self) -> <a class="enum" href="builder/enum.Resettable.html" title="enum clap::builder::Resettable">Resettable</a><<a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a>></h4></section></summary><div class='docblock'><p>Convert to the intended resettable type</p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ArgAction" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Send-for-ArgAction" class="impl has-srclink"><a href="#impl-Send-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Sync-for-ArgAction" class="impl has-srclink"><a href="#impl-Sync-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Unpin-for-ArgAction" class="impl has-srclink"><a href="#impl-Unpin-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section><section id="impl-UnwindSafe-for-ArgAction" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="builder/enum.ArgAction.html" title="enum clap::builder::ArgAction">ArgAction</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#203">source</a></span><a href="#impl-Any-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#204">source</a></span><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#209">source</a></span><a href="#impl-Borrow%3CT%3E-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#211">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#218">source</a></span><a href="#impl-BorrowMut%3CT%3E-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#219">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#557">source</a></span><a href="#impl-From%3CT%3E-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#559">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#541">source</a></span><a href="#impl-Into%3CU%3E-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#549">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#83">source</a></span><a href="#impl-ToOwned-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#88">source</a></span><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#92">source</a></span><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>T)</h4></section></summary><div class='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#598">source</a></span><a href="#impl-TryFrom%3CU%3E-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#604">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ArgAction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#583">source</a></span><a href="#impl-TryInto%3CU%3E-for-ArgAction" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#589">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |