| <!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="Build `App`, `Arg`s, `SubCommand`s and `Group`s with Usage-string like input but without the associated parsing runtime cost."><meta name="keywords" content="rust, rustlang, rust-lang, clap_app"><title>clap_app 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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" 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 macro"><!--[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 class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2><a href="index.html">In clap</a></h2></div></nav><main><div class="width-limiter"><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"><a href="../help.html">?</a></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><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Macro <a href="index.html">clap</a>::<wbr><a class="macro" href="#">clap_app</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></h1><span class="out-of-band"><a class="srclink" href="../src/clap/macros.rs.html#666-816">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules! </span>clap_app { |
| (@app (<span class="macro-nonterminal">$builder</span>:expr)) => { ... }; |
| (@app (<span class="macro-nonterminal">$builder</span>:expr) (@arg (<span class="macro-nonterminal">$name</span>:expr): $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@app (<span class="macro-nonterminal">$builder</span>:expr) (@arg <span class="macro-nonterminal">$name</span>:ident: $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@app (<span class="macro-nonterminal">$builder</span>:expr) (@setting <span class="macro-nonterminal">$setting</span>:ident) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@app (<span class="macro-nonterminal">$builder</span>:expr) (@attributes $(<span class="macro-nonterminal">$attr</span>:tt)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@app (<span class="macro-nonterminal">$builder</span>:expr) (@group <span class="macro-nonterminal">$name</span>:ident => $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@app (<span class="macro-nonterminal">$builder</span>:expr) (@group <span class="macro-nonterminal">$name</span>:ident !<span class="macro-nonterminal">$ident</span>:ident => $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@app (<span class="macro-nonterminal">$builder</span>:expr) (@group <span class="macro-nonterminal">$name</span>:ident +<span class="macro-nonterminal">$ident</span>:ident => $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@app (<span class="macro-nonterminal">$builder</span>:expr) (@subcommand <span class="macro-nonterminal">$name</span>:ident => $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@app (<span class="macro-nonterminal">$builder</span>:expr) (<span class="macro-nonterminal">$ident</span>:ident: $(<span class="macro-nonterminal">$v</span>:expr),<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@group (<span class="macro-nonterminal">$builder</span>:expr, <span class="macro-nonterminal">$group</span>:expr)) => { ... }; |
| (@group (<span class="macro-nonterminal">$builder</span>:expr, <span class="macro-nonterminal">$group</span>:expr) (@attributes $(<span class="macro-nonterminal">$attr</span>:tt)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@group (<span class="macro-nonterminal">$builder</span>:expr, <span class="macro-nonterminal">$group</span>:expr) (@arg <span class="macro-nonterminal">$name</span>:ident: $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt --(<span class="macro-nonterminal">$long</span>:expr) $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt --<span class="macro-nonterminal">$long</span>:ident $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt -<span class="macro-nonterminal">$short</span>:ident $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) (-) <<span class="macro-nonterminal">$var</span>:ident> $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) (+) <<span class="macro-nonterminal">$var</span>:ident> $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) (-) [<span class="macro-nonterminal">$var</span>:ident] $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) (+) [<span class="macro-nonterminal">$var</span>:ident] $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt ... $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt #{<span class="macro-nonterminal">$n</span>:expr, <span class="macro-nonterminal">$m</span>:expr} $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt * $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt !<span class="macro-nonterminal">$ident</span>:ident $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt +<span class="macro-nonterminal">$ident</span>:ident $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt {<span class="macro-nonterminal">$fn_</span>:expr} $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@as_expr <span class="macro-nonterminal">$expr</span>:expr) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt <span class="macro-nonterminal">$desc</span>:tt) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt <span class="macro-nonterminal">$ident</span>:ident[$(<span class="macro-nonterminal">$target</span>:ident)<span class="kw-2">*</span>] $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt <span class="macro-nonterminal">$ident</span>:ident($(<span class="macro-nonterminal">$expr</span>:expr),<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@arg (<span class="macro-nonterminal">$arg</span>:expr) <span class="macro-nonterminal">$modes</span>:tt <span class="macro-nonterminal">$ident</span>:ident($(<span class="macro-nonterminal">$expr</span>:expr,)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (@subcommand <span class="macro-nonterminal">$name</span>:ident => $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| ((<span class="macro-nonterminal">$name</span>:expr) => $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| (<span class="macro-nonterminal">$name</span>:ident => $(<span class="macro-nonterminal">$tail</span>:tt)<span class="kw-2">*</span>) => { ... }; |
| }</code></pre></div> |
| </div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Build <code>App</code>, <code>Arg</code>s, <code>SubCommand</code>s and <code>Group</code>s with Usage-string like input |
| but without the associated parsing runtime cost.</p> |
| <p><code>clap_app!</code> also supports several shorthand syntaxes.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>matches = <span class="macro">clap_app!</span>(myapp => |
| (version: <span class="string">"1.0"</span>) |
| (author: <span class="string">"Kevin K. <kbknapp@gmail.com>"</span>) |
| (about: <span class="string">"Does awesome things"</span>) |
| (@arg CONFIG: -c --config +takes_value <span class="string">"Sets a custom config file"</span>) |
| (@arg INPUT: +required <span class="string">"Sets the input file to use"</span>) |
| (@arg debug: -d ... <span class="string">"Sets the level of debugging information"</span>) |
| (@group difficulty => |
| (@arg hard: -h --hard <span class="string">"Sets hard mode"</span>) |
| (@arg normal: -n --normal <span class="string">"Sets normal mode"</span>) |
| (@arg easy: -e --easy <span class="string">"Sets easy mode"</span>) |
| ) |
| (@subcommand test => |
| (about: <span class="string">"controls testing features"</span>) |
| (version: <span class="string">"1.3"</span>) |
| (author: <span class="string">"Someone E. <someone_else@other.com>"</span>) |
| (@arg verbose: -v --verbose <span class="string">"Print test information verbosely"</span>) |
| ) |
| ) |
| .get_matches();</code></pre></div> |
| <h2 id="shorthand-syntax-for-args"><a href="#shorthand-syntax-for-args">Shorthand Syntax for Args</a></h2> |
| <ul> |
| <li>A single hyphen followed by a character (such as <code>-c</code>) sets the <a href="./struct.Arg.html#method.short"><code>Arg::short</code></a></li> |
| <li>A double hyphen followed by a character or word (such as <code>--config</code>) sets <a href="./struct.Arg.html#method.long"><code>Arg::long</code></a> |
| <ul> |
| <li>If one wishes to use a <a href="./struct.Arg.html#method.long"><code>Arg::long</code></a> with a hyphen inside (i.e. <code>--config-file</code>), you |
| must use <code>--("config-file")</code> due to limitations of the Rust macro system.</li> |
| </ul> |
| </li> |
| <li>Three dots (<code>...</code>) sets <a href="./struct.Arg.html#method.multiple"><code>Arg::multiple(true)</code></a></li> |
| <li>Angled brackets after either a short or long will set <a href="./struct.Arg.html#method.value_name"><code>Arg::value_name</code></a> and |
| <code>Arg::required(true)</code> such as <code>--config <FILE></code> = <code>Arg::value_name("FILE")</code> and |
| <code>Arg::required(true)</code></li> |
| <li>Square brackets after either a short or long will set <a href="./struct.Arg.html#method.value_name"><code>Arg::value_name</code></a> and |
| <code>Arg::required(false)</code> such as <code>--config [FILE]</code> = <code>Arg::value_name("FILE")</code> and |
| <code>Arg::required(false)</code></li> |
| <li>There are short hand syntaxes for Arg methods that accept booleans |
| <ul> |
| <li>A plus sign will set that method to <code>true</code> such as <code>+required</code> = <code>Arg::required(true)</code></li> |
| <li>An exclamation will set that method to <code>false</code> such as <code>!required</code> = <code>Arg::required(false)</code></li> |
| </ul> |
| </li> |
| <li>A <code>#{min, max}</code> will set <a href="./struct.Arg.html#method.min_values"><code>Arg::min_values(min)</code></a> and <a href="./struct.Arg.html#method.max_values"><code>Arg::max_values(max)</code></a></li> |
| <li>An asterisk (<code>*</code>) will set <code>Arg::required(true)</code></li> |
| <li>Curly brackets around a <code>fn</code> will set <a href="./struct.Arg.html#method.validator"><code>Arg::validator</code></a> as in <code>{fn}</code> = <code>Arg::validator(fn)</code></li> |
| <li>An Arg method that accepts a string followed by square brackets will set that method such as |
| <code>conflicts_with[FOO]</code> will set <code>Arg::conflicts_with("FOO")</code> (note the lack of quotes around |
| <code>FOO</code> in the macro)</li> |
| <li>An Arg method that takes a string and can be set multiple times (such as |
| <a href="./struct.Arg.html#method.conflicts_with"><code>Arg::conflicts_with</code></a>) followed by square brackets and a list of values separated by spaces |
| will set that method such as <code>conflicts_with[FOO BAR BAZ]</code> will set |
| <code>Arg::conflicts_with("FOO")</code>, <code>Arg::conflicts_with("BAR")</code>, and <code>Arg::conflicts_with("BAZ")</code> |
| (note the lack of quotes around the values in the macro)</li> |
| </ul> |
| <h2 id="shorthand-syntax-for-groups"><a href="#shorthand-syntax-for-groups">Shorthand Syntax for Groups</a></h2> |
| <ul> |
| <li>There are short hand syntaxes for <code>ArgGroup</code> methods that accept booleans |
| <ul> |
| <li>A plus sign will set that method to <code>true</code> such as <code>+required</code> = <code>ArgGroup::required(true)</code></li> |
| <li>An exclamation will set that method to <code>false</code> such as <code>!required</code> = <code>ArgGroup::required(false)</code></li> |
| </ul> |
| </li> |
| </ul> |
| </div></details></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.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
