<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Parse a sub-command into a user-defined enum."><title>Subcommand in clap - Rust</title><script>if(window.location.protocol!=="file:")document.write(`<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">`)</script><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-e935ef01ae1c1829.css"><metaname="rustdoc-vars"data-root-path="../"data-static-root-path="../static.files/"data-current-crate="clap"data-themes=""data-resource-suffix=""data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)"data-channel="1.78.0"data-search-js="search-42d8da7a6b9792c2.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button><aclass="logo-container"href="../clap/index.html"><imgsrc="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png"alt=""></a></nav><navclass="sidebar"><divclass="sidebar-crate"><aclass="logo-container"href="../clap/index.html"><imgsrc="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png"alt="logo"></a><h2><ahref="../clap/index.html">clap</a><spanclass="version">4.5.4</span></h2></div><h2class="location"><ahref="#">Subcommand</a></h2><divclass="sidebar-elems"><section><h3><ahref="#required-methods">Required Methods</a></h3><ulclass="block"><li><ahref="#tymethod.augment_subcommands">augment_subcommands</a></li><li><ahref="#tymethod.augment_subcommands_for_update">augment_subcommands_for_update</a></li><li><ahref="#tymethod.has_subcommand">has_subcommand</a></li></ul><h3><ahref="#foreign-impls">Implementations on Foreign Types</a></h3><ulclass="block"><li><ahref="#impl-Subcommand-for-Box%3CT%3E">Box<T></a></li></ul><h3><ahref="#object-safety">Object Safety</a></h3><h3><ahref="#implementors">Implementors</a></h3></section><h2><ahref="index.html">In crate clap</a></h2></div></nav><divclass="sidebar-resizer"></div>
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../clap/all.html"title="show sidebar"></a></div><inputclass="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"><divid="help-button"tabindex="-1"><ahref="../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Trait <ahref="index.html">clap</a>::<wbr><aclass="trait"href="#">Subcommand</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../src/clap_builder/derive.rs.html#241">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub trait Subcommand: <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a> + <aclass="trait"href="trait.FromArgMatches.html"title="trait clap::FromArgMatches">FromArgMatches</a> {
}</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Parse a sub-command into a user-defined enum.</p>
<p>Implementing this trait lets a parent container delegate subcommand behavior to <code>Self</code>.
with:</p>
<ul>
<li><code>#[command(subcommand)] field: SubCmd</code>: Attribute can be used with either struct fields or enum
variants that impl <code>Subcommand</code>.</li>
<li><code>#[command(flatten)] Variant(SubCmd)</code>: Attribute can only be used with enum variants that impl
<code>Subcommand</code>.</li>
</ul>
<p><strong>NOTE:</strong> Deriving requires the <code>derive</code> feature flag</p>
</div></details><h2id="required-methods"class="section-header">Required Methods<ahref="#required-methods"class="anchor">§</a></h2><divclass="methods"><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.augment_subcommands"class="method"><aclass="src rightside"href="../src/clap_builder/derive.rs.html#245">source</a><h4class="code-header">fn <ahref="#tymethod.augment_subcommands"class="fn">augment_subcommands</a>(cmd: <aclass="struct"href="struct.Command.html"title="struct clap::Command">Command</a>) -><aclass="struct"href="struct.Command.html"title="struct clap::Command">Command</a></h4></section></summary><divclass="docblock"><p>Append to <ahref="struct.Command.html"title="struct clap::Command"><code>Command</code></a> so it can instantiate <code>Self</code>.</p>
<p>See also <ahref="trait.CommandFactory.html"title="trait clap::CommandFactory"><code>CommandFactory</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.augment_subcommands_for_update"class="method"><aclass="src rightside"href="../src/clap_builder/derive.rs.html#251">source</a><h4class="code-header">fn <ahref="#tymethod.augment_subcommands_for_update"class="fn">augment_subcommands_for_update</a>(cmd: <aclass="struct"href="struct.Command.html"title="struct clap::Command">Command</a>) -><aclass="struct"href="struct.Command.html"title="struct clap::Command">Command</a></h4></section></summary><divclass="docblock"><p>Append to <ahref="struct.Command.html"title="struct clap::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 <ahref="trait.CommandFactory.html"title="trait clap::CommandFactory"><code>CommandFactory</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="tymethod.has_subcommand"class="method"><aclass="src rightside"href="../src/clap_builder/derive.rs.html#253">source</a><h4class="code-header">fn <ahref="#tymethod.has_subcommand"class="fn">has_subcommand</a>(name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>) -><aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><divclass="docblock"><p>Test whether <code>Self</code> can parse a specific subcommand</p>
</div></details></div><h2id="object-safety"class="section-header">Object Safety<ahref="#object-safety"class="anchor">§</a></h2><divclass="object-safety-info">This trait is <b>not</b><ahref="https://doc.rust-lang.org/1.78.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2id="foreign-impls"class="section-header">Implementations on Foreign Types<ahref="#foreign-impls"class="anchor">§</a></h2><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Subcommand-for-Box%3CT%3E"class="impl"><aclass="src rightside"href="../src/clap_builder/derive.rs.html#346">source</a><ahref="#impl-Subcommand-for-Box%3CT%3E"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="trait.Subcommand.html"title="trait clap::Subcommand">Subcommand</a> for <aclass="struct"href="https://doc.rust-lang.org/1.78.0/alloc/boxed/struct.Box.html"title="struct alloc::boxed::Box">Box</a><T><divclass="where">where
