36 lines
13 KiB
HTML
36 lines
13 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 a set of arguments into a user-defined container."><meta name="keywords" content="rust, rustlang, rust-lang, Args"><title>Args 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 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 trait"><!--[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 src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../clap/index.html"><div class="logo-container">
|
||
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></div></a><h2 class="location"><a href="#">Args</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.augment_args">augment_args</a></li><li><a href="#tymethod.augment_args_for_update">augment_args_for_update</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><li><a href="#method.group_id">group_id</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><li><a href="#impl-Args-for-Box%3CT%3E">Box<T></a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In clap</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../clap/index.html">
|
||
<img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">clap</a>::<wbr><a class="trait" href="#">Args</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/clap/derive.rs.html#284-299">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait Args: <a class="trait" href="trait.FromArgMatches.html" title="trait clap::FromArgMatches">FromArgMatches</a> + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
fn <a href="#tymethod.augment_args" class="fnname">augment_args</a>(cmd: <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a>) -> <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.augment_args_for_update" class="fnname">augment_args_for_update</a>(cmd: <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a>) -> <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a>;
|
||
|
||
fn <a href="#method.group_id" class="fnname">group_id</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>> { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse a set of arguments into a user-defined container.</p>
|
||
<p>Implementing this trait lets a parent container delegate argument parsing behavior to <code>Self</code>.
|
||
with:</p>
|
||
<ul>
|
||
<li><code>#[command(flatten)] args: ChildArgs</code>: Attribute can only be used with struct fields that impl
|
||
<code>Args</code>.</li>
|
||
<li><code>Variant(ChildArgs)</code>: No attribute is used with enum variants that impl <code>Args</code>.</li>
|
||
</ul>
|
||
<p>See the <a href="crate::_derive">derive reference</a> for attributes and best practices.</p>
|
||
<p><strong>NOTE:</strong> Deriving requires the [<code>derive</code> feature flag][crate::_features]</p>
|
||
<h2 id="example"><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">command</span>(<span class="ident">flatten</span>)]</span>
|
||
<span class="ident">logging</span>: <span class="ident">LogArgs</span>,
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">clap::Args</span>)]</span>
|
||
<span class="kw">struct</span> <span class="ident">LogArgs</span> {
|
||
<span class="attribute">#[<span class="ident">arg</span>(<span class="ident">long</span>, <span class="ident">short</span> <span class="op">=</span> <span class="string">'v'</span>, <span class="ident">action</span> <span class="op">=</span> <span class="ident">clap::ArgAction::Count</span>)]</span>
|
||
<span class="ident">verbose</span>: <span class="ident">i8</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.augment_args" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#292">source</a></div><h4 class="code-header">fn <a href="#tymethod.augment_args" class="fnname">augment_args</a>(cmd: <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a>) -> <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a></h4></div></summary><div class="docblock"><p>Append to <a href="builder/struct.Command.html" title="Command"><code>Command</code></a> so it can instantiate <code>Self</code>.</p>
|
||
<p>See also <a href="trait.CommandFactory.html" title="CommandFactory"><code>CommandFactory</code></a>.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.augment_args_for_update" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#298">source</a></div><h4 class="code-header">fn <a href="#tymethod.augment_args_for_update" class="fnname">augment_args_for_update</a>(cmd: <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a>) -> <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a></h4></div></summary><div class="docblock"><p>Append to <a href="builder/struct.Command.html" title="Command"><code>Command</code></a> so it can update <code>self</code>.</p>
|
||
<p>This is used to implement <code>#[command(flatten)]</code></p>
|
||
<p>See also <a href="trait.CommandFactory.html" title="CommandFactory"><code>CommandFactory</code></a>.</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.group_id" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#286-288">source</a></div><h4 class="code-header">fn <a href="#method.group_id" class="fnname">group_id</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Id.html" title="struct clap::Id">Id</a>></h4></div></summary><div class="docblock"><p>Report the <a href="builder/struct.ArgGroup.html#method.id" title="crate::ArgGroup::id"><code>ArgGroup::id</code></a> for this set of arguments</p>
|
||
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Args-for-Box%3CT%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#447-454">source</a></span><a href="#impl-Args-for-Box%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T: <a class="trait" href="trait.Args.html" title="trait clap::Args">Args</a>> <a class="trait" href="trait.Args.html" title="trait clap::Args">Args</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T></h3></section></summary><div class="impl-items"><section id="method.augment_args" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#448-450">source</a></span><a href="#method.augment_args" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.augment_args" class="fnname">augment_args</a>(cmd: <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a>) -> <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a></h4></section><section id="method.augment_args_for_update" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/clap/derive.rs.html#451-453">source</a></span><a href="#method.augment_args_for_update" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.augment_args_for_update" class="fnname">augment_args_for_update</a>(cmd: <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a>) -> <a class="struct" href="builder/struct.Command.html" title="struct clap::builder::Command">Command</a></h4></section></div></details><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/derive/trait.Args.js" data-ignore-extern-crates="alloc" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |