edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-24 00:48:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/clap_builder/builder/trait.ValueParserFactory.html

47 lines
44 KiB
HTML
Raw Normal View History

deploy: cc1e3679829ec7c574392bace9092ffa4ecb73c2
2024-02-27 06:59:44 +00:00
<!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="Register a type with value_parser!"><title>ValueParserFactory in 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 trait"><!--[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="#">ValueParserFactory</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Parser">Parser</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.value_parser">value_parser</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ValueParserFactory-for-Arc%3CT%3E">Arc&lt;T&gt;</a></li><li><a href="#impl-ValueParserFactory-for-Box%3COsStr%3E">Box&lt;OsStr&gt;</a></li><li><a href="#impl-ValueParserFactory-for-Box%3CPath%3E">Box&lt;Path&gt;</a></li><li><a href="#impl-ValueParserFactory-for-Box%3CT%3E">Box&lt;T&gt;</a></li><li><a href="#impl-ValueParserFactory-for-Box%3Cstr%3E">Box&lt;str&gt;</a></li><li><a href="#impl-ValueParserFactory-for-OsString">OsString</a></li><li><a href="#impl-ValueParserFactory-for-PathBuf">PathBuf</a></li><li><a href="#impl-ValueParserFactory-for-String">String</a></li><li><a href="#impl-ValueParserFactory-for-Wrapping%3CT%3E">Wrapping&lt;T&gt;</a></li><li><a href="#impl-ValueParserFactory-for-bool">bool</a></li><li><a href="#impl-ValueParserFactory-for-i16">i16</a></li><li><a href="#impl-ValueParserFactory-for-i32">i32</a></li>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<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>Trait <a href="../index.html">clap_builder</a>::<wbr><a href="index.html">builder</a>::<wbr><a class="trait" href="#">ValueParserFactory</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/value_parser.rs.html#2312-2321">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait ValueParserFactory {
type <a href="#associatedtype.Parser" class="associatedtype">Parser</a>;
// Required method
fn <a href="#tymethod.value_parser" class="fn">value_parser</a>() -&gt; Self::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Register a type with <a href="../macro.value_parser.html" title="macro clap_builder::value_parser">value_parser!</a></p>
<h2 id="example"><a href="#example">Example</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#[derive(Copy, Clone, Debug)]
</span><span class="kw">pub struct </span>Custom(u32);
<span class="kw">impl </span>clap::builder::ValueParserFactory <span class="kw">for </span>Custom {
<span class="kw">type </span>Parser = CustomValueParser;
<span class="kw">fn </span>value_parser() -&gt; <span class="self">Self</span>::Parser {
CustomValueParser
}
}
<span class="attr">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>CustomValueParser;
<span class="kw">impl </span>clap::builder::TypedValueParser <span class="kw">for </span>CustomValueParser {
<span class="kw">type </span>Value = Custom;
<span class="kw">fn </span>parse_ref(
<span class="kw-2">&amp;</span><span class="self">self</span>,
cmd: <span class="kw-2">&amp;</span>clap::Command,
arg: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>clap::Arg&gt;,
value: <span class="kw-2">&amp;</span>std::ffi::OsStr,
) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>::Value, clap::Error&gt; {
<span class="kw">let </span>inner = <span class="macro">clap::value_parser!</span>(u32);
<span class="kw">let </span>val = inner.parse_ref(cmd, arg, value)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Custom(val))
}
}
<span class="kw">let </span>parser: CustomValueParser = <span class="macro">clap::value_parser!</span>(Custom);</code></pre></div>
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Parser" class="method"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2317">source</a><h4 class="code-header">type <a href="#associatedtype.Parser" class="associatedtype">Parser</a></h4></section></summary><div class="docblock"><p>Generated parser, usually <a href="struct.ValueParser.html" title="struct clap_builder::builder::ValueParser"><code>ValueParser</code></a>.</p>
<p>It should at least be a type that supports <code>Into&lt;ValueParser&gt;</code>. A non-<code>ValueParser</code> type
allows the caller to do further initialization on the parser.</p>
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.value_parser" class="method"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2320">source</a><h4 class="code-header">fn <a href="#tymethod.value_parser" class="fn">value_parser</a>() -&gt; Self::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a></h4></section></summary><div class="docblock"><p>Create the specified <a href="trait.ValueParserFactory.html#associatedtype.Parser"><code>Self::Parser</code></a></p>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-ValueParserFactory-for-bool" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2360-2365">source</a><a href="#impl-ValueParserFactory-for-bool" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Parser-1" class="associatedtype trait-impl"><a href="#associatedtype.Parser-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Parser" class="associatedtype">Parser</a> = <a class="struct" href="struct.ValueParser.html" title="struct clap_builder::builder::ValueParser">ValueParser</a></h4></section><section id="method.value_parser" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2362-2364">source</a><a href="#method.value_parser" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.value_parser" class="fn">value_parser</a>() -&gt; Self::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ValueParserFactory-for-i8" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2374-2381">source</a><a href="#impl-ValueParserFactory-for-i8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i8.html">i8</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Parser-2" class="associatedtype trait-impl"><a href="#associatedtype.Parser-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Parser" class="associatedtype">Parser</a> = <a class="struct" href="struct.RangedI64ValueParser.html" title="struct clap_builder::builder::RangedI64ValueParser">RangedI64ValueParser</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i8.html">i8</a>&gt;</h4></section><section id="method.value_parser-1" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2376-2380">source</a><a href="#method.value_parser-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.value_parser" class="fn">value_parser</a>() -&gt; Self::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ValueParserFactory-for-i16" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2390-2397">source</a><a href="#impl-ValueParserFactory-for-i16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i16.html">i16</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Parser-3" class="associatedtype
T: <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
&lt;T as <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a>&gt;::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a>: <a class="trait" href="trait.TypedValueParser.html" title="trait clap_builder::builder::TypedValueParser">TypedValueParser</a>&lt;Value = T&gt;,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Parser-16" class="associatedtype trait-impl"><a href="#associatedtype.Parser-16" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Parser" class="associatedtype">Parser</a> = <a class="struct" href="struct.MapValueParser.html" title="struct clap_builder::builder::MapValueParser">MapValueParser</a>&lt;&lt;T as <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a>&gt;::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.fn.html">fn</a>(_: T) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;T&gt;&gt;</h4></section><section id="method.value_parser-15" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2444-2446">source</a><a href="#method.value_parser-15" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.value_parser" class="fn">value_parser</a>() -&gt; Self::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ValueParserFactory-for-Arc%3CT%3E" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2448-2458">source</a><a href="#impl-ValueParserFactory-for-Arc%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a> for <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;T&gt;<div class="where">where
T: <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
&lt;T as <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a>&gt;::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a>: <a class="trait" href="trait.TypedValueParser.html" title="trait clap_builder::builder::TypedValueParser">TypedValueParser</a>&lt;Value = T&gt;,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Parser-17" class="associatedtype trait-impl"><a href="#associatedtype.Parser-17" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Parser" class="associatedtype">Parser</a> = <a class="struct" href="struct.MapValueParser.html" title="struct clap_builder::builder::MapValueParser">MapValueParser</a>&lt;&lt;T as <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a>&gt;::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.fn.html">fn</a>(_: T) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;T&gt;&gt;</h4></section><section id="method.value_parser-16" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2455-2457">source</a><a href="#method.value_parser-16" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.value_parser" class="fn">value_parser</a>() -&gt; Self::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ValueParserFactory-for-Wrapping%3CT%3E" class="impl"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2426-2436">source</a><a href="#impl-ValueParserFactory-for-Wrapping%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a> for <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;<div class="where">where
T: <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
&lt;T as <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a>&gt;::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a>: <a class="trait" href="trait.TypedValueParser.html" title="trait clap_builder::builder::TypedValueParser">TypedValueParser</a>&lt;Value = T&gt;,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Parser-18" class="associatedtype trait-impl"><a href="#associatedtype.Parser-18" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Parser" class="associatedtype">Parser</a> = <a class="struct" href="struct.MapValueParser.html" title="struct clap_builder::builder::MapValueParser">MapValueParser</a>&lt;&lt;T as <a class="trait" href="trait.ValueParserFactory.html" title="trait clap_builder::builder::ValueParserFactory">ValueParserFactory</a>&gt;::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.fn.html">fn</a>(_: T) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/num/wrapping/struct.Wrapping.html" title="struct core::num::wrapping::Wrapping">Wrapping</a>&lt;T&gt;&gt;</h4></section><section id="method.value_parser-17" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/builder/value_parser.rs.html#2433-2435">source</a><a href="#method.value_parser-17" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.value_parser" class="fn">value_parser</a>() -&gt; Self::<a class="associatedtype" href="trait.ValueParserFactory.html#associatedtype.Parser" title="type clap_builder::builder::ValueParserFactory::Parser">Parser</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/clap_builder/builder/value_parser/trait.ValueParserFactory.js" data-ignore-extern-crates="alloc,core,std" async></script></section></div></main></body></html>
Reference in a new issue Copy permalink