mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 10:22:19 +00:00
107 lines
31 KiB
HTML
107 lines
31 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="API documentation for the Rust `clap_app` macro in crate `clap`."><meta name="keywords" content="rust, rustlang, rust-lang, clap_app"><title>clap::clap_app - Rust</title><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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc macro"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../clap/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>clap</a></p><script>window.sidebarCurrent = {name: 'clap_app', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><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><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/macros.rs.html#650-800' title='goto source code'>[src]</a></span><span class='in-band'>Macro <a href='index.html'>clap</a>::<wbr><a class="macro" href=''>clap_app</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><div class="example-wrap"><pre class="rust macro">
|
||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">clap_app</span> {
|
||
(@<span class="ident">app</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>)) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">app</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>) (@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">expr</span>): $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">app</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>) (@<span class="ident">arg</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>: $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">app</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>) (@<span class="ident">setting</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">setting</span>:<span class="ident">ident</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">app</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>) (@<span class="ident">attributes</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">app</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>) (@<span class="ident">group</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="op">=</span><span class="op">></span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">app</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>) (@<span class="ident">group</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="op">!</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ident</span>:<span class="ident">ident</span> <span class="op">=</span><span class="op">></span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">app</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>) (@<span class="ident">group</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="op">+</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ident</span>:<span class="ident">ident</span> <span class="op">=</span><span class="op">></span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">app</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>) (@<span class="ident">subcommand</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="op">=</span><span class="op">></span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">app</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>) (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ident</span>:<span class="ident">ident</span>: $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">v</span>:<span class="ident">expr</span>),<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">group</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">group</span>:<span class="ident">expr</span>)) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">group</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">group</span>:<span class="ident">expr</span>) (@<span class="ident">attributes</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">group</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">builder</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">group</span>:<span class="ident">expr</span>) (@<span class="ident">arg</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>: $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> <span class="op">-</span><span class="op">-</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">long</span>:<span class="ident">expr</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> <span class="op">-</span><span class="op">-</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">long</span>:<span class="ident">ident</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> <span class="op">-</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">short</span>:<span class="ident">ident</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) (<span class="op">-</span>) <span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">var</span>:<span class="ident">ident</span><span class="op">></span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) (<span class="op">+</span>) <span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">var</span>:<span class="ident">ident</span><span class="op">></span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) (<span class="op">-</span>) [<span class="macro-nonterminal">$</span><span class="macro-nonterminal">var</span>:<span class="ident">ident</span>] $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) (<span class="op">+</span>) [<span class="macro-nonterminal">$</span><span class="macro-nonterminal">var</span>:<span class="ident">ident</span>] $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> ... $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> #{<span class="macro-nonterminal">$</span><span class="macro-nonterminal">n</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">m</span>:<span class="ident">expr</span>} $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> <span class="op">*</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> <span class="op">!</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ident</span>:<span class="ident">ident</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> <span class="op">+</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ident</span>:<span class="ident">ident</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> {<span class="macro-nonterminal">$</span><span class="macro-nonterminal">fn_</span>:<span class="ident">expr</span>} $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">as_expr</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">expr</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">desc</span>:<span class="ident">tt</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ident</span>:<span class="ident">ident</span>[$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>:<span class="ident">ident</span>)<span class="kw-2">*</span>] $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ident</span>:<span class="ident">ident</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">expr</span>:<span class="ident">expr</span>),<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">arg</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">expr</span>) <span class="macro-nonterminal">$</span><span class="macro-nonterminal">modes</span>:<span class="ident">tt</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ident</span>:<span class="ident">ident</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">expr</span>:<span class="ident">expr</span>,)<span class="kw-2">*</span>) $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(@<span class="ident">subcommand</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="op">=</span><span class="op">></span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
((<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span> <span class="op">=</span><span class="op">></span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tail</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
}</pre></div>
|
||
</div><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>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">matches</span> <span class="op">=</span> <span class="macro">clap_app</span><span class="macro">!</span>(<span class="ident">myapp</span> <span class="op">=</span><span class="op">></span>
|
||
(<span class="ident">version</span>: <span class="string">"1.0"</span>)
|
||
(<span class="ident">author</span>: <span class="string">"Kevin K. <kbknapp@gmail.com>"</span>)
|
||
(<span class="ident">about</span>: <span class="string">"Does awesome things"</span>)
|
||
(@<span class="ident">arg</span> <span class="ident">CONFIG</span>: <span class="op">-</span><span class="ident">c</span> <span class="op">-</span><span class="op">-</span><span class="ident">config</span> <span class="op">+</span><span class="ident">takes_value</span> <span class="string">"Sets a custom config file"</span>)
|
||
(@<span class="ident">arg</span> <span class="ident">INPUT</span>: <span class="op">+</span><span class="ident">required</span> <span class="string">"Sets the input file to use"</span>)
|
||
(@<span class="ident">arg</span> <span class="ident">debug</span>: <span class="op">-</span><span class="ident">d</span> ... <span class="string">"Sets the level of debugging information"</span>)
|
||
(@<span class="ident">group</span> <span class="ident">difficulty</span> <span class="op">=</span><span class="op">></span>
|
||
(@<span class="ident">arg</span> <span class="ident">hard</span>: <span class="op">-</span><span class="ident">h</span> <span class="op">-</span><span class="op">-</span><span class="ident">hard</span> <span class="string">"Sets hard mode"</span>)
|
||
(@<span class="ident">arg</span> <span class="ident">normal</span>: <span class="op">-</span><span class="ident">n</span> <span class="op">-</span><span class="op">-</span><span class="ident">normal</span> <span class="string">"Sets normal mode"</span>)
|
||
(@<span class="ident">arg</span> <span class="ident">easy</span>: <span class="op">-</span><span class="ident">e</span> <span class="op">-</span><span class="op">-</span><span class="ident">easy</span> <span class="string">"Sets easy mode"</span>)
|
||
)
|
||
(@<span class="ident">subcommand</span> <span class="ident">test</span> <span class="op">=</span><span class="op">></span>
|
||
(<span class="ident">about</span>: <span class="string">"controls testing features"</span>)
|
||
(<span class="ident">version</span>: <span class="string">"1.3"</span>)
|
||
(<span class="ident">author</span>: <span class="string">"Someone E. <someone_else@other.com>"</span>)
|
||
(@<span class="ident">arg</span> <span class="ident">verbose</span>: <span class="op">-</span><span class="ident">v</span> <span class="op">-</span><span class="op">-</span><span class="ident">verbose</span> <span class="string">"Print test information verbosely"</span>)
|
||
)
|
||
)
|
||
.<span class="ident">get_matches</span>();</pre></div>
|
||
<h1 id="shorthand-syntax-for-args" class="section-header"><a href="#shorthand-syntax-for-args">Shorthand Syntax for Args</a></h1>
|
||
<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>
|
||
<h1 id="shorthand-syntax-for-groups" class="section-header"><a href="#shorthand-syntax-for-groups">Shorthand Syntax for Groups</a></h1>
|
||
<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></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "clap";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |