mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 16:38:24 +00:00
252 lines
50 KiB
HTML
252 lines
50 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"><title>ArgAction in clap_builder::builder - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="clap_builder" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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" title="show sidebar"></button><a class="logo-container" href="../../clap_builder/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../clap_builder/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><h2><a href="../../clap_builder/index.html">clap_builder</a><span class="version">4.5.2</span></h2></div><h2 class="location"><a href="#">ArgAction</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block variant"><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.HelpLong">HelpLong</a></li><li><a href="#variant.HelpShort">HelpShort</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><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.takes_values">takes_values</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><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><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-ArgAction">Freeze</a></li><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><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-ToOwned-for-T">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li></ul></section><h2><a href="index.html">In clap_builder::builder</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../clap_builder/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Enum <a href="../index.html">clap_builder</a>::<wbr><a href="index.html">builder</a>::<wbr><a class="enum" href="#">ArgAction</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/clap_builder/builder/action.rs.html#32-339">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code><div class="code-attribute">#[non_exhaustive]</div>pub enum ArgAction {
|
||
Set,
|
||
Append,
|
||
SetTrue,
|
||
SetFalse,
|
||
Count,
|
||
Help,
|
||
HelpShort,
|
||
HelpLong,
|
||
Version,
|
||
}</code></pre><details class="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 class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"special-help"</span>)
|
||
.short(<span class="string">'?'</span>)
|
||
.action(clap::ArgAction::Help)
|
||
);
|
||
|
||
<span class="comment">// Existing help still exists
|
||
</span><span class="kw">let </span>err = cmd.clone().try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"-h"</span>]).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.kind(), clap::error::ErrorKind::DisplayHelp);
|
||
|
||
<span class="comment">// New help available
|
||
</span><span class="kw">let </span>err = cmd.try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"-?"</span>]).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.kind(), clap::error::ErrorKind::DisplayHelp);</code></pre></div>
|
||
</div></details><h2 id="variants" class="variants section-header">Variants (Non-exhaustive)<a href="#variants" class="anchor">§</a></h2><details class="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><div class="variants"><section id="variant.Set" class="variant"><a href="#variant.Set" class="anchor">§</a><h3 class="code-header">Set</h3></section><div class="docblock"><p>When encountered, store the associated value(s) in <a href="../parser/struct.ArgMatches.html" title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a></p>
|
||
<p><strong>NOTE:</strong> If the argument has previously been seen, it will result in a
|
||
<a href="../error/enum.ErrorKind.html#variant.ArgumentConflict" title="variant clap_builder::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||
<a href="struct.Command.html#method.args_override_self" title="method clap_builder::builder::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</p>
|
||
<h4 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"flag"</span>)
|
||
.long(<span class="string">"flag"</span>)
|
||
.action(clap::ArgAction::Set)
|
||
);
|
||
|
||
<span class="kw">let </span>matches = cmd.try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"value"</span>]).unwrap();
|
||
<span class="macro">assert!</span>(matches.contains_id(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
matches.get_many::<String>(<span class="string">"flag"</span>).unwrap_or_default().map(|v| v.as_str()).collect::<Vec<<span class="kw">_</span>>>(),
|
||
<span class="macro">vec!</span>[<span class="string">"value"</span>]
|
||
);</code></pre></div>
|
||
</div><section id="variant.Append" class="variant"><a href="#variant.Append" class="anchor">§</a><h3 class="code-header">Append</h3></section><div class="docblock"><p>When encountered, store the associated value(s) in <a href="../parser/struct.ArgMatches.html" title="struct clap_builder::parser::ArgMatches"><code>ArgMatches</code></a></p>
|
||
<h4 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"flag"</span>)
|
||
.long(<span class="string">"flag"</span>)
|
||
.action(clap::ArgAction::Append)
|
||
);
|
||
|
||
<span class="kw">let </span>matches = cmd.try_get_matches_from([<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>]).unwrap();
|
||
<span class="macro">assert!</span>(matches.contains_id(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
matches.get_many::<String>(<span class="string">"flag"</span>).unwrap_or_default().map(|v| v.as_str()).collect::<Vec<<span class="kw">_</span>>>(),
|
||
<span class="macro">vec!</span>[<span class="string">"value1"</span>, <span class="string">"value2"</span>]
|
||
);</code></pre></div>
|
||
</div><section id="variant.SetTrue" class="variant"><a href="#variant.SetTrue" class="anchor">§</a><h3 class="code-header">SetTrue</h3></section><div class="docblock"><p>When encountered, act as if <code>"true"</code> was encountered on the command-line</p>
|
||
<p>If no <a href="struct.Arg.html#method.default_value" title="method clap_builder::builder::Arg::default_value"><code>default_value</code></a> is set, it will be <code>false</code>.</p>
|
||
<p>No value is allowed. To optionally accept a value, see
|
||
<a href="struct.Arg.html#method.default_missing_value" title="method clap_builder::builder::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="variant clap_builder::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||
<a href="struct.Command.html#method.args_override_self" title="method clap_builder::builder::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</p>
|
||
<h4 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"flag"</span>)
|
||
.long(<span class="string">"flag"</span>)
|
||
.action(clap::ArgAction::SetTrue)
|
||
);
|
||
|
||
<span class="kw">let </span>matches = cmd.clone().try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).unwrap();
|
||
<span class="macro">assert!</span>(matches.contains_id(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
matches.get_flag(<span class="string">"flag"</span>),
|
||
<span class="bool-val">true
|
||
</span>);
|
||
|
||
<span class="kw">let </span>matches = cmd.try_get_matches_from([<span class="string">"mycmd"</span>]).unwrap();
|
||
<span class="macro">assert!</span>(matches.contains_id(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
matches.get_flag(<span class="string">"flag"</span>),
|
||
<span class="bool-val">false
|
||
</span>);</code></pre></div>
|
||
<p>You can use <a href="trait.TypedValueParser.html#method.map" title="method clap_builder::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>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"flag"</span>)
|
||
.long(<span class="string">"flag"</span>)
|
||
.action(clap::ArgAction::SetTrue)
|
||
.value_parser(
|
||
BoolishValueParser::new()
|
||
.map(|b| -> usize {
|
||
<span class="kw">if </span>b { <span class="number">10 </span>} <span class="kw">else </span>{ <span class="number">5 </span>}
|
||
})
|
||
)
|
||
);
|
||
|
||
<span class="kw">let </span>matches = cmd.clone().try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).unwrap();
|
||
<span class="macro">assert!</span>(matches.contains_id(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
matches.get_one::<usize>(<span class="string">"flag"</span>).copied(),
|
||
<span class="prelude-val">Some</span>(<span class="number">10</span>)
|
||
);
|
||
|
||
<span class="kw">let </span>matches = cmd.try_get_matches_from([<span class="string">"mycmd"</span>]).unwrap();
|
||
<span class="macro">assert!</span>(matches.contains_id(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
matches.get_one::<usize>(<span class="string">"flag"</span>).copied(),
|
||
<span class="prelude-val">Some</span>(<span class="number">5</span>)
|
||
);</code></pre></div>
|
||
</div><section id="variant.SetFalse" class="variant"><a href="#variant.SetFalse" class="anchor">§</a><h3 class="code-header">SetFalse</h3></section><div class="docblock"><p>When encountered, act as if <code>"false"</code> was encountered on the command-line</p>
|
||
<p>If no <a href="struct.Arg.html#method.default_value" title="method clap_builder::builder::Arg::default_value"><code>default_value</code></a> is set, it will be <code>true</code>.</p>
|
||
<p>No value is allowed. To optionally accept a value, see
|
||
<a href="struct.Arg.html#method.default_missing_value" title="method clap_builder::builder::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="variant clap_builder::error::ErrorKind::ArgumentConflict"><code>ArgumentConflict</code></a> unless
|
||
<a href="struct.Command.html#method.args_override_self" title="method clap_builder::builder::Command::args_override_self"><code>Command::args_override_self(true)</code></a> is set.</p>
|
||
<h4 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"flag"</span>)
|
||
.long(<span class="string">"flag"</span>)
|
||
.action(clap::ArgAction::SetFalse)
|
||
);
|
||
|
||
<span class="kw">let </span>matches = cmd.clone().try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>]).unwrap();
|
||
<span class="macro">assert!</span>(matches.contains_id(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
matches.get_flag(<span class="string">"flag"</span>),
|
||
<span class="bool-val">false
|
||
</span>);
|
||
|
||
<span class="kw">let </span>matches = cmd.try_get_matches_from([<span class="string">"mycmd"</span>]).unwrap();
|
||
<span class="macro">assert!</span>(matches.contains_id(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
matches.get_flag(<span class="string">"flag"</span>),
|
||
<span class="bool-val">true
|
||
</span>);</code></pre></div>
|
||
</div><section id="variant.Count" class="variant"><a href="#variant.Count" class="anchor">§</a><h3 class="code-header">Count</h3></section><div class="docblock"><p>When encountered, increment a <code>u8</code> counter</p>
|
||
<p>If no <a href="struct.Arg.html#method.default_value" title="method clap_builder::builder::Arg::default_value"><code>default_value</code></a> is set, it will be <code>0</code>.</p>
|
||
<p>No value is allowed. To optionally accept a value, see
|
||
<a href="struct.Arg.html#method.default_missing_value" title="method clap_builder::builder::Arg::default_missing_value"><code>Arg::default_missing_value</code></a></p>
|
||
<h4 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"flag"</span>)
|
||
.long(<span class="string">"flag"</span>)
|
||
.action(clap::ArgAction::Count)
|
||
);
|
||
|
||
<span class="kw">let </span>matches = cmd.clone().try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"--flag"</span>, <span class="string">"--flag"</span>]).unwrap();
|
||
<span class="macro">assert!</span>(matches.contains_id(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
matches.get_count(<span class="string">"flag"</span>),
|
||
<span class="number">2
|
||
</span>);
|
||
|
||
<span class="kw">let </span>matches = cmd.try_get_matches_from([<span class="string">"mycmd"</span>]).unwrap();
|
||
<span class="macro">assert!</span>(matches.contains_id(<span class="string">"flag"</span>));
|
||
<span class="macro">assert_eq!</span>(
|
||
matches.get_count(<span class="string">"flag"</span>),
|
||
<span class="number">0
|
||
</span>);</code></pre></div>
|
||
</div><section id="variant.Help" class="variant"><a href="#variant.Help" class="anchor">§</a><h3 class="code-header">Help</h3></section><div class="docblock"><p>When encountered, display <a href="struct.Command.html#method.print_help" title="method clap_builder::builder::Command::print_help"><code>Command::print_help</code></a></p>
|
||
<p>Depending on the flag, <a href="struct.Command.html#method.print_long_help" title="method clap_builder::builder::Command::print_long_help"><code>Command::print_long_help</code></a> may be shown</p>
|
||
<h4 id="examples-6"><a class="doc-anchor" href="#examples-6">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"special-help"</span>)
|
||
.short(<span class="string">'?'</span>)
|
||
.action(clap::ArgAction::Help)
|
||
);
|
||
|
||
<span class="comment">// Existing help still exists
|
||
</span><span class="kw">let </span>err = cmd.clone().try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"-h"</span>]).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.kind(), clap::error::ErrorKind::DisplayHelp);
|
||
|
||
<span class="comment">// New help available
|
||
</span><span class="kw">let </span>err = cmd.try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"-?"</span>]).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.kind(), clap::error::ErrorKind::DisplayHelp);</code></pre></div>
|
||
</div><section id="variant.HelpShort" class="variant"><a href="#variant.HelpShort" class="anchor">§</a><h3 class="code-header">HelpShort</h3></section><div class="docblock"><p>When encountered, display <a href="struct.Command.html#method.print_help" title="method clap_builder::builder::Command::print_help"><code>Command::print_help</code></a></p>
|
||
<h4 id="examples-7"><a class="doc-anchor" href="#examples-7">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"special-help"</span>)
|
||
.short(<span class="string">'?'</span>)
|
||
.action(clap::ArgAction::HelpShort)
|
||
);
|
||
|
||
<span class="comment">// Existing help still exists
|
||
</span><span class="kw">let </span>err = cmd.clone().try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"-h"</span>]).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.kind(), clap::error::ErrorKind::DisplayHelp);
|
||
|
||
<span class="comment">// New help available
|
||
</span><span class="kw">let </span>err = cmd.try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"-?"</span>]).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.kind(), clap::error::ErrorKind::DisplayHelp);</code></pre></div>
|
||
</div><section id="variant.HelpLong" class="variant"><a href="#variant.HelpLong" class="anchor">§</a><h3 class="code-header">HelpLong</h3></section><div class="docblock"><p>When encountered, display <a href="struct.Command.html#method.print_long_help" title="method clap_builder::builder::Command::print_long_help"><code>Command::print_long_help</code></a></p>
|
||
<h4 id="examples-8"><a class="doc-anchor" href="#examples-8">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"special-help"</span>)
|
||
.short(<span class="string">'?'</span>)
|
||
.action(clap::ArgAction::HelpLong)
|
||
);
|
||
|
||
<span class="comment">// Existing help still exists
|
||
</span><span class="kw">let </span>err = cmd.clone().try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"-h"</span>]).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.kind(), clap::error::ErrorKind::DisplayHelp);
|
||
|
||
<span class="comment">// New help available
|
||
</span><span class="kw">let </span>err = cmd.try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"-?"</span>]).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.kind(), clap::error::ErrorKind::DisplayHelp);</code></pre></div>
|
||
</div><section id="variant.Version" class="variant"><a href="#variant.Version" class="anchor">§</a><h3 class="code-header">Version</h3></section><div class="docblock"><p>When encountered, display <a href="struct.Command.html#method.version" title="method clap_builder::builder::Command::version"><code>Command::version</code></a></p>
|
||
<p>Depending on the flag, <a href="struct.Command.html#method.long_version" title="method clap_builder::builder::Command::long_version"><code>Command::long_version</code></a> may be shown</p>
|
||
<h4 id="examples-9"><a class="doc-anchor" href="#examples-9">§</a>Examples</h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"mycmd"</span>)
|
||
.version(<span class="string">"1.0.0"</span>)
|
||
.arg(
|
||
Arg::new(<span class="string">"special-version"</span>)
|
||
.long(<span class="string">"special-version"</span>)
|
||
.action(clap::ArgAction::Version)
|
||
);
|
||
|
||
<span class="comment">// Existing help still exists
|
||
</span><span class="kw">let </span>err = cmd.clone().try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"--version"</span>]).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.kind(), clap::error::ErrorKind::DisplayVersion);
|
||
|
||
<span class="comment">// New help available
|
||
</span><span class="kw">let </span>err = cmd.try_get_matches_from([<span class="string">"mycmd"</span>, <span class="string">"--special-version"</span>]).unwrap_err();
|
||
<span class="macro">assert_eq!</span>(err.kind(), clap::error::ErrorKind::DisplayVersion);</code></pre></div>
|
||
</div></div><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ArgAction" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/action.rs.html#341-416">source</a><a href="#impl-ArgAction" class="anchor">§</a><h3 class="code-header">impl <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.takes_values" class="method"><a class="src rightside" href="../../src/clap_builder/builder/action.rs.html#346-358">source</a><h4 class="code-header">pub fn <a href="#method.takes_values" class="fn">takes_values</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.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="struct.Arg.html#method.default_values" title="method clap_builder::builder::Arg::default_values"><code>default_values</code></a> and [<code>env</code>][super::Arg::env] may still be
|
||
processed.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-ArgAction" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/action.rs.html#29">source</a><a href="#impl-Clone-for-ArgAction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/action.rs.html#29">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.78.0/src/core/clone.rs.html#169">source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&Self</a>)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-ArgAction" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/action.rs.html#29">source</a><a href="#impl-Debug-for-ArgAction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/action.rs.html#29">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.78.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.78.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.78.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoResettable%3CArgAction%3E-for-ArgAction" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/resettable.rs.html#160-164">source</a><a href="#impl-IntoResettable%3CArgAction%3E-for-ArgAction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoResettable.html" title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a>> for <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_resettable" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/resettable.rs.html#161-163">source</a><a href="#method.into_resettable" class="anchor">§</a><h4 class="code-header">fn <a href="trait.IntoResettable.html#tymethod.into_resettable" class="fn">into_resettable</a>(self) -> <a class="enum" href="enum.Resettable.html" title="enum clap_builder::builder::Resettable">Resettable</a><<a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a>></h4></section></summary><div class='docblock'>Convert to the intended resettable type</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoResettable%3CArgAction%3E-for-Option%3CArgAction%3E" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/resettable.rs.html#88-95">source</a><a href="#impl-IntoResettable%3CArgAction%3E-for-Option%3CArgAction%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoResettable.html" title="trait clap_builder::builder::IntoResettable">IntoResettable</a><<a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a>> for <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_resettable-1" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/resettable.rs.html#89-94">source</a><a href="#method.into_resettable-1" class="anchor">§</a><h4 class="code-header">fn <a href="trait.IntoResettable.html#tymethod.into_resettable" class="fn">into_resettable</a>(self) -> <a class="enum" href="enum.Resettable.html" title="enum clap_builder::builder::Resettable">Resettable</a><<a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a>></h4></section></summary><div class='docblock'>Convert to the intended resettable type</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-ArgAction" class="impl"><a href="#impl-Freeze-for-ArgAction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h3></section><section id="impl-RefUnwindSafe-for-ArgAction" class="impl"><a href="#impl-RefUnwindSafe-for-ArgAction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Send-for-ArgAction" class="impl"><a href="#impl-Send-for-ArgAction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Sync-for-ArgAction" class="impl"><a href="#impl-Sync-for-ArgAction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h3></section><section id="impl-Unpin-for-ArgAction" class="impl"><a href="#impl-Unpin-for-ArgAction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h3></section><section id="impl-UnwindSafe-for-ArgAction" class="impl"><a href="#impl-UnwindSafe-for-ArgAction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.78.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.78.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.78.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.78.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="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.Into.html#tymethod.into" class="fn">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.78.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/alloc/borrow.rs.html#83-85">source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.78.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |