2024-08-01 07:04:26 +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 = "Parse command-line arguments into `Self`." > < title > Parser in clap_builder - 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_builder" 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_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.13< / span > < / h2 > < / div > < h2 class = "location" > < a href = "#" > Parser< / a > < / h2 > < div class = "sidebar-elems" > < section > < h3 > < a href = "#provided-methods" > Provided Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#method.parse" > parse< / a > < / li > < li > < a href = "#method.parse_from" > parse_from< / a > < / li > < li > < a href = "#method.try_parse" > try_parse< / a > < / li > < li > < a href = "#method.try_parse_from" > try_parse_from< / a > < / li > < li > < a href = "#method.try_update_from" > try_update_from< / a > < / li > < li > < a href = "#method.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" > 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_builder< / 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_builder< / a > ::< wbr > < a class = "trait" href = "#" > Parser< / 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#24-102" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub trait Parser: < a class = "trait" href = "trait.FromArgMatches.html" title = "trait clap_builder::FromArgMatches" > FromArgMatches< / a > + < a class = "trait" href = "trait.CommandFactory.html" title = "trait clap_builder::CommandFactory" > CommandFactory< / a > + < a class = "trait" href = "https://
2024-02-13 06:38:44 +00:00
// Provided methods
fn < a href = "#method.parse" class = "fn" > parse< / a > () -> Self { ... }
2024-07-26 09:42:18 +00:00
< 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.80.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < Self, < a class = "type" href = "type.Error.html" title = "type clap_builder::Error" > Error< / a > > { ... }
2024-02-13 06:38:44 +00:00
< span class = "item-spacer" > < / span > fn < a href = "#method.parse_from" class = "fn" > parse_from< / a > < I, T> (itr: I) -> Self
2024-07-26 09:42:18 +00:00
< span class = "where" > where I: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/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.80.0/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.80.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < Self, < a class = "type" href = "type.Error.html" title = "type clap_builder::Error" > Error< / a > >
< span class = "where" > where I: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/clone/trait.Clone.html" title = "trait core::clone::Clone" > Clone< / a > < / span > { ... }
2024-02-13 06:38:44 +00:00
< span class = "item-spacer" > < / span > fn < a href = "#method.update_from" class = "fn" > update_from< / a > < I, T> (& mut self, itr: I)
2024-07-26 09:42:18 +00:00
< span class = "where" > where I: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/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.80.0/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.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 = "type" href = "type.Error.html" title = "type clap_builder::Error" > Error< / a > >
< span class = "where" > where I: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/clone/trait.Clone.html" title = "trait core::clone::Clone" > Clone< / a > < / span > { ... }
2024-02-13 06:38:44 +00:00
}< / 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 = "builder/struct.Command.html" title = "struct clap_builder::builder::Command" > < code > Command< / code > < / a > , conduct the parsing, and turn the resulting < a href = "parser/struct.ArgMatches.html" title = "struct clap_builder::parser::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_builder::FromArgMatches" > < code > FromArgMatches< / code > < / a > +
< a href = "trait.CommandFactory.html" title = "trait clap_builder::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_builder::Subcommand" > < code > Subcommand< / code > < / a > and < a href = "trait.Args.html" title = "trait clap_builder::Args" > < code > Args< / code > < / a > .< / p >
< p > < strong > NOTE:< / strong > Deriving requires the < code > derive< / code > feature flag< / p >
< / 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#26-38" > 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_builder::error::Error::exit" > exit< / a > on error.< / p >
2024-07-26 09:42:18 +00:00
< / 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#41-44" > 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.80.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < Self, < a class = "type" href = "type.Error.html" title = "type clap_builder::Error" > Error< / a > > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Parse from < code > std::env::args_os()< / code > , return Err on error.< / p >
2024-02-13 06:38:44 +00:00
< / 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#47-63" > 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
2024-07-26 09:42:18 +00:00
I: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/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.80.0/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_builder::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#66-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.80.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < Self, < a class = "type" href = "type.Error.html" title = "type clap_builder::Error" > Error< / a > > < div class = "where" > where
I: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/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.80.0/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 >
2024-02-13 06:38:44 +00:00
< / 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#76-89" > 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
2024-07-26 09:42:18 +00:00
I: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/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.80.0/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_builder::error::Error::exit" > exit< / a > on error.< / 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#92-101" > 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.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 = "type" href = "type.Error.html" title = "type clap_builder::Error" > Error< / a > > < div class = "where" > where
I: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/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.80.0/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 = "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-Parser-for-Box%3CT%3E" class = "impl" > < a class = "src rightside" href = "../src/clap_builder/derive.rs.html#287-311" > 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_builder::Parser" > Parser< / a > > < a class = "trait" href = "trait.Parser.html" title = "trait clap_builder::Parser" > Parser< / 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> < / 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#288-290" > source< / a > < a href = "#method.parse-1" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "#method.parse" class = "fn" > parse< / a > () -> Self< / h4 > < / section > < section id = "method.try_parse-1" class = "method trait-impl" > < a class = "src rightside" href = "../src/clap_builder/derive.rs.html#292-294" > 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.80.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < Self, < a class = "type" href = "type.Error.html" title = "type clap_builder::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#296-302" > 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) -> Self< div class = "where" > where
I: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/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.80.0/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#304-310" > 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.80.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < Self, < a class = "type" href = "type.Error.html" title = "type clap_builder::Error" > Error< / a > > < div class = "where" > where
I: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/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.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/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.80.0/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 >
