| <!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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc enum"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ErrorKind</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block"><li><a href="#variant.ArgumentConflict">ArgumentConflict</a></li><li><a href="#variant.ArgumentNotFound">ArgumentNotFound</a></li><li><a href="#variant.EmptyValue">EmptyValue</a></li><li><a href="#variant.Format">Format</a></li><li><a href="#variant.HelpDisplayed">HelpDisplayed</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.MissingArgumentOrSubcommand">MissingArgumentOrSubcommand</a></li><li><a href="#variant.MissingRequiredArgument">MissingRequiredArgument</a></li><li><a href="#variant.MissingSubcommand">MissingSubcommand</a></li><li><a href="#variant.TooFewValues">TooFewValues</a></li><li><a href="#variant.TooManyValues">TooManyValues</a></li><li><a href="#variant.UnexpectedMultipleUsage">UnexpectedMultipleUsage</a></li><li><a href="#variant.UnknownArgument">UnknownArgument</a></li><li><a href="#variant.UnrecognizedSubcommand">UnrecognizedSubcommand</a></li><li><a href="#variant.ValueValidation">ValueValidation</a></li><li><a href="#variant.VersionDisplayed">VersionDisplayed</a></li><li><a href="#variant.WrongNumberOfValues">WrongNumberOfValues</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><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-PartialEq%3CErrorKind%3E-for-ErrorKind">PartialEq<ErrorKind></a></li><li><a href="#impl-StructuralPartialEq-for-ErrorKind">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><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><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-ErrorKind">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ErrorKind">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ErrorKind">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ErrorKind">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ErrorKind">Into<U></a></li><li><a href="#impl-ToOwned-for-ErrorKind">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ErrorKind">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ErrorKind">TryInto<U></a></li></ul></section><h2><a href="index.html">In clap</a></h2></div></nav><main><div class="width-limiter"><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"><a href="../help.html">?</a></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><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">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></h1><span class="out-of-band"><a class="srclink" href="../src/clap/errors.rs.html#26-376">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust enum"><code>pub enum ErrorKind { |
| <details class="rustdoc-toggle type-contents-toggle"><summary class="hideme"><span>Show 20 variants</span></summary> InvalidValue, |
| UnknownArgument, |
| InvalidSubcommand, |
| UnrecognizedSubcommand, |
| EmptyValue, |
| ValueValidation, |
| TooManyValues, |
| TooFewValues, |
| WrongNumberOfValues, |
| ArgumentConflict, |
| MissingRequiredArgument, |
| MissingSubcommand, |
| MissingArgumentOrSubcommand, |
| UnexpectedMultipleUsage, |
| InvalidUtf8, |
| HelpDisplayed, |
| VersionDisplayed, |
| 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<a href="#variants" class="anchor"></a></h2><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"><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>result = App::new(<span class="string">"prog"</span>) |
| .arg(Arg::with_name(<span class="string">"speed"</span>) |
| .possible_value(<span class="string">"fast"</span>) |
| .possible_value(<span class="string">"slow"</span>)) |
| .get_matches_from_safe(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"other"</span>]); |
| <span class="macro">assert!</span>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::InvalidValue);</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>result = App::new(<span class="string">"prog"</span>) |
| .arg(Arg::from_usage(<span class="string">"--flag 'some flag'"</span>)) |
| .get_matches_from_safe(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--other"</span>]); |
| <span class="macro">assert!</span>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::UnknownArgument);</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="./struct.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>result = App::new(<span class="string">"prog"</span>) |
| .subcommand(SubCommand::with_name(<span class="string">"config"</span>) |
| .about(<span class="string">"Used for configuration"</span>) |
| .arg(Arg::with_name(<span class="string">"config_file"</span>) |
| .help(<span class="string">"The configuration file to use"</span>) |
| .index(<span class="number">1</span>))) |
| .get_matches_from_safe(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"confi"</span>]); |
| <span class="macro">assert!</span>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::InvalidSubcommand);</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="./struct.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="./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="./enum.ErrorKind.html#variant.UnknownArgument"><code>UnknownArgument</code></a> error is used.</p> |
| <h4 id="examples-3"><a href="#examples-3">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .subcommand(SubCommand::with_name(<span class="string">"config"</span>) |
| .about(<span class="string">"Used for configuration"</span>) |
| .arg(Arg::with_name(<span class="string">"config_file"</span>) |
| .help(<span class="string">"The configuration file to use"</span>) |
| .index(<span class="number">1</span>))) |
| .get_matches_from_safe(<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>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::UnrecognizedSubcommand);</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"><a href="#examples-4">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>res = App::new(<span class="string">"prog"</span>) |
| .arg(Arg::with_name(<span class="string">"color"</span>) |
| .long(<span class="string">"color"</span>) |
| .empty_values(<span class="bool-val">false</span>)) |
| .get_matches_from_safe(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--color="</span>]); |
| <span class="macro">assert!</span>(res.is_err()); |
| <span class="macro">assert_eq!</span>(res.unwrap_err().kind, ErrorKind::EmptyValue);</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"><a href="#examples-5">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn </span>is_numeric(val: String) -> <span class="prelude-ty">Result</span><(), String> { |
| <span class="kw">match </span>val.parse::<i64>() { |
| <span class="prelude-val">Ok</span>(..) => <span class="prelude-val">Ok</span>(()), |
| <span class="prelude-val">Err</span>(..) => <span class="prelude-val">Err</span>(String::from(<span class="string">"Value wasn't a number!"</span>)), |
| } |
| } |
| |
| <span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .arg(Arg::with_name(<span class="string">"num"</span>) |
| .validator(is_numeric)) |
| .get_matches_from_safe(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"NotANumber"</span>]); |
| <span class="macro">assert!</span>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::ValueValidation);</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"><a href="#examples-6">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .arg(Arg::with_name(<span class="string">"arg"</span>) |
| .multiple(<span class="bool-val">true</span>) |
| .max_values(<span class="number">2</span>)) |
| .get_matches_from_safe(<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>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::TooManyValues);</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"><a href="#examples-7">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .arg(Arg::with_name(<span class="string">"some_opt"</span>) |
| .long(<span class="string">"opt"</span>) |
| .min_values(<span class="number">3</span>)) |
| .get_matches_from_safe(<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>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::TooFewValues);</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-8"><a href="#examples-8">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .arg(Arg::with_name(<span class="string">"some_opt"</span>) |
| .long(<span class="string">"opt"</span>) |
| .takes_value(<span class="bool-val">true</span>) |
| .number_of_values(<span class="number">2</span>)) |
| .get_matches_from_safe(<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>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::WrongNumberOfValues);</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-9"><a href="#examples-9">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .arg(Arg::with_name(<span class="string">"debug"</span>) |
| .long(<span class="string">"debug"</span>) |
| .conflicts_with(<span class="string">"color"</span>)) |
| .arg(Arg::with_name(<span class="string">"color"</span>) |
| .long(<span class="string">"color"</span>)) |
| .get_matches_from_safe(<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>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::ArgumentConflict);</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-10"><a href="#examples-10">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .arg(Arg::with_name(<span class="string">"debug"</span>) |
| .required(<span class="bool-val">true</span>)) |
| .get_matches_from_safe(<span class="macro">vec!</span>[<span class="string">"prog"</span>]); |
| <span class="macro">assert!</span>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::MissingRequiredArgument);</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="./enum.AppSettings.html#variant.SubcommandRequired"><code>AppSettings::SubcommandRequired</code></a>), |
| but the user does not provide one.</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>err = App::new(<span class="string">"prog"</span>) |
| .setting(AppSettings::SubcommandRequired) |
| .subcommand(SubCommand::with_name(<span class="string">"test"</span>)) |
| .get_matches_from_safe(<span class="macro">vec!</span>[ |
| <span class="string">"myprog"</span>, |
| ]); |
| <span class="macro">assert!</span>(err.is_err()); |
| <span class="macro">assert_eq!</span>(err.unwrap_err().kind, ErrorKind::MissingSubcommand);</code></pre></div> |
| </div><h3 id="variant.MissingArgumentOrSubcommand" class="variant small-section-header"><a href="#variant.MissingArgumentOrSubcommand" class="anchor field"></a><code>MissingArgumentOrSubcommand</code></h3><div class="docblock"><p>Occurs when either an argument or <a href="./struct.SubCommand.html"><code>SubCommand</code></a> is required, as defined by |
| <a href="./enum.AppSettings.html#variant.ArgRequiredElseHelp"><code>AppSettings::ArgRequiredElseHelp</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>result = App::new(<span class="string">"prog"</span>) |
| .setting(AppSettings::ArgRequiredElseHelp) |
| .subcommand(SubCommand::with_name(<span class="string">"config"</span>) |
| .about(<span class="string">"Used for configuration"</span>) |
| .arg(Arg::with_name(<span class="string">"config_file"</span>) |
| .help(<span class="string">"The configuration file to use"</span>))) |
| .get_matches_from_safe(<span class="macro">vec!</span>[<span class="string">"prog"</span>]); |
| <span class="macro">assert!</span>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::MissingArgumentOrSubcommand);</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"><a href="#examples-13">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .arg(Arg::with_name(<span class="string">"debug"</span>) |
| .long(<span class="string">"debug"</span>) |
| .multiple(<span class="bool-val">false</span>)) |
| .get_matches_from_safe(<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>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::UnexpectedMultipleUsage);</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 for an argument and |
| <a href="./enum.AppSettings.html#variant.StrictUtf8"><code>AppSettings::StrictUtf8</code></a> is set.</p> |
| <h4 id="platform-specific"><a href="#platform-specific">Platform Specific</a></h4> |
| <p>Non-Windows platforms only (such as Linux, Unix, macOS, etc.)</p> |
| <h4 id="examples-14"><a href="#examples-14">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .setting(AppSettings::StrictUtf8) |
| .arg(Arg::with_name(<span class="string">"utf8"</span>) |
| .short(<span class="string">"u"</span>) |
| .takes_value(<span class="bool-val">true</span>)) |
| .get_matches_from_safe(<span class="macro">vec!</span>[OsString::from(<span class="string">"myprog"</span>), |
| OsString::from(<span class="string">"-u"</span>), |
| OsString::from_vec(<span class="macro">vec!</span>[<span class="number">0xE9</span>])]); |
| <span class="macro">assert!</span>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::InvalidUtf8);</code></pre></div> |
| </div><h3 id="variant.HelpDisplayed" class="variant small-section-header"><a href="#variant.HelpDisplayed" class="anchor field"></a><code>HelpDisplayed</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"><a href="#examples-15">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .get_matches_from_safe(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--help"</span>]); |
| <span class="macro">assert!</span>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::HelpDisplayed);</code></pre></div> |
| </div><h3 id="variant.VersionDisplayed" class="variant small-section-header"><a href="#variant.VersionDisplayed" class="anchor field"></a><code>VersionDisplayed</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-16"><a href="#examples-16">Examples</a></h4> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>result = App::new(<span class="string">"prog"</span>) |
| .get_matches_from_safe(<span class="macro">vec!</span>[<span class="string">"prog"</span>, <span class="string">"--version"</span>]); |
| <span class="macro">assert!</span>(result.is_err()); |
| <span class="macro">assert_eq!</span>(result.unwrap_err().kind, ErrorKind::VersionDisplayed);</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="macro.value_t.html" title="value_t!"><code>value_t!</code></a> and <a href="macro.values_t.html" title="values_t!"><code>values_t!</code></a> macros 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. |
| <a href="macro.value_t.html" title="value_t!"><code>value_t!</code></a>: ./macro.value_t!.html |
| <a href="macro.values_t.html" title="values_t!"><code>values_t!</code></a>: ./macro.values_t!.html</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 [I/O error]. |
| Can occur when writing to <code>stderr</code> or <code>stdout</code> or reading a configuration file. |
| [I/O error]: https://doc.rust-lang.org/std/io/struct.Error.html</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/std/fmt/struct.Error.html">Format error</a> (which is a part of <a href="https://doc.rust-lang.org/std/fmt/trait.Display.html"><code>Display</code></a>). |
| Typically caused by writing to <code>stderr</code> or <code>stdout</code>.</p> |
| </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"><a class="srclink rightside" href="../src/clap/errors.rs.html#25">source</a><a href="#impl-Clone-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::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"><a class="srclink rightside" href="../src/clap/errors.rs.html#25">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="enum" href="enum.ErrorKind.html" title="enum clap::ErrorKind">ErrorKind</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></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/nightly/src/core/clone.rs.html#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a href="https://doc.rust-lang.org/nightly/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/nightly/std/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="../src/clap/errors.rs.html#25">source</a><a href="#impl-Debug-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::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"><a class="srclink rightside" href="../src/clap/errors.rs.html#25">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CErrorKind%3E-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="../src/clap/errors.rs.html#25">source</a><a href="#impl-PartialEq%3CErrorKind%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="enum" href="enum.ErrorKind.html" title="enum clap::ErrorKind">ErrorKind</a>> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::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"><a class="srclink rightside" href="../src/clap/errors.rs.html#25">source</a><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="enum" href="enum.ErrorKind.html" title="enum clap::ErrorKind">ErrorKind</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>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/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></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/nightly/src/core/cmp.rs.html#227">source</a></span><a href="#method.ne" class="anchor"></a><h4 class="code-header">const fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always |
| sufficient, and should not be overridden without very good reason. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne">Read more</a></div></details></div></details><section id="impl-Copy-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="../src/clap/errors.rs.html#25">source</a><a href="#impl-Copy-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::ErrorKind">ErrorKind</a></h3></section><section id="impl-StructuralPartialEq-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="../src/clap/errors.rs.html#25">source</a><a href="#impl-StructuralPartialEq-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::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">impl <a class="trait" href="https://doc.rust-lang.org/nightly/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::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">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::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">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::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">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="enum.ErrorKind.html" title="enum clap::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">impl <a class="trait" href="https://doc.rust-lang.org/nightly/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::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"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#83">source</a><a href="#impl-ToOwned-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-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/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="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/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ErrorKind" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-ErrorKind" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" 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/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="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/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
