mirror of
https://github.com/NotAShelf/mpvrc.git
synced 2026-04-16 16:03:48 +00:00
54 lines
No EOL
21 KiB
HTML
54 lines
No EOL
21 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="Parse command-line arguments into `Self`."><title>Parser in clap - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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.23</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Parser</a></h2><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.parse" title="parse">parse</a></li><li><a href="#method.parse_from" title="parse_from">parse_from</a></li><li><a href="#method.try_parse" title="try_parse">try_parse</a></li><li><a href="#method.try_parse_from" title="try_parse_from">try_parse_from</a></li><li><a href="#method.try_update_from" title="try_update_from">try_update_from</a></li><li><a href="#method.update_from" title="update_from">update_from</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Parser-for-Box%3CT%3E" title="Box<T>">Box<T></a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate clap</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">clap</a></span><h1>Trait <span class="trait">Parser</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/clap_builder/derive.rs.html#28">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Parser:
|
|
<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>
|
|
+ <a class="trait" href="trait.FromArgMatches.html" title="trait clap::FromArgMatches">FromArgMatches</a>
|
|
+ <a class="trait" href="trait.CommandFactory.html" title="trait clap::CommandFactory">CommandFactory</a> {
|
|
// Provided methods
|
|
fn <a href="#method.parse" class="fn">parse</a>() -> Self { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.try_parse" class="fn">try_parse</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/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.parse_from" class="fn">parse_from</a><I, T>(itr: I) -> Self
|
|
<span class="where">where I: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a></span> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.try_parse_from" class="fn">try_parse_from</a><I, T>(itr: I) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/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="where">where I: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a></span> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.update_from" class="fn">update_from</a><I, T>(&mut self, itr: I)
|
|
<span class="where">where I: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a></span> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.try_update_from" class="fn">try_update_from</a><I, T>(&mut self, itr: I) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>>
|
|
<span class="where">where I: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a></span> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse command-line arguments into <code>Self</code>.</p>
|
|
<p>The primary one-stop-shop trait used to create an instance of a <code>clap</code>
|
|
<a href="struct.Command.html" title="struct clap::Command"><code>Command</code></a>, conduct the parsing, and turn the resulting <a href="struct.ArgMatches.html" title="struct clap::ArgMatches"><code>ArgMatches</code></a> back
|
|
into concrete instance of the user struct.</p>
|
|
<p>This trait is primarily a convenience on top of <a href="trait.FromArgMatches.html" title="trait clap::FromArgMatches"><code>FromArgMatches</code></a> +
|
|
<a href="trait.CommandFactory.html" title="trait clap::CommandFactory"><code>CommandFactory</code></a> which uses those two underlying traits to build the two
|
|
fundamental functions <code>parse</code> which uses the <code>std::env::args_os</code> iterator,
|
|
and <code>parse_from</code> which allows the consumer to supply the iterator (along
|
|
with fallible options for each).</p>
|
|
<p>See also <a href="trait.Subcommand.html" title="trait clap::Subcommand"><code>Subcommand</code></a> and <a href="trait.Args.html" title="trait clap::Args"><code>Args</code></a>.</p>
|
|
<div class="warning">
|
|
<p><strong>NOTE:</strong> Deriving requires the <code>derive</code> feature flag</p>
|
|
</div></div></details><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.parse" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#30">Source</a><h4 class="code-header">fn <a href="#method.parse" class="fn">parse</a>() -> Self</h4></section></summary><div class="docblock"><p>Parse from <code>std::env::args_os()</code>, <a href="error/struct.Error.html#method.exit" title="method clap::error::Error::exit">exit</a> on error.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_parse" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#45">Source</a><h4 class="code-header">fn <a href="#method.try_parse" class="fn">try_parse</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/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>Parse from <code>std::env::args_os()</code>, return Err on error.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.parse_from" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#51-54">Source</a><h4 class="code-header">fn <a href="#method.parse_from" class="fn">parse_from</a><I, T>(itr: I) -> Self<div class="where">where
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class="docblock"><p>Parse from iterator, <a href="error/struct.Error.html#method.exit" title="method clap::error::Error::exit">exit</a> on error.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_parse_from" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#70-73">Source</a><h4 class="code-header">fn <a href="#method.try_parse_from" class="fn">try_parse_from</a><I, T>(itr: I) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/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>><div class="where">where
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class="docblock"><p>Parse from iterator, return Err on error.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.update_from" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#84-87">Source</a><h4 class="code-header">fn <a href="#method.update_from" class="fn">update_from</a><I, T>(&mut self, itr: I)<div class="where">where
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class="docblock"><p>Update from iterator, <a href="error/struct.Error.html#method.exit" title="method clap::error::Error::exit">exit</a> on error.</p>
|
|
<p>Unlike <a href="trait.Parser.html#method.parse" title="associated function clap::Parser::parse"><code>Parser::parse</code></a>, this works with an existing instance of <code>self</code>.
|
|
The assumption is that all required fields are already provided and any <a href="trait.Args.html" title="trait clap::Args"><code>Args</code></a> or
|
|
<a href="trait.Subcommand.html" title="trait clap::Subcommand"><code>Subcommand</code></a>s provided by the user will modify only what is specified.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_update_from" class="method"><a class="src rightside" href="../src/clap_builder/derive.rs.html#100-103">Source</a><h4 class="code-header">fn <a href="#method.try_update_from" class="fn">try_update_from</a><I, T>(&mut self, itr: I) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.Error.html" title="struct clap::error::Error">Error</a>><div class="where">where
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class="docblock"><p>Update from iterator, return Err on error.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.1/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></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-Parser-for-Box%3CT%3E" class="impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#315">Source</a><a href="#impl-Parser-for-Box%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.Parser.html" title="trait clap::Parser">Parser</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T><div class="where">where
|
|
T: <a class="trait" href="trait.Parser.html" title="trait clap::Parser">Parser</a>,</div></h3></section></summary><div class="impl-items"><section id="method.parse-1" class="method trait-impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#316">Source</a><a href="#method.parse-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.parse" class="fn">parse</a>() -> <a class="struct" href="https://doc.rust-lang.org/1.84.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T></h4></section><section id="method.try_parse-1" class="method trait-impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#320">Source</a><a href="#method.try_parse-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.try_parse" class="fn">try_parse</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/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.parse_from-1" class="method trait-impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#324-327">Source</a><a href="#method.parse_from-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.parse_from" class="fn">parse_from</a><I, It>(itr: I) -> <a class="struct" href="https://doc.rust-lang.org/1.84.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T><div class="where">where
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = It>,
|
|
It: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section><section id="method.try_parse_from-1" class="method trait-impl"><a class="src rightside" href="../src/clap_builder/derive.rs.html#332-335">Source</a><a href="#method.try_parse_from-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.try_parse_from" class="fn">try_parse_from</a><I, It>(itr: I) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/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>><div class="where">where
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = It>,
|
|
It: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></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.Parser.js" data-ignore-extern-crates="alloc" async></script></section></div></main></body></html> |