mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-24 08:58:26 +00:00
99 lines
47 KiB
HTML
99 lines
47 KiB
HTML
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Command Line Argument Parser Error"><title>Error in clap::error - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="clap" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="logo-container" href="../../clap/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../clap/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><h2><a href="../../clap/index.html">clap</a><span class="version">4.5.0</span></h2></div><h2 class="location"><a href="#">Error</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.apply">apply</a></li><li><a href="#method.context">context</a></li><li><a href="#method.exit">exit</a></li><li><a href="#method.exit_code">exit_code</a></li><li><a href="#method.format">format</a></li><li><a href="#method.get">get</a></li><li><a href="#method.insert">insert</a></li><li><a href="#method.kind">kind</a></li><li><a href="#method.new">new</a></li><li><a href="#method.print">print</a></li><li><a href="#method.raw">raw</a></li><li><a href="#method.render">render</a></li><li><a href="#method.use_stderr">use_stderr</a></li><li><a href="#method.with_cmd">with_cmd</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Error%3CF%3E">Debug</a></li><li><a href="#impl-Display-for-Error%3CF%3E">Display</a></li><li><a href="#impl-Error-for-Error%3CF%3E">Error</a></li><li><a href="#impl-From%3CError%3E-for-Error%3CF%3E">From<Error></a></li><li><a href="#impl-From%3CError%3E-for-Error%3CF%3E-1">From<Error></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-Error%3CF%3E">!RefUnwind
|
|||
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../clap/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">clap</a>::<wbr><a href="index.html">error</a>::<wbr><a class="struct" href="#">Error</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/clap_builder/error/mod.rs.html#60">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Error<F = <a class="struct" href="struct.DefaultFormatter.html" title="struct clap::error::DefaultFormatter">RichFormatter</a>><div class="where">where
|
|||
|
|
F: <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a>,</div>{ <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Command Line Argument Parser Error</p>
|
|||
|
|
<p>See <a href="../struct.Command.html#method.error" title="method clap::Command::error"><code>Command::error</code></a> to create an error.</p>
|
|||
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Error%3CF%3E" class="impl"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#79">source</a><a href="#impl-Error%3CF%3E" class="anchor">§</a><h3 class="code-header">impl<F> <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F><div class="where">where
|
|||
|
|
F: <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.raw" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#88">source</a><h4 class="code-header">pub fn <a href="#method.raw" class="fn">raw</a>(kind: <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a>, message: impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>) -> <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F></h4></section></summary><div class="docblock"><p>Create an unformatted error</p>
|
|||
|
|
<p>This is for you need to pass the error up to
|
|||
|
|
a place that has access to the <code>Command</code> at which point you can call <a href="struct.Error.html#method.format" title="method clap::error::Error::format"><code>Error::format</code></a>.</p>
|
|||
|
|
<p>Prefer <a href="../struct.Command.html#method.error" title="method clap::Command::error"><code>Command::error</code></a> for generating errors.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.format" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#94">source</a><h4 class="code-header">pub fn <a href="#method.format" class="fn">format</a>(self, cmd: &mut <a class="struct" href="../struct.Command.html" title="struct clap::Command">Command</a>) -> <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F></h4></section></summary><div class="docblock"><p>Format the existing message with the Command’s context</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#128">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(kind: <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a>) -> <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F></h4></section></summary><div class="docblock"><p>Create an error with a pre-defined message</p>
|
|||
|
|
<p>See also</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="struct.Error.html#method.insert" title="method clap::error::Error::insert"><code>Error::insert</code></a></li>
|
|||
|
|
<li><a href="struct.Error.html#method.with_cmd" title="method clap::error::Error::with_cmd"><code>Error::with_cmd</code></a></li>
|
|||
|
|
</ul>
|
|||
|
|
<h5 id="example"><a href="#example">Example</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
|
|||
|
|
<span class="kw">let </span>cmd = clap::Command::new(<span class="string">"prog"</span>);
|
|||
|
|
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>err = clap::Error::new(ErrorKind::ValueValidation)
|
|||
|
|
.with_cmd(<span class="kw-2">&</span>cmd);
|
|||
|
|
err.insert(ContextKind::InvalidArg, ContextValue::String(<span class="string">"--foo"</span>.to_owned()));
|
|||
|
|
err.insert(ContextKind::InvalidValue, ContextValue::String(<span class="string">"bar"</span>.to_owned()));
|
|||
|
|
|
|||
|
|
err.print();</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_cmd" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#149">source</a><h4 class="code-header">pub fn <a href="#method.with_cmd" class="fn">with_cmd</a>(self, cmd: &<a class="struct" href="../struct.Command.html" title="struct clap::Command">Command</a>) -> <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F></h4></section></summary><div class="docblock"><p>Apply <a href="../struct.Command.html" title="struct clap::Command"><code>Command</code></a>’s formatting to the error</p>
|
|||
|
|
<p>Generally, this is used with <a href="struct.Error.html#method.new" title="associated function clap::error::Error::new"><code>Error::new</code></a></p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.apply" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#172">source</a><h4 class="code-header">pub fn <a href="#method.apply" class="fn">apply</a><EF>(self) -> <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><EF><div class="where">where
|
|||
|
|
EF: <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a>,</div></h4></section></summary><div class="docblock"><p>Apply an alternative formatter to the error</p>
|
|||
|
|
<h5 id="example-1"><a href="#example-1">Example</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"foo"</span>)
|
|||
|
|
.arg(Arg::new(<span class="string">"input"</span>).required(<span class="bool-val">true</span>));
|
|||
|
|
<span class="kw">let </span>matches = cmd
|
|||
|
|
.try_get_matches_from([<span class="string">"foo"</span>, <span class="string">"input.txt"</span>])
|
|||
|
|
.map_err(|e| e.apply::<KindFormatter>())
|
|||
|
|
.unwrap_or_else(|e| e.exit());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.kind" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#180">source</a><h4 class="code-header">pub fn <a href="#method.kind" class="fn">kind</a>(&self) -> <a class="enum" href="enum.ErrorKind.html" title="enum clap::error::ErrorKind">ErrorKind</a></h4></section></summary><div class="docblock"><p>Type of error for programmatic processing</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.context" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#186">source</a><h4 class="code-header">pub fn <a href="#method.context" class="fn">context</a>(&self) -> impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = (<a class="enum" href="enum.ContextKind.html" title="enum clap::error::ContextKind">ContextKind</a>, &<a class="enum" href="enum.ContextValue.html" title="enum clap::error::ContextValue">ContextValue</a>)></h4></section></summary><div class="docblock"><p>Additional information to further qualify the error</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#193">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>(&self, kind: <a class="enum" href="enum.ContextKind.html" title="enum clap::error::ContextKind">ContextKind</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="enum" href="enum.ContextValue.html" title="enum clap::error::ContextValue">ContextValue</a>></h4></section></summary><div class="docblock"><p>Lookup a piece of context</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#200">source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>(
|
|||
|
|
&mut self,
|
|||
|
|
kind: <a class="enum" href="enum.ContextKind.html" title="enum clap::error::ContextKind">ContextKind</a>,
|
|||
|
|
value: <a class="enum" href="enum.ContextValue.html" title="enum clap::error::ContextValue">ContextValue</a>
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="enum.ContextValue.html" title="enum clap::error::ContextValue">ContextValue</a>></h4></section></summary><div class="docblock"><p>Insert a piece of context</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.use_stderr" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#206">source</a><h4 class="code-header">pub fn <a href="#method.use_stderr" class="fn">use_stderr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Should the message be written to <code>stdout</code> or not?</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.exit_code" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#221">source</a><h4 class="code-header">pub fn <a href="#method.exit_code" class="fn">exit_code</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i32.html">i32</a></h4></section></summary><div class="docblock"><p>Returns the exit code that <code>.exit</code> will exit the process with.</p>
|
|||
|
|
<p>When the error’s kind would print to <code>stderr</code> this returns <code>2</code>,
|
|||
|
|
else it returns <code>0</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.exit" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#233">source</a><h4 class="code-header">pub fn <a href="#method.exit" class="fn">exit</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.never.html">!</a></h4></section></summary><div class="docblock"><p>Prints the error and exits.</p>
|
|||
|
|
<p>Depending on the error kind, this either prints to <code>stderr</code> and exits with a status of <code>2</code>
|
|||
|
|
or prints to <code>stdout</code> and exits with a status of <code>0</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.print" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#256">source</a><h4 class="code-header">pub fn <a href="#method.print" class="fn">print</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Prints formatted and colored error to <code>stdout</code> or <code>stderr</code> according to its error kind</p>
|
|||
|
|
<h5 id="example-2"><a href="#example-2">Example</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>clap::Command;
|
|||
|
|
|
|||
|
|
<span class="kw">match </span>Command::new(<span class="string">"Command"</span>).try_get_matches() {
|
|||
|
|
<span class="prelude-val">Ok</span>(matches) => {
|
|||
|
|
<span class="comment">// do_something
|
|||
|
|
</span>},
|
|||
|
|
<span class="prelude-val">Err</span>(err) => {
|
|||
|
|
err.print().expect(<span class="string">"Error writing Error"</span>);
|
|||
|
|
<span class="comment">// do_something
|
|||
|
|
</span>},
|
|||
|
|
};</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.render" class="method"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#288">source</a><h4 class="code-header">pub fn <a href="#method.render" class="fn">render</a>(&self) -> <a class="struct" href="../builder/struct.StyledStr.html" title="struct clap::builder::StyledStr">StyledStr</a></h4></section></summary><div class="docblock"><p>Render the error message to a <a href="../builder/struct.StyledStr.html" title="struct clap::builder::StyledStr"><code>StyledStr</code></a>.</p>
|
|||
|
|
<h5 id="example-3"><a href="#example-3">Example</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>clap::Command;
|
|||
|
|
|
|||
|
|
<span class="kw">match </span>Command::new(<span class="string">"Command"</span>).try_get_matches() {
|
|||
|
|
<span class="prelude-val">Ok</span>(matches) => {
|
|||
|
|
<span class="comment">// do_something
|
|||
|
|
</span>},
|
|||
|
|
<span class="prelude-val">Err</span>(err) => {
|
|||
|
|
<span class="kw">let </span>err = err.render();
|
|||
|
|
<span class="macro">println!</span>(<span class="string">"{err}"</span>);
|
|||
|
|
<span class="comment">// do_something
|
|||
|
|
</span>},
|
|||
|
|
};</code></pre></div>
|
|||
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Error%3CF%3E" class="impl"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#835">source</a><a href="#impl-Debug-for-Error%3CF%3E" class="anchor">§</a><h3 class="code-header">impl<F> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F><div class="where">where
|
|||
|
|
F: <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#836">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Display-for-Error%3CF%3E" class="impl"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#848">source</a><a href="#impl-Display-for-Error%3CF%3E" class="anchor">§</a><h3 class="code-header">impl<F> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F><div class="where">where
|
|||
|
|
F: <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt-1" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#849">source</a><a href="#method.fmt-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Error-for-Error%3CF%3E" class="impl"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#841">source</a><a href="#impl-Error-for-Error%3CF%3E" class="anchor">§</a><h3 class="code-header">impl<F> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html" title="trait core::error::Error">Error</a> for <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F><div class="where">where
|
|||
|
|
F: <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.source" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#843">source</a><a href="#method.source" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html#method.source" class="fn">source</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&(dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html" title="trait core::error::Error">Error</a> + 'static)></h4></section></summary><div class='docblock'>The lower-level source of this error, if any. <a href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html#method.source">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.description" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/error.rs.html#110">source</a></span><a href="#method.description" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html#method.description" class="fn">description</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a></h4></section></summary><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 1.42.0: use the Display impl or to_string()</span></div></span><div class='docblock'> <a href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html#method.description">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.cause" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/error.rs.html#120">source</a></span><a href="#method.cause" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html#method.cause" class="fn">cause</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&dyn <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html" title="trait core::error::Error">Error</a>></h4></section></summary><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 1.33.0: replaced by Error::source, which can support downcasting</span></div></span></details><details class="toggle method-toggle" open><summary><section id="method.provide" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/error.rs.html#184">source</a><a href="#method.provide" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html#method.provide" class="fn">provide</a><'a>(&'a self, request: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/error/struct.Request.html" title="struct core::error::Request">Request</a><'a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>error_generic_member_access</code>)</span></div></span><div class='docblock'>Provides type based access to context intended for error reports. <a href="https://doc.rust-lang.org/1.76.0/core/error/trait.Error.html#method.provide">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="i
|
|||
|
|
F: <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#830">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(e: <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>) -> <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F></h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CError%3E-for-Error%3CF%3E-1" class="impl"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#823">source</a><a href="#impl-From%3CError%3E-for-Error%3CF%3E-1" class="anchor">§</a><h3 class="code-header">impl<F> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>> for <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F><div class="where">where
|
|||
|
|
F: <a class="trait" href="trait.ErrorFormatter.html" title="trait clap::error::ErrorFormatter">ErrorFormatter</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/mod.rs.html#824">source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(e: <a class="struct" href="https://doc.rust-lang.org/1.76.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>) -> <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F></h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Error%3CF%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Error%3CF%3E" class="anchor">§</a><h3 class="code-header">impl<F = <a class="struct" href="struct.DefaultFormatter.html" title="struct clap::error::DefaultFormatter">RichFormatter</a>> !<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F></h3></section><section id="impl-Send-for-Error%3CF%3E" class="impl"><a href="#impl-Send-for-Error%3CF%3E" class="anchor">§</a><h3 class="code-header">impl<F> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-Error%3CF%3E" class="impl"><a href="#impl-Sync-for-Error%3CF%3E" class="anchor">§</a><h3 class="code-header">impl<F> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-Error%3CF%3E" class="impl"><a href="#impl-Unpin-for-Error%3CF%3E" class="anchor">§</a><h3 class="code-header">impl<F> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-Error%3CF%3E" class="impl"><a href="#impl-UnwindSafe-for-Error%3CF%3E" class="anchor">§</a><h3 class="code-header">impl<F = <a class="struct" href="struct.DefaultFormatter.html" title="struct clap::error::DefaultFormatter">RichFormatter</a>> !<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Error.html" title="struct clap::error::Error">Error</a><F></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|||
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#763">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#766">source</a><a href="#method.from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#747-749">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#756">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|||
|
|
<p>That is, this conversion is whatever the implementation of
|
|||
|
|
<code><a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToString-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/alloc/string.rs.html#2600">source</a><a href="#impl-ToString-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/alloc/string/trait.ToString.html" title="trait alloc::string::ToString">ToString</a> for T<div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.to_string" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/alloc/string.rs.html#2606">source</a><a href="#method.to_string" class="anchor">§</a><h4 class="code-header">default fn <a href="https://doc.rust-lang.org/1.76.0/alloc/string/trait.ToString.html#tymethod.to_string" class="fn">to_string</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'>Converts the given value to a <code>String</code>. <a href="https://doc.rust-lang.org/1.76.0/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#803-805">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#810">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#788-790">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#795">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
|