mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 00:18:24 +00:00
62 lines
17 KiB
HTML
62 lines
17 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="Converts an instance of `ArgMatches` to a user-defined container."><title>FromArgMatches in clap - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><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" 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.11</span></h2></div><h2 class="location"><a href="#">FromArgMatches</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.from_arg_matches">from_arg_matches</a></li><li><a href="#tymethod.update_from_arg_matches">update_from_arg_matches</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.from_arg_matches_mut">from_arg_matches_mut</a></li><li><a href="#method.update_from_arg_matches_mut">update_from_arg_matches_mut</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-FromArgMatches-for-Box%3CT%3E">Box<T></a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate clap</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">clap</a>::<wbr><a class="trait" href="#">FromArgMatches</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/clap_builder/derive.rs.html#121">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait FromArgMatches: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.from_arg_matches" class="fn">from_arg_matches</a>(matches: &<a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.update_from_arg_matches" class="fn">update_from_arg_matches</a>(
|
|
&mut self,
|
|
matches: &<a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>>;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.from_arg_matches_mut" class="fn">from_arg_matches_mut</a>(matches: &mut <a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.update_from_arg_matches_mut" class="fn">update_from_arg_matches_mut</a>(
|
|
&mut self,
|
|
matches: &mut <a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Converts an instance of <a href="struct.ArgMatches.html" title="struct clap::ArgMatches"><code>ArgMatches</code></a> to a user-defined container.</p>
|
|
<p>Derived as part of <a href="trait.Parser.html" title="trait clap::Parser"><code>Parser</code></a>, <a href="trait.Args.html" title="trait clap::Args"><code>Args</code></a>, and <a href="trait.Subcommand.html" title="trait clap::Subcommand"><code>Subcommand</code></a>.</p>
|
|
</div></details><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.from_arg_matches" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#156">source</a><h4 class="code-header">fn <a href="#tymethod.from_arg_matches" class="fn">from_arg_matches</a>(matches: &<a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Instantiate <code>Self</code> from <a href="struct.ArgMatches.html" title="struct clap::ArgMatches"><code>ArgMatches</code></a>, parsing the arguments as needed.</p>
|
|
<p>Motivation: If our application had two CLI options, <code>--name <STRING></code> and the flag <code>--debug</code>, we may create a struct as follows:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">struct </span>Context {
|
|
name: String,
|
|
debug: bool
|
|
}</code></pre></div>
|
|
<p>We then need to convert the <code>ArgMatches</code> that <code>clap</code> generated into our struct.
|
|
<code>from_arg_matches</code> serves as the equivalent of:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>From<ArgMatches> <span class="kw">for </span>Context {
|
|
<span class="kw">fn </span>from(m: ArgMatches) -> <span class="self">Self </span>{
|
|
Context {
|
|
name: m.get_one::<String>(<span class="string">"name"</span>).unwrap().clone(),
|
|
debug: m.get_flag(<span class="string">"debug"</span>),
|
|
}
|
|
}
|
|
}</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.update_from_arg_matches" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#197">source</a><h4 class="code-header">fn <a href="#tymethod.update_from_arg_matches" class="fn">update_from_arg_matches</a>(&mut self, matches: &<a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Assign values from <code>ArgMatches</code> to <code>self</code>.</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.from_arg_matches_mut" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#192">source</a><h4 class="code-header">fn <a href="#method.from_arg_matches_mut" class="fn">from_arg_matches_mut</a>(matches: &mut <a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Instantiate <code>Self</code> from <a href="struct.ArgMatches.html" title="struct clap::ArgMatches"><code>ArgMatches</code></a>, parsing the arguments as needed.</p>
|
|
<p>Motivation: If our application had two CLI options, <code>--name <STRING></code> and the flag <code>--debug</code>, we may create a struct as follows:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">struct </span>Context {
|
|
name: String,
|
|
debug: bool
|
|
}</code></pre></div>
|
|
<p>We then need to convert the <code>ArgMatches</code> that <code>clap</code> generated into our struct.
|
|
<code>from_arg_matches_mut</code> serves as the equivalent of:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>From<ArgMatches> <span class="kw">for </span>Context {
|
|
<span class="kw">fn </span>from(m: ArgMatches) -> <span class="self">Self </span>{
|
|
Context {
|
|
name: m.get_one::<String>(<span class="string">"name"</span>).unwrap().to_string(),
|
|
debug: m.get_flag(<span class="string">"debug"</span>),
|
|
}
|
|
}
|
|
}</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.update_from_arg_matches_mut" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#200">source</a><h4 class="code-header">fn <a href="#method.update_from_arg_matches_mut" class="fn">update_from_arg_matches_mut</a>(
|
|
&mut self,
|
|
matches: &mut <a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>></h4></section></summary><div class="docblock"><p>Assign values from <code>ArgMatches</code> to <code>self</code>.</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.80.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-FromArgMatches-for-Box%3CT%3E" class="impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#322">source</a><a href="#impl-FromArgMatches-for-Box%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.FromArgMatches.html" title="trait clap::FromArgMatches">FromArgMatches</a> for <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T><div class="where">where
|
|
T: <a class="trait" href="trait.FromArgMatches.html" title="trait clap::FromArgMatches">FromArgMatches</a>,</div></h3></section></summary><div class="impl-items"><section id="method.from_arg_matches" class="method trait-impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#323">source</a><a href="#method.from_arg_matches" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.from_arg_matches" class="fn">from_arg_matches</a>(matches: &<a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T>, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>></h4></section><section id="method.from_arg_matches_mut-1" class="method trait-impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#326">source</a><a href="#method.from_arg_matches_mut-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.from_arg_matches_mut" class="fn">from_arg_matches_mut</a>(matches: &mut <a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T>, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>></h4></section><section id="method.update_from_arg_matches" class="method trait-impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#329">source</a><a href="#method.update_from_arg_matches" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.update_from_arg_matches" class="fn">update_from_arg_matches</a>(&mut self, matches: &<a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>></h4></section><section id="method.update_from_arg_matches_mut-1" class="method trait-impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#332">source</a><a href="#method.update_from_arg_matches_mut-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.update_from_arg_matches_mut" class="fn">update_from_arg_matches_mut</a>(
|
|
&mut self,
|
|
matches: &mut <a class="struct" href="struct.ArgMatches.html" title="struct clap::ArgMatches">ArgMatches</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</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/derive/trait.FromArgMatches.js" data-ignore-extern-crates="alloc" async></script></section></div></main></body></html> |