272 lines
69 KiB
HTML
272 lines
69 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="Command line argument parser kind of error"><meta name="keywords" content="rust, rustlang, rust-lang, ErrorKind"><title>ErrorKind 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 src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc enum"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><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">Enum ErrorKind</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#variants">Variants</a></h3><div class="sidebar-links"><a href="#variant.ArgumentConflict">ArgumentConflict</a><a href="#variant.ArgumentNotFound">ArgumentNotFound</a><a href="#variant.DisplayHelp">DisplayHelp</a><a href="#variant.DisplayHelpOnMissingArgumentOrSubcommand">DisplayHelpOnMissingArgumentOrSubcommand</a><a href="#variant.DisplayVersion">DisplayVersion</a><a href="#variant.EmptyValue">EmptyValue</a><a href="#variant.Format">Format</a><a href="#variant.InvalidSubcommand">InvalidSubcommand</a><a href="#variant.InvalidUtf8">InvalidUtf8</a><a href="#variant.InvalidValue">InvalidValue</a><a href="#variant.Io">Io</a><a href="#variant.MissingRequiredArgument">MissingRequiredArgument</a><a href="#variant.MissingSubcommand">MissingSubcommand</a><a href="#variant.NoEquals">NoEquals</a><a href="#variant.TooFewValues">TooFewValues</a><a href="#variant.TooManyOccurrences">TooManyOccurrences</a><a href="#variant.TooManyValues">TooManyValues</a><a href="#variant.UnexpectedMultipleUsage">UnexpectedMultipleUsage</a><a href="#variant.UnknownArgument">UnknownArgument</a><a href="#variant.UnrecognizedSubcommand">UnrecognizedSubcommand</a><a href="#variant.ValueValidation">ValueValidation</a><a href="#variant.WrongNumberOfValues">WrongNumberOfValues</a></div><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.as_str">as_str</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Debug">Debug</a><a href="#impl-Display">Display</a><a href="#impl-PartialEq%3CErrorKind%3E">PartialEq<ErrorKind></a><a href="#impl-StructuralPartialEq">StructuralPartialEq</a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-ToString">ToString</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2 class="location">Other items in<br><a href="index.html">clap</a></h2><div id="sidebar-vars" data-name="ErrorKind" data-ty="enum" data-relpath=""></div><script defer src="sidebar-items.js"></script></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"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Enum <a href="index.html">clap</a>::<wbr><a class="enum" href="#">ErrorKind</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><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/clap/error/kind.rs.html#4-399" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust enum"><code>#[non_exhaustive]
|
||
pub enum ErrorKind {
|
||
<details class="rustdoc-toggle type-contents-toggle"><summary class="hideme"><span>Show 22 variants</span></summary> InvalidValue,
|
||
UnknownArgument,
|
||
InvalidSubcommand,
|
||
UnrecognizedSubcommand,
|
||
EmptyValue,
|
||
NoEquals,
|
||
ValueValidation,
|
||
TooManyValues,
|
||
TooFewValues,
|
||
TooManyOccurrences,
|
||
WrongNumberOfValues,
|
||
ArgumentConflict,
|
||
MissingRequiredArgument,
|
||
MissingSubcommand,
|
||
UnexpectedMultipleUsage,
|
||
InvalidUtf8,
|
||
DisplayHelp,
|
||
DisplayHelpOnMissingArgumentOrSubcommand,
|
||
DisplayVersion,
|
||
ArgumentNotFound,
|
||
Io,
|
||
Format,
|
||
</details>}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Command line argument parser kind of error</p>
|
||
</div></details><h2 id="variants" class="variants small-section-header">Variants (Non-exhaustive)<a href="#variants" class="anchor"></a></h2><details class="rustdoc-toggle non-exhaustive"><summary class="hideme"><span>This enum is marked as non-exhaustive</span></summary><div class="docblock">Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.</div></details><h3 id="variant.InvalidValue" class="variant small-section-header"><a href="#variant.InvalidValue" class="anchor field"></a><code>InvalidValue</code></h3><div class="docblock"><p>Occurs when an <a href="struct.Arg.html" title="crate::Arg"><code>Arg</code></a> has a set of possible values,
|
||
and the user provides a value which isn’t in that set.</p>
|
||
<h4 id="examples" class="section-header"><a href="#examples">Examples</a></h4>
|
||
<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">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"speed"</span>)
|
||
.<span class="ident">possible_value</span>(<span class="string">"fast"</span>)
|
||
.<span class="ident">possible_value</span>(<span class="string">"slow"</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"other"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::InvalidValue</span>);</code></pre></div>
|
||
</div><h3 id="variant.UnknownArgument" class="variant small-section-header"><a href="#variant.UnknownArgument" class="anchor field"></a><code>UnknownArgument</code></h3><div class="docblock"><p>Occurs when a user provides a flag, option, argument or subcommand which isn’t defined.</p>
|
||
<h4 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="macro">arg!</span>(<span class="op">-</span><span class="op">-</span><span class="ident">flag</span> <span class="string">"some flag"</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--other"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::UnknownArgument</span>);</code></pre></div>
|
||
</div><h3 id="variant.InvalidSubcommand" class="variant small-section-header"><a href="#variant.InvalidSubcommand" class="anchor field"></a><code>InvalidSubcommand</code></h3><div class="docblock"><p>Occurs when the user provides an unrecognized <a href="trait.Subcommand.html"><code>Subcommand</code></a> which meets the threshold for
|
||
being similar enough to an existing subcommand.
|
||
If it doesn’t meet the threshold, or the ‘suggestions’ feature is disabled,
|
||
the more general <a href="error/enum.ErrorKind.html#variant.UnknownArgument"><code>UnknownArgument</code></a> error is returned.</p>
|
||
<h4 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">subcommand</span>(<span class="ident">Command::new</span>(<span class="string">"config"</span>)
|
||
.<span class="ident">about</span>(<span class="string">"Used for configuration"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"config_file"</span>)
|
||
.<span class="ident">help</span>(<span class="string">"The configuration file to use"</span>)
|
||
.<span class="ident">index</span>(<span class="number">1</span>)))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"confi"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::InvalidSubcommand</span>);</code></pre></div>
|
||
</div><h3 id="variant.UnrecognizedSubcommand" class="variant small-section-header"><a href="#variant.UnrecognizedSubcommand" class="anchor field"></a><code>UnrecognizedSubcommand</code></h3><div class="docblock"><p>Occurs when the user provides an unrecognized <a href="trait.Subcommand.html"><code>Subcommand</code></a> which either
|
||
doesn’t meet the threshold for being similar enough to an existing subcommand,
|
||
or the ‘suggestions’ feature is disabled.
|
||
Otherwise the more detailed <a href="error/enum.ErrorKind.html#variant.InvalidSubcommand"><code>InvalidSubcommand</code></a> error is returned.</p>
|
||
<p>This error typically happens when passing additional subcommand names to the <code>help</code>
|
||
subcommand. Otherwise, the more general <a href="error/enum.ErrorKind.html#variant.UnknownArgument"><code>UnknownArgument</code></a> error is used.</p>
|
||
<h4 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">subcommand</span>(<span class="ident">Command::new</span>(<span class="string">"config"</span>)
|
||
.<span class="ident">about</span>(<span class="string">"Used for configuration"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"config_file"</span>)
|
||
.<span class="ident">help</span>(<span class="string">"The configuration file to use"</span>)
|
||
.<span class="ident">index</span>(<span class="number">1</span>)))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"help"</span>, <span class="string">"nothing"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::UnrecognizedSubcommand</span>);</code></pre></div>
|
||
</div><h3 id="variant.EmptyValue" class="variant small-section-header"><a href="#variant.EmptyValue" class="anchor field"></a><code>EmptyValue</code></h3><div class="docblock"><p>Occurs when the user provides an empty value for an option that does not allow empty
|
||
values.</p>
|
||
<h4 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">takes_value</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">forbid_empty_values</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">long</span>(<span class="string">"color"</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--color="</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">res</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">res</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::EmptyValue</span>);</code></pre></div>
|
||
</div><h3 id="variant.NoEquals" class="variant small-section-header"><a href="#variant.NoEquals" class="anchor field"></a><code>NoEquals</code></h3><div class="docblock"><p>Occurs when the user doesn’t use equals for an option that requires equal
|
||
sign to provide values.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">takes_value</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">require_equals</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">long</span>(<span class="string">"color"</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--color"</span>, <span class="string">"red"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">res</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">res</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::NoEquals</span>);</code></pre></div>
|
||
</div><h3 id="variant.ValueValidation" class="variant small-section-header"><a href="#variant.ValueValidation" class="anchor field"></a><code>ValueValidation</code></h3><div class="docblock"><p>Occurs when the user provides a value for an argument with a custom validation and the
|
||
value fails that validation.</p>
|
||
<h4 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn</span> <span class="ident">is_numeric</span>(<span class="ident">val</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">String</span><span class="op">></span> {
|
||
<span class="kw">match</span> <span class="ident">val</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">i64</span><span class="op">></span>() {
|
||
<span class="prelude-val">Ok</span>(..) => <span class="prelude-val">Ok</span>(()),
|
||
<span class="prelude-val">Err</span>(..) => <span class="prelude-val">Err</span>(<span class="ident">String::from</span>(<span class="string">"Value wasn't a number!"</span>)),
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"num"</span>)
|
||
.<span class="ident">validator</span>(<span class="ident">is_numeric</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"NotANumber"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::ValueValidation</span>);</code></pre></div>
|
||
</div><h3 id="variant.TooManyValues" class="variant small-section-header"><a href="#variant.TooManyValues" class="anchor field"></a><code>TooManyValues</code></h3><div class="docblock"><p>Occurs when a user provides more values for an argument than were defined by setting
|
||
<a href="struct.Arg.html#method.max_values"><code>Arg::max_values</code></a>.</p>
|
||
<h4 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"arg"</span>)
|
||
.<span class="ident">max_values</span>(<span class="number">2</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"too"</span>, <span class="string">"many"</span>, <span class="string">"values"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::TooManyValues</span>);</code></pre></div>
|
||
</div><h3 id="variant.TooFewValues" class="variant small-section-header"><a href="#variant.TooFewValues" class="anchor field"></a><code>TooFewValues</code></h3><div class="docblock"><p>Occurs when the user provides fewer values for an argument than were defined by setting
|
||
<a href="struct.Arg.html#method.min_values"><code>Arg::min_values</code></a>.</p>
|
||
<h4 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"some_opt"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"opt"</span>)
|
||
.<span class="ident">min_values</span>(<span class="number">3</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--opt"</span>, <span class="string">"too"</span>, <span class="string">"few"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::TooFewValues</span>);</code></pre></div>
|
||
</div><h3 id="variant.TooManyOccurrences" class="variant small-section-header"><a href="#variant.TooManyOccurrences" class="anchor field"></a><code>TooManyOccurrences</code></h3><div class="docblock"><p>Occurs when a user provides more occurrences for an argument than were defined by setting
|
||
<a href="struct.Arg.html#method.max_occurrences"><code>Arg::max_occurrences</code></a>.</p>
|
||
<h4 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h4>
|
||
<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">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"verbosity"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'v'</span>)
|
||
.<span class="ident">max_occurrences</span>(<span class="number">2</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"-vvv"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::TooManyOccurrences</span>);</code></pre></div>
|
||
</div><h3 id="variant.WrongNumberOfValues" class="variant small-section-header"><a href="#variant.WrongNumberOfValues" class="anchor field"></a><code>WrongNumberOfValues</code></h3><div class="docblock"><p>Occurs when the user provides a different number of values for an argument than what’s
|
||
been defined by setting <a href="struct.Arg.html#method.number_of_values"><code>Arg::number_of_values</code></a> or than was implicitly set by
|
||
<a href="struct.Arg.html#method.value_names"><code>Arg::value_names</code></a>.</p>
|
||
<h4 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h4>
|
||
<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">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"some_opt"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"opt"</span>)
|
||
.<span class="ident">takes_value</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">number_of_values</span>(<span class="number">2</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--opt"</span>, <span class="string">"wrong"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::WrongNumberOfValues</span>);</code></pre></div>
|
||
</div><h3 id="variant.ArgumentConflict" class="variant small-section-header"><a href="#variant.ArgumentConflict" class="anchor field"></a><code>ArgumentConflict</code></h3><div class="docblock"><p>Occurs when the user provides two values which conflict with each other and can’t be used
|
||
together.</p>
|
||
<h4 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h4>
|
||
<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">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">conflicts_with</span>(<span class="string">"color"</span>))
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"color"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"color"</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--debug"</span>, <span class="string">"--color"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::ArgumentConflict</span>);</code></pre></div>
|
||
</div><h3 id="variant.MissingRequiredArgument" class="variant small-section-header"><a href="#variant.MissingRequiredArgument" class="anchor field"></a><code>MissingRequiredArgument</code></h3><div class="docblock"><p>Occurs when the user does not provide one or more required arguments.</p>
|
||
<h4 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h4>
|
||
<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">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"debug"</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">"prog"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::MissingRequiredArgument</span>);</code></pre></div>
|
||
</div><h3 id="variant.MissingSubcommand" class="variant small-section-header"><a href="#variant.MissingSubcommand" class="anchor field"></a><code>MissingSubcommand</code></h3><div class="docblock"><p>Occurs when a subcommand is required (as defined by <a href="struct.App.html#method.subcommand_required"><code>Command::subcommand_required</code></a>),
|
||
but the user does not provide one.</p>
|
||
<h4 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"prog"</span>)
|
||
.<span class="ident">subcommand_required</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">subcommand</span>(<span class="ident">Command::new</span>(<span class="string">"test"</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[
|
||
<span class="string">"myprog"</span>,
|
||
]);
|
||
<span class="macro">assert!</span>(<span class="ident">err</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">err</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::MissingSubcommand</span>);</code></pre></div>
|
||
</div><h3 id="variant.UnexpectedMultipleUsage" class="variant small-section-header"><a href="#variant.UnexpectedMultipleUsage" class="anchor field"></a><code>UnexpectedMultipleUsage</code></h3><div class="docblock"><p>Occurs when the user provides multiple values to an argument which doesn’t allow that.</p>
|
||
<h4 id="examples-13" class="section-header"><a href="#examples-13">Examples</a></h4>
|
||
<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">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">long</span>(<span class="string">"debug"</span>)
|
||
.<span class="ident">multiple_occurrences</span>(<span class="bool-val">false</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--debug"</span>, <span class="string">"--debug"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::UnexpectedMultipleUsage</span>);</code></pre></div>
|
||
</div><h3 id="variant.InvalidUtf8" class="variant small-section-header"><a href="#variant.InvalidUtf8" class="anchor field"></a><code>InvalidUtf8</code></h3><div class="docblock"><p>Occurs when the user provides a value containing invalid UTF-8.</p>
|
||
<p>To allow arbitrary data</p>
|
||
<ul>
|
||
<li>Set <a href="struct.Arg.html#method.allow_invalid_utf8"><code>Arg::allow_invalid_utf8</code></a> for argument values</li>
|
||
<li>Set <a href="struct.App.html#method.allow_invalid_utf8_for_external_subcommands"><code>Command::allow_invalid_utf8_for_external_subcommands</code></a> for external-subcommand
|
||
values</li>
|
||
</ul>
|
||
<h4 id="platform-specific" class="section-header"><a href="#platform-specific">Platform Specific</a></h4>
|
||
<p>Non-Windows platforms only (such as Linux, Unix, OSX, etc.)</p>
|
||
<h4 id="examples-14" class="section-header"><a href="#examples-14">Examples</a></h4>
|
||
<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">"prog"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"utf8"</span>)
|
||
.<span class="ident">short</span>(<span class="string">'u'</span>)
|
||
.<span class="ident">takes_value</span>(<span class="bool-val">true</span>))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="ident">OsString::from</span>(<span class="string">"myprog"</span>),
|
||
<span class="ident">OsString::from</span>(<span class="string">"-u"</span>),
|
||
<span class="ident">OsString::from_vec</span>(<span class="macro">vec!</span>[<span class="number">0xE9</span>])]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::InvalidUtf8</span>);</code></pre></div>
|
||
</div><h3 id="variant.DisplayHelp" class="variant small-section-header"><a href="#variant.DisplayHelp" class="anchor field"></a><code>DisplayHelp</code></h3><div class="docblock"><p>Not a true “error” as it means <code>--help</code> or similar was used.
|
||
The help message will be sent to <code>stdout</code>.</p>
|
||
<p><strong>Note</strong>: If the help is displayed due to an error (such as missing subcommands) it will
|
||
be sent to <code>stderr</code> instead of <code>stdout</code>.</p>
|
||
<h4 id="examples-15" class="section-header"><a href="#examples-15">Examples</a></h4>
|
||
<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">"prog"</span>)
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--help"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::DisplayHelp</span>);</code></pre></div>
|
||
</div><h3 id="variant.DisplayHelpOnMissingArgumentOrSubcommand" class="variant small-section-header"><a href="#variant.DisplayHelpOnMissingArgumentOrSubcommand" class="anchor field"></a><code>DisplayHelpOnMissingArgumentOrSubcommand</code></h3><div class="docblock"><p>Occurs when either an argument or a <a href="trait.Subcommand.html"><code>Subcommand</code></a> is required, as defined by
|
||
<a href="struct.App.html#method.arg_required_else_help"><code>Command::arg_required_else_help</code></a> , but the user did not provide
|
||
one.</p>
|
||
<h4 id="examples-16" class="section-header"><a href="#examples-16">Examples</a></h4>
|
||
<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">"prog"</span>)
|
||
.<span class="ident">arg_required_else_help</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">subcommand</span>(<span class="ident">Command::new</span>(<span class="string">"config"</span>)
|
||
.<span class="ident">about</span>(<span class="string">"Used for configuration"</span>)
|
||
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">"config_file"</span>)
|
||
.<span class="ident">help</span>(<span class="string">"The configuration file to use"</span>)))
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::DisplayHelpOnMissingArgumentOrSubcommand</span>);</code></pre></div>
|
||
</div><h3 id="variant.DisplayVersion" class="variant small-section-header"><a href="#variant.DisplayVersion" class="anchor field"></a><code>DisplayVersion</code></h3><div class="docblock"><p>Not a true “error” as it means <code>--version</code> or similar was used.
|
||
The message will be sent to <code>stdout</code>.</p>
|
||
<h4 id="examples-17" class="section-header"><a href="#examples-17">Examples</a></h4>
|
||
<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">"prog"</span>)
|
||
.<span class="ident">version</span>(<span class="string">"3.0"</span>)
|
||
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--version"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">kind</span>(), <span class="ident">ErrorKind::DisplayVersion</span>);</code></pre></div>
|
||
</div><h3 id="variant.ArgumentNotFound" class="variant small-section-header"><a href="#variant.ArgumentNotFound" class="anchor field"></a><code>ArgumentNotFound</code></h3><div class="docblock"><p>Occurs when using the <a href="struct.ArgMatches.html#method.value_of_t"><code>ArgMatches::value_of_t</code></a> and friends to convert an argument value
|
||
into type <code>T</code>, but the argument you requested wasn’t used. I.e. you asked for an argument
|
||
with name <code>config</code> to be converted, but <code>config</code> wasn’t used by the user.</p>
|
||
</div><h3 id="variant.Io" class="variant small-section-header"><a href="#variant.Io" class="anchor field"></a><code>Io</code></h3><div class="docblock"><p>Represents an <a href="https://doc.rust-lang.org/1.59.0/std/io/error/struct.Error.html">I/O error</a>.
|
||
Can occur when writing to <code>stderr</code> or <code>stdout</code> or reading a configuration file.</p>
|
||
</div><h3 id="variant.Format" class="variant small-section-header"><a href="#variant.Format" class="anchor field"></a><code>Format</code></h3><div class="docblock"><p>Represents a <a href="https://doc.rust-lang.org/1.59.0/core/fmt/struct.Error.html">Format error</a> (which is a part of <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Display.html"><code>Display</code></a>).
|
||
Typically caused by writing to <code>stderr</code> or <code>stdout</code>.</p>
|
||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#401-437" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_str" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#403-436" title="goto source code">[src]</a></div><a href="#method.as_str" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.as_str" class="fnname">as_str</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'static <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.str.html">str</a>></h4></div></summary><div class="docblock"><p>End-user description of the error case, where relevant</p>
|
||
</div></details></div></details><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><div id="impl-Clone" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#2" title="goto source code">[src]</a></div><a href="#impl-Clone" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#2" title="goto source code">[src]</a></div><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h4></div></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone_from" class="method trait-impl has-srclink"><div 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.59.0/src/core/clone.rs.html#130" title="goto source code">[src]</a></div><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.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.59.0/std/primitive.reference.html">&</a>Self)</h4></div></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.59.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><div id="impl-Debug" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#2" title="goto source code">[src]</a></div><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#2" title="goto source code">[src]</a></div><a href="#method.fmt-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.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.59.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Display" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#439-443" title="goto source code">[src]</a></div><a href="#impl-Display" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#440-442" title="goto source code">[src]</a></div><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Display.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialEq%3CErrorKind%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#2" title="goto source code">[src]</a></div><a href="#impl-PartialEq%3CErrorKind%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a>> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.eq" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#2" title="goto source code">[src]</a></div><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.bool.html">bool</a></h4></div></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.59.0/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ne" class="method trait-impl has-srclink"><div 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.59.0/src/core/cmp.rs.html#219" title="goto source code">[src]</a></div><a href="#method.ne" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||
</div></details></div></details><div id="impl-Copy" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#2" title="goto source code">[src]</a></div><a href="#impl-Copy" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div><div id="impl-StructuralPartialEq" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/error/kind.rs.html#2" title="goto source code">[src]</a></div><a href="#impl-StructuralPartialEq" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div></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"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="error/enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></div></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" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#132-136" title="goto source code">[src]</a></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.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.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#133" title="goto source code">[src]</a></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.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.59.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#209-214" title="goto source code">[src]</a></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.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.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#211" title="goto source code">[src]</a></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&</a>T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#218-222" title="goto source code">[src]</a></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.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.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#219" title="goto source code">[src]</a></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.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.59.0/std/primitive.reference.html">&mut </a>T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#550-554" title="goto source code">[src]</a></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#551" title="goto source code">[src]</a></div><a href="#method.from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#538-545" title="goto source code">[src]</a></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.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.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#542" title="goto source code">[src]</a></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-ToOwned" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/alloc/borrow.rs.html#84-96" title="goto source code">[src]</a></div><a href="#impl-ToOwned" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.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.59.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Owned" class="type trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></div></summary><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.to_owned" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/alloc/borrow.rs.html#89" title="goto source code">[src]</a></div><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></div></summary><div class='docblock'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.59.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/alloc/borrow.rs.html#93" title="goto source code">[src]</a></div><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.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.59.0/std/primitive.reference.html">&mut </a>T)</h4></div></summary><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</div></div><div class='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.59.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-ToString" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/alloc/string.rs.html#2388-2402" title="goto source code">[src]</a></div><a href="#impl-ToString" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/alloc/string/trait.ToString.html" title="trait alloc::string::ToString">ToString</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.to_string" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/alloc/string.rs.html#2394" title="goto source code">[src]</a></div><a href="#method.to_string" class="anchor"></a><h4 class="code-header">pub default fn <a href="https://doc.rust-lang.org/1.59.0/alloc/string/trait.ToString.html#tymethod.to_string" class="fnname">to_string</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></div></summary><div class='docblock'><p>Converts the given value to a <code>String</code>. <a href="https://doc.rust-lang.org/1.59.0/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#588-597" title="goto source code">[src]</a></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.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.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type 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.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></div></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><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#594" title="goto source code">[src]</a></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.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.59.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.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#574-583" title="goto source code">[src]</a></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.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.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></div></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><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#580" title="goto source code">[src]</a></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.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.59.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.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section><section id="search" class="content hidden"></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.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |