Rust/ssw
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ssw/doc/clap/error/enum.ErrorKind.html
Justine fe9e6f04f5 Now a REAL lib
2023-01-09 19:23:20 +01:00

221 lines
67 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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::error - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc enum"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../clap/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"><a href="#">ErrorKind</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#variants">Variants</a></h3><ul><li><a href="#variant.ArgumentConflict">ArgumentConflict</a></li><li><a href="#variant.DisplayHelp">DisplayHelp</a></li><li><a href="#variant.DisplayHelpOnMissingArgumentOrSubcommand">DisplayHelpOnMissingArgumentOrSubcommand</a></li><li><a href="#variant.DisplayVersion">DisplayVersion</a></li><li><a href="#variant.Format">Format</a></li><li><a href="#variant.InvalidSubcommand">InvalidSubcommand</a></li><li><a href="#variant.InvalidUtf8">InvalidUtf8</a></li><li><a href="#variant.InvalidValue">InvalidValue</a></li><li><a href="#variant.Io">Io</a></li><li><a href="#variant.MissingRequiredArgument">MissingRequiredArgument</a></li><li><a href="#variant.MissingSubcommand">MissingSubcommand</a></li><li><a href="#variant.NoEquals">NoEquals</a></li><li><a href="#variant.TooFewValues">TooFewValues</a></li><li><a href="#variant.TooManyValues">TooManyValues</a></li><li><a href="#variant.UnknownArgument">UnknownArgument</a></li><li><a href="#variant.ValueValidation">ValueValidation</a></li><li><a href="#variant.WrongNumberOfValues">WrongNumberOfValues</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.as_str">as_str</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-Clone-for-ErrorKind">Clone</a></li><li><a href="#impl-Copy-for-ErrorKind">Copy</a></li><li><a href="#impl-Debug-for-ErrorKind">Debug</a></li><li><a href="#impl-Display-for-ErrorKind">Display</a></li><li><a href="#impl-Eq-for-ErrorKind">Eq</a></li><li><a href="#impl-Hash-for-ErrorKind">Hash</a></li><li><a href="#impl-PartialEq%3CErrorKind%3E-for-ErrorKind">PartialEq&lt;ErrorKind&gt;</a></li><li><a href="#impl-StructuralEq-for-ErrorKind">StructuralEq</a></li><li><a href="#impl-StructuralPartialEq-for-ErrorKind">StructuralPartialEq</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><a href="#impl-RefUnwindSafe-for-ErrorKind">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ErrorKind">Send</a></li><li><a href="#impl-Sync-for-ErrorKind">Sync</a></li><li><a href="#impl-Unpin-for-ErrorKind">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ErrorKind">UnwindSafe</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><ul><li><a href="#impl-Any-for-ErrorKind">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ErrorKind">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ErrorKind">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-ErrorKind">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-ErrorKind">Into&lt;U&gt;</a></li><li><a href="#impl-ToOwned-for-ErrorKind">ToOwned</a></li><li><a href="#impl-ToString-for-ErrorKind">ToString</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ErrorKind">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-ErrorKind">TryInto&lt;U&gt;</a></li></ul></div></section><h2 class="location"><a href="index.html">In clap::error</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../clap/index.html">
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Enum <a href="../index.html">clap</a>::<wbr><a href="index.html">error</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></h1><span class="out-of-band"><a class="srclink" href="../../src/clap/error/kind.rs.html#4-313">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><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 17 variants</span></summary> InvalidValue,
UnknownArgument,
InvalidSubcommand,
NoEquals,
ValueValidation,
TooManyValues,
TooFewValues,
WrongNumberOfValues,
ArgumentConflict,
MissingRequiredArgument,
MissingSubcommand,
InvalidUtf8,
DisplayHelp,
DisplayHelpOnMissingArgumentOrSubcommand,
DisplayVersion,
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="../builder/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"><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">&quot;prog&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;speed&quot;</span>)
.<span class="ident">value_parser</span>([<span class="string">&quot;fast&quot;</span>, <span class="string">&quot;slow&quot;</span>]))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;other&quot;</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"><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">&quot;prog&quot;</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">&quot;some flag&quot;</span>))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;--other&quot;</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="enum.ErrorKind.html#variant.UnknownArgument"><code>UnknownArgument</code></a> error is returned.</p>
<h4 id="examples-2"><a href="#examples-2">Examples</a></h4>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">&quot;prog&quot;</span>)
.<span class="ident">subcommand</span>(<span class="ident">Command::new</span>(<span class="string">&quot;config&quot;</span>)
.<span class="ident">about</span>(<span class="string">&quot;Used for configuration&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;config_file&quot;</span>)
.<span class="ident">help</span>(<span class="string">&quot;The configuration file to use&quot;</span>)))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;confi&quot;</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.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">&quot;prog&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;color&quot;</span>)
.<span class="ident">action</span>(<span class="ident">ArgAction::Set</span>)
.<span class="ident">require_equals</span>(<span class="bool-val">true</span>)
.<span class="ident">long</span>(<span class="string">&quot;color&quot;</span>))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;--color&quot;</span>, <span class="string">&quot;red&quot;</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-3"><a href="#examples-3">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">&amp;</span><span class="ident">str</span>) -&gt; <span class="prelude-ty">Result</span><span class="op">&lt;</span>(), <span class="ident">String</span><span class="op">&gt;</span> {
<span class="kw">match</span> <span class="ident">val</span>.<span class="ident">parse</span>::<span class="op">&lt;</span><span class="ident">i64</span><span class="op">&gt;</span>() {
<span class="prelude-val">Ok</span>(..) =&gt; <span class="prelude-val">Ok</span>(()),
<span class="prelude-val">Err</span>(..) =&gt; <span class="prelude-val">Err</span>(<span class="ident">String::from</span>(<span class="string">&quot;Value wasn&#39;t a number!&quot;</span>)),
}
}
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">&quot;prog&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;num&quot;</span>)
.<span class="ident">value_parser</span>(<span class="macro">value_parser!</span>(<span class="ident">u8</span>)))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;NotANumber&quot;</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="../builder/struct.Arg.html#method.num_args"><code>Arg::num_args</code></a>.</p>
<h4 id="examples-4"><a href="#examples-4">Examples</a></h4>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">&quot;prog&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;arg&quot;</span>)
.<span class="ident">num_args</span>(<span class="number">1</span>..<span class="op">=</span><span class="number">2</span>))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;too&quot;</span>, <span class="string">&quot;many&quot;</span>, <span class="string">&quot;values&quot;</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="../builder/struct.Arg.html#method.num_args"><code>Arg::num_args</code></a>.</p>
<h4 id="examples-5"><a href="#examples-5">Examples</a></h4>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">&quot;prog&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;some_opt&quot;</span>)
.<span class="ident">long</span>(<span class="string">&quot;opt&quot;</span>)
.<span class="ident">num_args</span>(<span class="number">3</span>..))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;--opt&quot;</span>, <span class="string">&quot;too&quot;</span>, <span class="string">&quot;few&quot;</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.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="../builder/struct.Arg.html#method.num_args"><code>Arg::num_args</code></a> or than was implicitly set by
<a href="../builder/struct.Arg.html#method.value_names"><code>Arg::value_names</code></a>.</p>
<h4 id="examples-6"><a href="#examples-6">Examples</a></h4>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">&quot;prog&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;some_opt&quot;</span>)
.<span class="ident">long</span>(<span class="string">&quot;opt&quot;</span>)
.<span class="ident">action</span>(<span class="ident">ArgAction::Set</span>)
.<span class="ident">num_args</span>(<span class="number">2</span>))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;--opt&quot;</span>, <span class="string">&quot;wrong&quot;</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-7"><a href="#examples-7">Examples</a></h4>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">&quot;prog&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;debug&quot;</span>)
.<span class="ident">long</span>(<span class="string">&quot;debug&quot;</span>)
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>)
.<span class="ident">conflicts_with</span>(<span class="string">&quot;color&quot;</span>))
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;color&quot;</span>)
.<span class="ident">long</span>(<span class="string">&quot;color&quot;</span>)
.<span class="ident">action</span>(<span class="ident">ArgAction::SetTrue</span>))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;--debug&quot;</span>, <span class="string">&quot;--color&quot;</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-8"><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">&quot;prog&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;debug&quot;</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">&quot;prog&quot;</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="../builder/struct.Command.html#method.subcommand_required"><code>Command::subcommand_required</code></a>),
but the user does not provide one.</p>
<h4 id="examples-9"><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">err</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">&quot;prog&quot;</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">&quot;test&quot;</span>))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[
<span class="string">&quot;myprog&quot;</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.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 [<code>Arg::value_parser(value_parser!(OsString))</code>] for argument values</li>
<li>Set <a href="../builder/struct.Command.html#method.external_subcommand_value_parser"><code>Command::external_subcommand_value_parser</code></a> for external-subcommand
values</li>
</ul>
<h4 id="platform-specific"><a href="#platform-specific">Platform Specific</a></h4>
<p>Non-Windows platforms only (such as Linux, Unix, OSX, etc.)</p>
<h4 id="examples-10"><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">&quot;prog&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;utf8&quot;</span>)
.<span class="ident">short</span>(<span class="string">&#39;u&#39;</span>)
.<span class="ident">action</span>(<span class="ident">ArgAction::Set</span>))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="ident">OsString::from</span>(<span class="string">&quot;myprog&quot;</span>),
<span class="ident">OsString::from</span>(<span class="string">&quot;-u&quot;</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-11"><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">&quot;prog&quot;</span>)
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;--help&quot;</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="../builder/struct.Command.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-12"><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">result</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">&quot;prog&quot;</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">&quot;config&quot;</span>)
.<span class="ident">about</span>(<span class="string">&quot;Used for configuration&quot;</span>)
.<span class="ident">arg</span>(<span class="ident">Arg::new</span>(<span class="string">&quot;config_file&quot;</span>)
.<span class="ident">help</span>(<span class="string">&quot;The configuration file to use&quot;</span>)))
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</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-13"><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">&quot;prog&quot;</span>)
.<span class="ident">version</span>(<span class="string">&quot;3.0&quot;</span>)
.<span class="ident">try_get_matches_from</span>(<span class="macro">vec!</span>[<span class="string">&quot;prog&quot;</span>, <span class="string">&quot;--version&quot;</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.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.64.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.64.0/core/fmt/struct.Error.html">Format error</a> (which is a part of <a href="https://doc.rust-lang.org/1.64.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><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#315-344">source</a></span><a href="#impl-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_str" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#317-343">source</a></span><h4 class="code-header">pub fn <a href="#method.as_str" class="fnname">as_str</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>End-user description of the error case, where relevant</p>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#impl-Clone-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&amp;self) -&gt; <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h4></section></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/clone.rs.html#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&amp;</a>Self)</h4></section></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#impl-Debug-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Display-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#346-350">source</a></span><a href="#impl-Display-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#347-349">source</a></span><a href="#method.fmt-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.html#tymethod.fmt" class="fnname">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Hash-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#impl-Hash-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#method.hash" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hash.html#tymethod.hash" class="fnname">hash</a>&lt;__H:&nbsp;<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>&gt;(&amp;self, state: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&amp;mut </a>__H)</h4></section></summary><div class='docblock'><p>Feeds this value into the given <a href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash_slice" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/hash/mod.rs.html#237-239">source</a></span><a href="#method.hash_slice" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hash.html#method.hash_slice" class="fnname">hash_slice</a>&lt;H&gt;(data: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.slice.html">[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&amp;mut </a>H) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;H: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,&nbsp;</span></h4></section></summary><div class='docblock'><p>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.64.0/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CErrorKind%3E-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#impl-PartialEq%3CErrorKind%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;<a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a>&gt; for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&amp;self, other: &amp;<a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a href="https://doc.rust-lang.org/1.64.0/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/cmp.rs.html#232">source</a></span><a href="#method.ne" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&amp;</a>Rhs) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></details></div></details><section id="impl-Copy-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#impl-Copy-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-Eq-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#impl-Eq-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-StructuralEq-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#impl-StructuralEq-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.StructuralEq.html" title="trait core::marker::StructuralEq">StructuralEq</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-StructuralPartialEq-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/clap/error/kind.rs.html#2">source</a></span><a href="#impl-StructuralPartialEq-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ErrorKind" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-Send-for-ErrorKind" class="impl has-srclink"><a href="#impl-Send-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-Sync-for-ErrorKind" class="impl has-srclink"><a href="#impl-Sync-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-Unpin-for-ErrorKind" class="impl has-srclink"><a href="#impl-Unpin-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-UnwindSafe-for-ErrorKind" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#203">source</a></span><a href="#impl-Any-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#204">source</a></span><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#209">source</a></span><a href="#impl-Borrow%3CT%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#211">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&amp;</a>T</h4></section></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#218">source</a></span><a href="#impl-BorrowMut%3CT%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#219">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&amp;mut </a>T</h4></section></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#557">source</a></span><a href="#impl-From%3CT%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#559">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#541">source</a></span><a href="#impl-Into%3CU%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,&nbsp;</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#549">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#83">source</a></span><a href="#impl-ToOwned-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,&nbsp;</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'><p>The resulting type after obtaining ownership.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#88">source</a></span><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/borrow.rs.html#92">source</a></span><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&amp;self, target: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&amp;mut </a>T)</h4></section></summary><div class='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToString-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/string.rs.html#2479">source</a></span><a href="#impl-ToString-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.64.0/alloc/string/trait.ToString.html" title="trait alloc::string::ToString">ToString</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_string" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/string.rs.html#2485">source</a></span><a href="#method.to_string" class="anchor"></a><h4 class="code-header">default fn <a href="https://doc.rust-lang.org/1.64.0/alloc/string/trait.ToString.html#tymethod.to_string" class="fnname">to_string</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'><p>Converts the given value to a <code>String</code>. <a href="https://doc.rust-lang.org/1.64.0/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#598">source</a></span><a href="#impl-TryFrom%3CU%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,&nbsp;</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#604">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ErrorKind" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#583">source</a></span><a href="#impl-TryInto%3CU%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header in-band">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,&nbsp;</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#589">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
Reference in New Issue View Git Blame Copy Permalink