edlang/clap/parser/index.html

3 lines
7.3 KiB
HTML
Raw Normal View History

<!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="`Command` line argument parser"><title>clap::parser - Rust</title><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"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-5bc39a1768837dd0.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="clap" data-themes="" data-resource-suffix="" data-rustdoc-version="1.77.0 (aedd173a2 2024-03-17)" data-channel="1.77.0" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-48f368f3872407c8.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[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" title="show sidebar"></button><a class="logo-container" href="../../clap/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../clap/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><h2><a href="../../clap/index.html">clap</a><span class="version">4.5.2</span></h2></div><h2 class="location"><a href="#">Module parser</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section><h2><a href="../index.html">In crate clap</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../clap/all.html" title="show sidebar"></a></div><input class="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"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">clap</a>::<wbr><a class="mod" href="#">parser</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/clap_builder/lib.rs.html#59">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="../struct.Command.html" title="struct clap::Command"><code>Command</code></a> line argument parser</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ArgMatches.html" title="struct clap::parser::ArgMatches">ArgMatches</a></div><div class="desc docblock-short">Container for parse results.</div></li><li><div class="item-name"><a class="struct" href="struct.IdsRef.html" title="struct clap::parser::IdsRef">IdsRef</a></div><div class="desc docblock-short">Iterate over <a href="../struct.Arg.html" title="struct clap::Arg"><code>Arg</code></a> and <a href="../struct.ArgGroup.html" title="struct clap::ArgGroup"><code>ArgGroup</code></a> <a href="../struct.Id.html" title="struct clap::Id"><code>Id</code></a>s via <a href="../struct.ArgMatches.html#method.ids" title="method clap::ArgMatches::ids"><code>ArgMatches::ids</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Indices.html" title="struct clap::parser::Indices">Indices</a></div><div class="desc docblock-short">Iterate over indices for where an argument appeared when parsing, via <a href="../struct.ArgMatches.html#method.indices_of" title="method clap::ArgMatches::indices_of"><code>ArgMatches::indices_of</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.RawValues.html" title="struct clap::parser::RawValues">RawValues</a></div><div class="desc docblock-short">Iterate over raw argument values via <a href="../struct.ArgMatches.html#method.get_raw" title="method clap::ArgMatches::get_raw"><code>ArgMatches::get_raw</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Values.html" title="struct clap::parser::Values">Values</a></div><div class="desc docblock-short">Iterate over multiple values for an argument via <a href="../struct.ArgMatches.html#method.remove_many" title="method clap::ArgMatches::remove_many"><code>ArgMatches::remove_many</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ValuesRef.html" title="struct clap::parser::ValuesRef">ValuesRef</a></div><div class="desc docblock-short">Iterate over multiple values for an argument via <a href="../struct.ArgMatches.html#method.get_many" title="method clap::ArgMatches::get_many"><code>ArgMatches::get_many</code></a>.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.MatchesError.html" title="enum clap::parser::MatchesError">MatchesError</a></div><div class="desc docblock-short">Violation of <a href="../struct.ArgMatches.html" title="struct clap::ArgMatches"><code>ArgMatches</code></a> assumptions</div></li><li><div class="item-name"><a class="enum" href="enum.ValueSource.html" title="enum clap::parser::ValueSource">ValueSource</a></div><div class="desc docblock-short">Origin of the arguments value</div></li></ul></section></div></main></body></html>