38 lines
14 KiB
HTML
38 lines
14 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="Parse arguments into enums."><meta name="keywords" content="rust, rustlang, rust-lang, ArgEnum"><title>ArgEnum in clap - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../clap/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div>
|
||
</a><h2 class="location">Trait ArgEnum</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.to_possible_value">to_possible_value</a><a href="#tymethod.value_variants">value_variants</a></div><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.from_str">from_str</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">clap</a></h2><div id="sidebar-vars" data-name="ArgEnum" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../clap/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">clap</a>::<wbr><a class="trait" href="#">ArgEnum</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/clap/derive.rs.html#420-441" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait ArgEnum: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> {
|
||
fn <a href="#tymethod.value_variants" class="fnname">value_variants</a><'a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&'a [Self]</a><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><div class="notable">Notable traits for <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&'_ [</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a></div><code class="content"><span class="where fmt-newline">impl<'_> <a class="trait" href="https://doc.rust-lang.org/1.59.0/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&'_ [</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl<'_> <a class="trait" href="https://doc.rust-lang.org/1.59.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&'_ mut [</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a></span></code></span></div></span></span>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.to_possible_value" class="fnname">to_possible_value</a><'a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.PossibleValue.html" title="struct clap::PossibleValue">PossibleValue</a><'a>>;
|
||
|
||
fn <a href="#method.from_str" class="fnname">from_str</a>(input: &<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.str.html">str</a>, ignore_case: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.bool.html">bool</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>> { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse arguments into enums.</p>
|
||
<p>When deriving <a href="trait.Parser.html" title="Parser"><code>Parser</code></a>, a field whose type implements <code>ArgEnum</code> can have the attribute
|
||
<code>#[clap(arg_enum)]</code> which will</p>
|
||
<ul>
|
||
<li>Call <a href="struct.Arg.html#method.possible_values" title="crate::Arg::possible_values"><code>Arg::possible_values</code></a></li>
|
||
<li>Allowing using the <code>#[clap(default_value_t)]</code> attribute without implementing <code>Display</code>.</li>
|
||
</ul>
|
||
<p>See the
|
||
<a href="https://github.com/clap-rs/clap/blob/v3.1.6/examples/derive_ref/README.md">derive reference</a>
|
||
for attributes and best practices.</p>
|
||
<p><strong>NOTE:</strong> Deriving requires the <code>derive</code> feature flag</p>
|
||
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attribute">#[<span class="ident">derive</span>(<span class="ident">clap::Parser</span>)]</span>
|
||
<span class="kw">struct</span> <span class="ident">Args</span> {
|
||
<span class="attribute">#[<span class="ident">clap</span>(<span class="ident">arg_enum</span>)]</span>
|
||
<span class="ident">level</span>: <span class="ident">Level</span>,
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">clap::ArgEnum</span>, <span class="ident">Clone</span>)]</span>
|
||
<span class="kw">enum</span> <span class="ident">Level</span> {
|
||
<span class="ident">Debug</span>,
|
||
<span class="ident">Info</span>,
|
||
<span class="ident">Warning</span>,
|
||
<span class="ident">Error</span>,
|
||
}</code></pre></div>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.value_variants" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#422" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.value_variants" class="fnname">value_variants</a><'a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&'a [Self]</a><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><div class="notable">Notable traits for <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&'_ [</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a></div><code class="content"><span class="where fmt-newline">impl<'_> <a class="trait" href="https://doc.rust-lang.org/1.59.0/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&'_ [</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl<'_> <a class="trait" href="https://doc.rust-lang.org/1.59.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&'_ mut [</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a></span></code></span></div></span></span></h4></div></summary><div class="docblock"><p>All possible argument values, in display order.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.to_possible_value" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#440" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.to_possible_value" class="fnname">to_possible_value</a><'a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.PossibleValue.html" title="struct clap::PossibleValue">PossibleValue</a><'a>></h4></div></summary><div class="docblock"><p>The canonical argument value.</p>
|
||
<p>The value is <code>None</code> for skipped variants.</p>
|
||
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.from_str" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#425-435" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.from_str" class="fnname">from_str</a>(input: &<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.str.html">str</a>, ignore_case: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.bool.html">bool</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></h4></div></summary><div class="docblock"><p>Parse an argument into <code>Self</code>.</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/clap/trait.ArgEnum.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |