309 lines
79 KiB
HTML
309 lines
79 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="Family of related arguments."><meta name="keywords" content="rust, rustlang, rust-lang, ArgGroup"><title>ArgGroup 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 struct"><!--[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="#">ArgGroup</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.arg">arg</a></li><li><a href="#method.args">args</a></li><li><a href="#method.conflicts_with">conflicts_with</a></li><li><a href="#method.conflicts_with_all">conflicts_with_all</a></li><li><a href="#method.get_args">get_args</a></li><li><a href="#method.get_id">get_id</a></li><li><a href="#method.id">id</a></li><li><a href="#method.is_multiple">is_multiple</a></li><li><a href="#method.is_required_set">is_required_set</a></li><li><a href="#method.multiple">multiple</a></li><li><a href="#method.new">new</a></li><li><a href="#method.required">required</a></li><li><a href="#method.requires">requires</a></li><li><a href="#method.requires_all">requires_all</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-ArgGroup">Clone</a></li><li><a href="#impl-Debug-for-ArgGroup">Debug</a></li><li><a href="#impl-Default-for-ArgGroup">Default</a></li><li><a href="#impl-Eq-for-ArgGroup">Eq</a></li><li><a href="#impl-From%3C%26ArgGroup%3E-for-ArgGroup">From<&ArgGroup></a></li><li><a href="#impl-PartialEq%3CArgGroup%3E-for-ArgGroup">PartialEq<ArgGroup></a></li><li><a href="#impl-StructuralEq-for-ArgGroup">StructuralEq</a></li><li><a href="#impl-StructuralPartialEq-for-ArgGroup">StructuralPartialEq</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-ArgGroup">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ArgGroup">Send</a></li><li><a href="#impl-Sync-for-ArgGroup">Sync</a></li><li><a href="#impl-Unpin-for-ArgGroup">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ArgGroup">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-ArgGroup">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ArgGroup">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ArgGroup">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ArgGroup">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ArgGroup">Into<U></a></li><li><a href="#impl-ToOwned-for-ArgGroup">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ArgGroup">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ArgGroup">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">Struct <a href="index.html">clap</a>::<wbr><a class="struct" href="#">ArgGroup</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/arg_group.rs.html#86-93">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 struct"><code>pub struct ArgGroup { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Family of related <a href="builder/struct.Arg.html">arguments</a>.</p>
|
||
<p>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.</p>
|
||
<p>For instance, you can make an entire <code>ArgGroup</code> required. If <a href="builder/struct.ArgGroup.html#method.multiple"><code>ArgGroup::multiple(true)</code></a> is
|
||
set, this means that at least one argument from that group must be present. If
|
||
<a href="builder/struct.ArgGroup.html#method.multiple"><code>ArgGroup::multiple(false)</code></a> is set (the default), one and <em>only</em> one must be present.</p>
|
||
<p>You can also do things such as name an entire <code>ArgGroup</code> as a <a href="builder/struct.Arg.html#method.conflicts_with">conflict</a> or <a href="builder/struct.Arg.html#method.requires">requirement</a> for
|
||
another argument, meaning any of the arguments that belong to that group will cause a failure
|
||
if present, or must be present respectively.</p>
|
||
<p>Perhaps the most common use of <code>ArgGroup</code>s is to require one and <em>only</em> 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.
|
||
<code>--set-ver v1.2.3</code>, you also wanted to support automatically using a previous version number
|
||
and simply incrementing one of the three numbers. So you create three flags <code>--major</code>,
|
||
<code>--minor</code>, and <code>--patch</code>. All of these arguments shouldn’t be used at one time but you want to
|
||
specify that <em>at least one</em> of them is used. For this, you can create a group.</p>
|
||
<p>Finally, you may use <code>ArgGroup</code>s to pull a value from a group of arguments when you don’t care
|
||
exactly which argument was actually used at runtime.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<p>The following example demonstrates using an <code>ArgGroup</code> to ensure that one, and only one, of
|
||
the arguments from the specified group is present at runtime.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"cmd"</span>)
|
||
.<span class="ident">arg</span>(<span class="macro">arg!</span>(<span class="op">-</span><span class="op">-</span><span class="string">"set-ver"</span> <span class="op"><</span><span class="ident">ver</span><span class="op">></span> <span class="string">"set the version manually"</span>))
|
||
.<span class="ident">arg</span>(<span class="macro">arg!</span>(<span class="op">-</span><span class="op">-</span><span class="ident">major</span> <span class="string">"auto increase major"</span>))
|
||
.<span class="ident">arg</span>(<span class="macro">arg!</span>(<span class="op">-</span><span class="op">-</span><span class="ident">minor</span> <span class="string">"auto increase minor"</span>))
|
||
.<span class="ident">arg</span>(<span class="macro">arg!</span>(<span class="op">-</span><span class="op">-</span><span class="ident">patch</span> <span class="string">"auto increase patch"</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"vers"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"set-ver"</span>, <span class="string">"major"</span>, <span class="string">"minor"</span>, <span class="string">"patch"</span>])
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"cmd"</span>, <span class="string">"--major"</span>, <span class="string">"--patch"</span>]);
|
||
<span class="comment">// Because we used two args in the group it's an error</span>
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">result</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">ErrorKind::ArgumentConflict</span>);</code></pre></div>
|
||
<p>This next example shows a passing parse of the same scenario</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"cmd"</span>)
|
||
.<span class="ident">arg</span>(<span class="macro">arg!</span>(<span class="op">-</span><span class="op">-</span><span class="string">"set-ver"</span> <span class="op"><</span><span class="ident">ver</span><span class="op">></span> <span class="string">"set the version manually"</span>))
|
||
.<span class="ident">arg</span>(<span class="macro">arg!</span>(<span class="op">-</span><span class="op">-</span><span class="ident">major</span> <span class="string">"auto increase major"</span>))
|
||
.<span class="ident">arg</span>(<span class="macro">arg!</span>(<span class="op">-</span><span class="op">-</span><span class="ident">minor</span> <span class="string">"auto increase minor"</span>))
|
||
.<span class="ident">arg</span>(<span class="macro">arg!</span>(<span class="op">-</span><span class="op">-</span><span class="ident">patch</span> <span class="string">"auto increase patch"</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"vers"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"set-ver"</span>, <span class="string">"major"</span>, <span class="string">"minor"</span>,<span class="string">"patch"</span>])
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"cmd"</span>, <span class="string">"--major"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="ident">result</span>.<span class="ident">unwrap</span>();
|
||
<span class="comment">// We may not know which of the args was used, so we can test for the group...</span>
|
||
<span class="macro">assert!</span>(<span class="ident">matches</span>.<span class="ident">contains_id</span>(<span class="string">"vers"</span>));
|
||
<span class="comment">// We can also ask the group which arg was used</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">Id</span><span class="op">></span>(<span class="string">"vers"</span>)
|
||
.<span class="ident">expect</span>(<span class="string">"`vers` is required"</span>)
|
||
.<span class="ident">as_str</span>(),
|
||
<span class="string">"major"</span>
|
||
);
|
||
<span class="comment">// we could also alternatively check each arg individually (not shown here)</span></code></pre></div>
|
||
</div></details><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-ArgGroup" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#96-495">source</a></span><a href="#impl-ArgGroup" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section></summary><div class="docblock"><h4 id="builder"><a href="#builder">Builder</a></h4></div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#109-111">source</a></span><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(id: impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>>) -> Self</h4></section></summary><div class="docblock"><p>Create a <code>ArgGroup</code> using a unique name.</p>
|
||
<p>The name will be used to get values from the group or refer to the group inside of conflict
|
||
and requirement rules.</p>
|
||
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="ident">ArgGroup::new</span>(<span class="string">"config"</span>)</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.id" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#123-126">source</a></span><h4 class="code-header">pub fn <a href="#method.id" class="fnname">id</a>(self, id: impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>>) -> Self</h4></section></summary><div class="docblock"><p>Sets the group name.</p>
|
||
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="ident">ArgGroup::default</span>().<span class="ident">id</span>(<span class="string">"config"</span>)</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.arg" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#152-159">source</a></span><h4 class="code-header">pub fn <a href="#method.arg" class="fnname">arg</a>(self, arg_id: impl <a class="trait" href="builder/trait.IntoResettable.html" title="trait clap::builder::IntoResettable">IntoResettable</a><<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>>) -> Self</h4></section></summary><div class="docblock"><p>Adds an <a href="builder/struct.Arg.html">argument</a> to this group by name</p>
|
||
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'f'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'c'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"req_flags"</span>)
|
||
.<span class="ident">arg</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">arg</span>(<span class="string">"color"</span>))
|
||
.<span class="ident">get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"myprog"</span>, <span class="string">"-f"</span>]);
|
||
<span class="comment">// maybe we don't know which of the two flags was used...</span>
|
||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">contains_id</span>(<span class="string">"req_flags"</span>));
|
||
<span class="comment">// but we can also check individually if needed</span>
|
||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.args" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#184-189">source</a></span><h4 class="code-header">pub fn <a href="#method.args" class="fnname">args</a>(self, ns: impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>>>) -> Self</h4></section></summary><div class="docblock"><p>Adds multiple <a href="builder/struct.Arg.html">arguments</a> to this group by name</p>
|
||
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'f'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'c'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"req_flags"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"flag"</span>, <span class="string">"color"</span>]))
|
||
.<span class="ident">get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"myprog"</span>, <span class="string">"-f"</span>]);
|
||
<span class="comment">// maybe we don't know which of the two flags was used...</span>
|
||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">contains_id</span>(<span class="string">"req_flags"</span>));
|
||
<span class="comment">// but we can also check individually if needed</span>
|
||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">contains_id</span>(<span class="string">"flag"</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_args" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#204-206">source</a></span><h4 class="code-header">pub fn <a href="#method.get_args" class="fnname">get_args</a>(&self) -> impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>></h4></section></summary><div class="docblock"><p>Getters for all args. It will return a vector of <code>Id</code></p>
|
||
<h5 id="example"><a href="#example">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">args</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> <span class="op">=</span> <span class="macro">vec!</span>[<span class="string">"a1"</span>.<span class="ident">into</span>(), <span class="string">"a4"</span>.<span class="ident">into</span>()];
|
||
<span class="kw">let</span> <span class="ident">grp</span> <span class="op">=</span> <span class="ident">ArgGroup::new</span>(<span class="string">"program"</span>).<span class="ident">args</span>(<span class="kw-2">&</span><span class="ident">args</span>);
|
||
|
||
<span class="kw">for</span> (<span class="ident">pos</span>, <span class="ident">arg</span>) <span class="kw">in</span> <span class="ident">grp</span>.<span class="ident">get_args</span>().<span class="ident">enumerate</span>() {
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span><span class="ident">arg</span>, <span class="ident">args</span>[<span class="ident">pos</span>]);
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.multiple" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#255-258">source</a></span><h4 class="code-header">pub fn <a href="#method.multiple" class="fnname">multiple</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><div class="docblock"><p>Allows more than one of the <a href="builder/struct.Arg.html"><code>Arg</code></a>s in this group to be used. (Default: <code>false</code>)</p>
|
||
<h5 id="examples-5"><a href="#examples-5">Examples</a></h5>
|
||
<p>Notice in this example we use <em>both</em> the <code>-f</code> and <code>-c</code> flags which are both part of the
|
||
group</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'f'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'c'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"req_flags"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"flag"</span>, <span class="string">"color"</span>])
|
||
.<span class="ident">multiple</span>(<span class="bool-val">true</span>))
|
||
.<span class="ident">get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"myprog"</span>, <span class="string">"-f"</span>, <span class="string">"-c"</span>]);
|
||
<span class="comment">// maybe we don't know which of the two flags was used...</span>
|
||
<span class="macro">assert!</span>(<span class="ident">m</span>.<span class="ident">contains_id</span>(<span class="string">"req_flags"</span>));</code></pre></div>
|
||
<p>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.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'f'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'c'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"req_flags"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"flag"</span>, <span class="string">"color"</span>]))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"myprog"</span>, <span class="string">"-f"</span>, <span class="string">"-c"</span>]);
|
||
<span class="comment">// Because we used both args in the group it's an error</span>
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">result</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">ErrorKind::ArgumentConflict</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_multiple" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#273-275">source</a></span><h4 class="code-header">pub fn <a href="#method.is_multiple" class="fnname">is_multiple</a>(&mut 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>Return true if the group allows more than one of the arguments
|
||
in this group to be used. (Default: <code>false</code>)</p>
|
||
<h5 id="example-1"><a href="#example-1">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">group</span> <span class="op">=</span> <span class="ident">ArgGroup::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"f"</span>, <span class="string">"c"</span>])
|
||
.<span class="ident">multiple</span>(<span class="bool-val">true</span>);
|
||
|
||
<span class="macro">assert!</span>(<span class="ident">group</span>.<span class="ident">is_multiple</span>());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.required" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#316-319">source</a></span><h4 class="code-header">pub fn <a href="#method.required" class="fnname">required</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a>) -> Self</h4></section></summary><div class="docblock"><p>Require an argument from the group to be present when parsing.</p>
|
||
<p>This is unless conflicting with another argument. A required group will be displayed in
|
||
the usage string of the application in the format <code><arg|arg2|arg3></code>.</p>
|
||
<p><strong>NOTE:</strong> This setting only applies to the current <a href="builder/struct.Command.html"><code>Command</code></a> / <a href="trait.Subcommand.html"><code>Subcommand</code></a>s, and not
|
||
globally.</p>
|
||
<p><strong>NOTE:</strong> By default, <a href="builder/struct.ArgGroup.html#method.multiple"><code>ArgGroup::multiple</code></a> is set to <code>false</code> which when combined with
|
||
<code>ArgGroup::required(true)</code> states, “One and <em>only one</em> arg must be used from this group.
|
||
Use of more than one arg is an error.” Vice setting <code>ArgGroup::multiple(true)</code> which
|
||
states, ’<em>At least</em> one arg from this group must be used. Using multiple is OK.“</p>
|
||
<h5 id="examples-6"><a href="#examples-6">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'f'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'c'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"req_flags"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"flag"</span>, <span class="string">"color"</span>])
|
||
.<span class="ident">required</span>(<span class="bool-val">true</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"myprog"</span>]);
|
||
<span class="comment">// Because we didn't use any of the args in the group, it's an error</span>
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">result</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">ErrorKind::MissingRequiredArgument</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.requires" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#356-363">source</a></span><h4 class="code-header">pub fn <a href="#method.requires" class="fnname">requires</a>(self, id: impl <a class="trait" href="builder/trait.IntoResettable.html" title="trait clap::builder::IntoResettable">IntoResettable</a><<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>>) -> Self</h4></section></summary><div class="docblock"><p>Specify an argument or group that must be present when this group is.</p>
|
||
<p>This is not to be confused with a <a href="builder/struct.ArgGroup.html#method.required">required group</a>. Requirement rules function just like
|
||
<a href="builder/struct.Arg.html#method.requires">argument requirement rules</a>, you can name other arguments or groups that must be present
|
||
when any one of the arguments from this group is used.</p>
|
||
<p><strong>NOTE:</strong> The name provided may be an argument or group name</p>
|
||
<h5 id="examples-7"><a href="#examples-7">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'f'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'c'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'d'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"req_flags"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"flag"</span>, <span class="string">"color"</span>])
|
||
.<span class="ident">requires</span>(<span class="string">"debug"</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"myprog"</span>, <span class="string">"-c"</span>]);
|
||
<span class="comment">// because we used an arg from the group, and the group requires "-d" to be used, it's an</span>
|
||
<span class="comment">// error</span>
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">result</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">ErrorKind::MissingRequiredArgument</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.requires_all" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#403-408">source</a></span><h4 class="code-header">pub fn <a href="#method.requires_all" class="fnname">requires_all</a>(self, ns: impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>>>) -> Self</h4></section></summary><div class="docblock"><p>Specify arguments or groups that must be present when this group is.</p>
|
||
<p>This is not to be confused with a <a href="builder/struct.ArgGroup.html#method.required">required group</a>. Requirement rules function just like
|
||
<a href="builder/struct.Arg.html#method.requires_ifs">argument requirement rules</a>, you can name other arguments or groups that must be present
|
||
when one of the arguments from this group is used.</p>
|
||
<p><strong>NOTE:</strong> The names provided may be an argument or group name</p>
|
||
<h5 id="examples-8"><a href="#examples-8">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'f'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'c'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'d'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"verb"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'v'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"req_flags"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"flag"</span>, <span class="string">"color"</span>])
|
||
.<span class="ident">requires_all</span>([<span class="string">"debug"</span>, <span class="string">"verb"</span>]))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"myprog"</span>, <span class="string">"-c"</span>, <span class="string">"-d"</span>]);
|
||
<span class="comment">// because we used an arg from the group, and the group requires "-d" and "-v" to be used,</span>
|
||
<span class="comment">// yet we only used "-d" it's an error</span>
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">result</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">ErrorKind::MissingRequiredArgument</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.conflicts_with" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#443-450">source</a></span><h4 class="code-header">pub fn <a href="#method.conflicts_with" class="fnname">conflicts_with</a>(self, id: impl <a class="trait" href="builder/trait.IntoResettable.html" title="trait clap::builder::IntoResettable">IntoResettable</a><<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>>) -> Self</h4></section></summary><div class="docblock"><p>Specify an argument or group that must <strong>not</strong> be present when this group is.</p>
|
||
<p>Exclusion (aka conflict) rules function just like <a href="builder/struct.Arg.html#method.conflicts_with">argument exclusion rules</a>, you can name
|
||
other arguments or groups that must <em>not</em> be present when one of the arguments from this
|
||
group are used.</p>
|
||
<p><strong>NOTE:</strong> The name provided may be an argument, or group name</p>
|
||
<h5 id="examples-9"><a href="#examples-9">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'f'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'c'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'d'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"req_flags"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"flag"</span>, <span class="string">"color"</span>])
|
||
.<span class="ident">conflicts_with</span>(<span class="string">"debug"</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"myprog"</span>, <span class="string">"-c"</span>, <span class="string">"-d"</span>]);
|
||
<span class="comment">// because we used an arg from the group, and the group conflicts with "-d", it's an error</span>
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">result</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">ErrorKind::ArgumentConflict</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.conflicts_with_all" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#489-494">source</a></span><h4 class="code-header">pub fn <a href="#method.conflicts_with_all" class="fnname">conflicts_with_all</a>(<br> self,<br> ns: impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>>><br>) -> Self</h4></section></summary><div class="docblock"><p>Specify arguments or groups that must <strong>not</strong> be present when this group is.</p>
|
||
<p>Exclusion rules function just like <a href="builder/struct.Arg.html#method.conflicts_with_all">argument exclusion rules</a>, you can name other arguments
|
||
or groups that must <em>not</em> be present when one of the arguments from this group are used.</p>
|
||
<p><strong>NOTE:</strong> The names provided may be an argument, or group name</p>
|
||
<h5 id="examples-10"><a href="#examples-10">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"myprog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"flag"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'f'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'c'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'d'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"verb"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'v'</span>)
|
||
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
|
||
.<span class="ident">group</span>(<span class="ident">ArgGroup::new</span>(<span class="string">"req_flags"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"flag"</span>, <span class="string">"color"</span>])
|
||
.<span class="ident">conflicts_with_all</span>([<span class="string">"debug"</span>, <span class="string">"verb"</span>]))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"myprog"</span>, <span class="string">"-c"</span>, <span class="string">"-v"</span>]);
|
||
<span class="comment">// because we used an arg from the group, and the group conflicts with either "-v" or "-d"</span>
|
||
<span class="comment">// it's an error</span>
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">result</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">ErrorKind::ArgumentConflict</span>);</code></pre></div>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ArgGroup-1" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#498-510">source</a></span><a href="#impl-ArgGroup-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section></summary><div class="docblock"><h4 id="reflection"><a href="#reflection">Reflection</a></h4></div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_id" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#501-503">source</a></span><h4 class="code-header">pub fn <a href="#method.get_id" class="fnname">get_id</a>(&self) -> &<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a></h4></section></summary><div class="docblock"><p>Get the name of the group</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_required_set" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#507-509">source</a></span><h4 class="code-header">pub fn <a href="#method.is_required_set" class="fnname">is_required_set</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>Reports whether <a href="builder/struct.ArgGroup.html#method.required" title="ArgGroup::required"><code>ArgGroup::required</code></a> is set</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-ArgGroup" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#85">source</a></span><a href="#impl-Clone-for-ArgGroup" 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="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</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/arg_group.rs.html#85">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="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</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-ArgGroup" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#85">source</a></span><a href="#impl-Debug-for-ArgGroup" 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="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</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/arg_group.rs.html#85">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-Default-for-ArgGroup" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#85">source</a></span><a href="#impl-Default-for-ArgGroup" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#85">source</a></span><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h4></section></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.64.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3C%26ArgGroup%3E-for-ArgGroup" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#512-516">source</a></span><a href="#impl-From%3C%26ArgGroup%3E-for-ArgGroup" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><&<a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a>> for <a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></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"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#513-515">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>(g: &<a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a>) -> Self</h4></section></summary><div class='docblock'><p>Converts to this type from the input type.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CArgGroup%3E-for-ArgGroup" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#85">source</a></span><a href="#impl-PartialEq%3CArgGroup%3E-for-ArgGroup" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a>> for <a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#85">source</a></span><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a>) -> <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>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||
by <code>==</code>. <a href="https://doc.rust-lang.org/1.64.0/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#85">source</a></span><a href="#method.ne" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: &<a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a>) -> <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>This method tests for <code>!=</code>.</p>
|
||
</div></details></div></details><section id="impl-Eq-for-ArgGroup" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#85">source</a></span><a href="#impl-Eq-for-ArgGroup" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section><section id="impl-StructuralEq-for-ArgGroup" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#85">source</a></span><a href="#impl-StructuralEq-for-ArgGroup" 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.StructuralEq.html" title="trait core::marker::StructuralEq">StructuralEq</a> for <a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section><section id="impl-StructuralPartialEq-for-ArgGroup" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/builder/arg_group.rs.html#85">source</a></span><a href="#impl-StructuralPartialEq-for-ArgGroup" 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.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section></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-ArgGroup" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ArgGroup" 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="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section><section id="impl-Send-for-ArgGroup" class="impl has-srclink"><a href="#impl-Send-for-ArgGroup" 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="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section><section id="impl-Sync-for-ArgGroup" class="impl has-srclink"><a href="#impl-Sync-for-ArgGroup" 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="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section><section id="impl-Unpin-for-ArgGroup" class="impl has-srclink"><a href="#impl-Unpin-for-ArgGroup" 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="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</a></h3></section><section id="impl-UnwindSafe-for-ArgGroup" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ArgGroup" 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="struct" href="builder/struct.ArgGroup.html" title="struct clap::builder::ArgGroup">ArgGroup</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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-1" 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-1" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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-ArgGroup" 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> |