<!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="clap_builder"><title>clap_builder - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-ac92e1bbe349e143.css"><metaname="rustdoc-vars"data-root-path="../"data-static-root-path="../static.files/"data-current-crate="clap_builder"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"><scriptsrc="../static.files/storage-f2adc0d6ca4d09fb.js"></script><scriptdefersrc="../crates.js"></script><scriptdefersrc="../static.files/main-305769736d49e732.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-feafe1bb7466e4bd.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 mod crate"><!--[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">☰</button><aclass="logo-container"href="../clap_builder/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_builder/index.html"><imgsrc="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png"alt="logo"></a><h2><ahref="../clap_builder/index.html">clap_builder</a><spanclass="version">4.5.2</span></h2></div><divclass="sidebar-elems"><ulclass="block">
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../clap_builder/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>Crate <aclass="mod"href="#">clap_builder</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/lib.rs.html#6-66">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><h2id="clap_builder"><ahref="#clap_builder">clap_builder</a></h2>
<li>Apache License, Version 2.0 (<ahref="LICENSE-APACHE">LICENSE-APACHE</a> or <ahref="https://www.apache.org/licenses/LICENSE-2.0">https://www.apache.org/licenses/LICENSE-2.0</a>)</li>
<li>MIT license (<ahref="LICENSE-MIT">LICENSE-MIT</a> or <ahref="https://opensource.org/licenses/MIT">https://opensource.org/licenses/MIT</a>)</li>
<p>Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.</p>
<p>See <ahref="CONTRIBUTING.md">CONTRIBUTING</a> for more details.</p>
</div></details><h2id="reexports"class="section-header"><ahref="#reexports">Re-exports</a></h2><ulclass="item-table"><li><divclass="item-name"id="reexport.ArgAction"><code>pub use crate::builder::<aclass="enum"href="builder/enum.ArgAction.html"title="enum clap_builder::builder::ArgAction">ArgAction</a>;</code></div></li><li><divclass="item-name"id="reexport.Command"><code>pub use crate::builder::<aclass="struct"href="builder/struct.Command.html"title="struct clap_builder::builder::Command">Command</a>;</code></div></li><li><divclass="item-name"id="reexport.ValueHint"><code>pub use crate::builder::<aclass="enum"href="builder/enum.ValueHint.html"title="enum clap_builder::builder::ValueHint">ValueHint</a>;</code></div></li><li><divclass="item-name"id="reexport.Arg"><code>pub use crate::builder::<aclass="struct"href="builder/struct.Arg.html"title="struct clap_builder::builder::Arg">Arg</a>;</code></div></li><li><divclass="item-name"id="reexport.ArgGroup"><code>pub use crate::builder::<aclass="struct"href="builder/struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup">ArgGroup</a>;</code></div></li><li><divclass="item-name"id="reexport.ArgMatches"><code>pub use crate::parser::<aclass="struct"href="parser/struct.ArgMatches.html"title="struct clap_builder::parser::ArgMatches">ArgMatches</a>;</code></div></li></ul><h2id="modules"class="section-header"><ahref="#modules">Modules</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="mod"href="builder/index.html"title="mod clap_builder::builder">builder</a></div><divclass="desc docblock-short">Define <ahref="builder/struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a> line <ahref="builder/struct.Arg.html"title="struct clap_builder::builder::Arg">arguments</a></div></li><li><divclass="item-name"><aclass="mod"href="error/index.html"title="mod clap_builder::error">error</a></div><divclass="desc docblock-short">Error reporting</div></li><li><divclass="item-name"><aclass="mod"href="parser/index.html"title="mod clap_builder::parser">parser</a></div><divclass="desc docblock-short"><ahref="builder/struct.Command.html"title="struct clap_builder::builder::Command"><code>Command</code></a> line argument parser</div></li></ul><h2id="macros"class="section-header"><ahref="#macros">Macros</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="macro"href="macro.arg.html"title="macro clap_builder::arg">arg</a></div><divclass="desc docblock-short">Create an <ahref="builder/struct.Arg.html"title="struct clap_builder::builder::Arg"><code>Arg</code></a> from a usage string.</div></li><li><divclass="item-name"><aclass="macro"href="macro.command.html"title="macro clap_builder::command">command</a></div><divclass="desc docblock-short">Requires <code>cargo</code> feature flag to be enabled.</div></li><li><divclass="item-name"><aclass="macro"href="macro.value_parser.html"title="macro clap_builder::value_parser">value_parser</a></div><divclass="desc docblock-short">Select a <ahref="builder/struct.ValueParser.html"title="struct clap_builder::builder::ValueParser"><code>ValueParser</code></a> implementation from the intended type</div></li></ul><h2id="structs"class="section-header"><ahref="#structs">Structs</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.Id.html"title="struct clap_builder::Id">Id</a></div><divclass="desc docblock-short"><ahref="builder/struct.Arg.html"title="struct clap_builder::builder::Arg"><code>Arg</code></a> or <ahref="builder/struct.ArgGroup.html"title="struct clap_builder::builder::ArgGroup"><code>ArgGroup</code></a> identifier</div></li></ul><h2id="enums"class="section-header"><ahref="#enums">Enums</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.ColorChoice.html"title="enum clap_builder::ColorChoice">ColorChoice</a></div><divclass="desc docblock-short">Represents the color preferences for program output</div></li></ul><h2id="traits"class="sec