edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-09-20 01:24:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/clap_builder/builder/index.html
edg-l 6e454cfb5d deploy: cc1e367982
2024-02-27 06:59:44 +00:00

4 lines
14 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Define `Command` line arguments"><title>clap_builder::builder - 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-ac92e1bbe349e143.css"><meta name="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" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.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">&#9776;</button><a class="logo-container" href="../../clap_builder/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_builder/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><h2><a href="../../clap_builder/index.html">clap_builder</a><span class="version">4.5.1</span></h2></div><h2 class="location"><a href="#">Module builder</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></section><h2><a href="../index.html">In crate clap_builder</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_builder/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_builder</a>::<wbr><a class="mod" href="#">builder</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/builder/mod.rs.html#1-67">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>Define <a href="struct.Command.html" title="struct clap_builder::builder::Command"><code>Command</code></a> line <a href="struct.Arg.html" title="struct clap_builder::builder::Arg">arguments</a></p>
</div></details><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Styles"><code>pub use styling::<a class="struct" href="styling/struct.Styles.html" title="struct clap_builder::builder::styling::Styles">Styles</a>;</code></div></li><li><div class="item-name" id="reexport._AutoValueParser"><code>pub use value_parser::_AutoValueParser;</code></div></li><li><div class="item-name" id="reexport._AnonymousValueParser"><code>pub use value_parser::_AnonymousValueParser;</code></div></li></ul><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="styling/index.html" title="mod clap_builder::builder::styling">styling</a></div><div class="desc docblock-short">Terminal <a href="styling/struct.Styles.html" title="struct clap_builder::builder::styling::Styles"><code>Styles</code></a> for help and error output</div></li></ul><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Arg.html" title="struct clap_builder::builder::Arg">Arg</a></div><div class="desc docblock-short">The abstract representation of a command line argument. Used to set all the options and
relationships that define a valid argument for the program.</div></li><li><div class="item-name"><a class="struct" href="struct.ArgGroup.html" title="struct clap_builder::builder::ArgGroup">ArgGroup</a></div><div class="desc docblock-short">Family of related <a href="struct.Arg.html" title="struct clap_builder::builder::Arg">arguments</a>.</div></li><li><div class="item-name"><a class="struct" href="struct.BoolValueParser.html" title="struct clap_builder::builder::BoolValueParser">BoolValueParser</a></div><div class="desc docblock-short">Implementation for <a href="struct.ValueParser.html#method.bool" title="associated function clap_builder::builder::ValueParser::bool"><code>ValueParser::bool</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.BoolishValueParser.html" title="struct clap_builder::builder::BoolishValueParser">BoolishValueParser</a></div><div class="desc docblock-short">Parse bool-like string values, everything else is <code>true</code></div></li><li><div class="item-name"><a class="struct" href="struct.Command.html" title="struct clap_builder::builder::Command">Command</a></div><div class="desc docblock-short">Build a command-line interface.</div></li><li><div class="item-name"><a class="struct" href="struct.EnumValueParser.html" title="struct clap_builder::builder::EnumValueParser">EnumValueParser</a></div><div class="desc docblock-short">Parse an <a href="../trait.ValueEnum.html" title="trait clap_builder::ValueEnum"><code>ValueEnum</code></a> value.</div></li><li><div class="item-name"><a class="struct" href="struct.FalseyValueParser.html" title="struct clap_builder::builder::FalseyValueParser">FalseyValueParser</a></div><div class="desc docblock-short">Parse false-like string values, everything else is <code>true</code></div></li><li><div class="item-name"><a class="struct" href="struct.MapValueParser.html" title="struct clap_builder::builder::MapValueParser">MapValueParser</a></div><div class="desc docblock-short">Adapt a <code>TypedValueParser</code> from one value to another</div></li><li><div class="item-name"><a class="struct" href="struct.NonEmptyStringValueParser.html" title="struct clap_builder::builder::NonEmptyStringValueParser">NonEmptyStringValueParser</a></div><div class="desc docblock-short">Parse non-empty string values</div></li><li><div class="item-name"><a class="struct" href="struct.OsStr.html" title="struct clap_builder::builder::OsStr">OsStr</a></div><div class="desc docblock-short">A UTF-8-encoded fixed string</div></li><li><div class="item-name"><a class="struct" href="struct.OsStringValueParser.html" title="struct clap_builder::builder::OsStringValueParser">OsStringValueParser</a></div><div class="desc docblock-short">Implementation for <a href="struct.ValueParser.html#method.os_string" title="associated function clap_builder::builder::ValueParser::os_string"><code>ValueParser::os_string</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.PathBufValueParser.html" title="struct clap_builder::builder::PathBufValueParser">PathBufValueParser</a></div><div class="desc docblock-short">Implementation for <a href="struct.ValueParser.html#method.path_buf" title="associated function clap_builder::builder::ValueParser::path_buf"><code>ValueParser::path_buf</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.PossibleValue.html" title="struct clap_builder::builder::PossibleValue">PossibleValue</a></div><div class="desc docblock-short">A possible value of an argument.</div></li><li><div class="item-name"><a class="struct" href="struct.PossibleValuesParser.html" title="struct clap_builder::builder::PossibleValuesParser">PossibleValuesParser</a></div><div class="desc docblock-short">Verify the value is from an enumerated set of <a href="struct.PossibleValue.html" title="struct clap_builder::builder::PossibleValue"><code>PossibleValue</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.RangedI64ValueParser.html" title="struct clap_builder::builder::RangedI64ValueParser">RangedI64ValueParser</a></div><div class="desc docblock-short">Parse number that fall within a range of values</div></li><li><div class="item-name"><a class="struct" href="struct.RangedU64ValueParser.html" title="struct clap_builder::builder::RangedU64ValueParser">RangedU64ValueParser</a></div><div class="desc docblock-short">Parse number that fall within a range of values</div></li><li><div class="item-name"><a class="struct" href="struct.Str.html" title="struct clap_builder::builder::Str">Str</a></div><div class="desc docblock-short">A UTF-8-encoded fixed string</div></li><li><div class="item-name"><a class="struct" href="struct.StringValueParser.html" title="struct clap_builder::builder::StringValueParser">StringValueParser</a></div><div class="desc docblock-short">Implementation for <a href="struct.ValueParser.html#method.string" title="associated function clap_builder::builder::ValueParser::string"><code>ValueParser::string</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.StyledStr.html" title="struct clap_builder::builder::StyledStr">StyledStr</a></div><div class="desc docblock-short">Terminal-styling container</div></li><li><div class="item-name"><a class="struct" href="struct.TryMapValueParser.html" title="struct clap_builder::builder::TryMapValueParser">TryMapValueParser</a></div><div class="desc docblock-short">Adapt a <code>TypedValueParser</code> from one value to another</div></li><li><div class="item-name"><a class="struct" href="struct.UnknownArgumentValueParser.html" title="struct clap_builder::builder::UnknownArgumentValueParser">UnknownArgumentValueParser</a></div><div class="desc docblock-short">When encountered, report <a href="../error/enum.ErrorKind.html#variant.UnknownArgument" title="variant clap_builder::error::ErrorKind::UnknownArgument">ErrorKind::UnknownArgument</a></div></li><li><div class="item-name"><a class="struct" href="struct.ValueParser.html" title="struct clap_builder::builder::ValueParser">ValueParser</a></div><div class="desc docblock-short">Parse/validate argument values</div></li><li><div class="item-name"><a class="struct" href="struct.ValueRange.html" title="struct clap_builder::builder::ValueRange">ValueRange</a></div><div class="desc docblock-short">Values per occurrence for an argument</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ArgAction.html" title="enum clap_builder::builder::ArgAction">ArgAction</a></div><div class="desc docblock-short">Behavior of arguments when they are encountered while parsing</div></li><li><div class="item-name"><a class="enum" href="enum.ArgPredicate.html" title="enum clap_builder::builder::ArgPredicate">ArgPredicate</a></div><div class="desc docblock-short">Operations to perform on argument values</div></li><li><div class="item-name"><a class="enum" href="enum.Resettable.html" title="enum clap_builder::builder::Resettable">Resettable</a></div><div class="desc docblock-short">Clearable builder value</div></li><li><div class="item-name"><a class="enum" href="enum.ValueHint.html" title="enum clap_builder::builder::ValueHint">ValueHint</a></div><div class="desc docblock-short">Provide shell with hint on how to complete an argument.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.IntoResettable.html" title="trait clap_builder::builder::IntoResettable">IntoResettable</a></div><div class="desc docblock-short">Convert to the intended resettable type</div></li><li><div class="item-name"><a class="trait" href="trait.TypedValueParser.html" title="trait clap_builder::builder::TypedValueParser">TypedValueParser</a></div><div class="desc docblock-short">Parse/validate argument values</div></li><li><div class="item-name"><a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a></div><div class="desc docblock-short">Register a type with <a href="../macro.value_parser.html" title="macro clap_builder::value_parser">value_parser!</a></div></li></ul></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink