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 arguments into enums." > < title > ValueEnum 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.13< / span > < / h2 > < / div > < h2 class = "location" > < a href = "#" > ValueEnum< / a > < / h2 > < div class = "sidebar-elems" > < section > < h3 > < a href = "#required-methods" > Required Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#tymethod.to_possible_value" > to_possible_value< / a > < / li > < li > < a href = "#tymethod.value_variants" > value_variants< / a > < / li > < / ul > < h3 > < a href = "#provided-methods" > Provided Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#method.from_str" > from_str< / 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 = "#" > ValueEnum< / 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#264" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub trait ValueEnum: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / 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 > {
2024-02-13 06:38:44 +00:00
// Required methods
2024-07-26 09:42:18 +00:00
fn < a href = "#tymethod.value_variants" class = "fn" > value_variants< / a > < 'a> () -> & 'a < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.slice.html" > [Self]< / a > ;
< span class = "item-spacer" > < / span > fn < a href = "#tymethod.to_possible_value" class = "fn" > to_possible_value< / a > (& self) -> < a class = "enum" href = "https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < < a class = "struct" href = "builder/struct.PossibleValue.html" title = "struct clap::builder::PossibleValue" > PossibleValue< / a > > ;
2024-02-13 06:38:44 +00:00
// Provided method
2024-07-26 09:42:18 +00:00
fn < a href = "#method.from_str" class = "fn" > from_str< / a > (input: & < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.str.html" > str< / a > , ignore_case: < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.bool.html" > bool< / 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 = "https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title = "struct alloc::string::String" > String< / a > > { ... }
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 arguments into enums.< / p >
< p > When deriving < a href = "trait.Parser.html" title = "trait clap::Parser" > < code > Parser< / code > < / a > , a field whose type implements < code > ValueEnum< / code > can have the attribute
< code > #[arg(value_enum)]< / code > which will< / p >
< ul >
< li > Call < a href = "builder/struct.EnumValueParser.html" title = "struct clap::builder::EnumValueParser" > < code > EnumValueParser< / code > < / a > < / li >
< li > Allowing using the < code > #[arg(default_value_t)]< / code > attribute without implementing < code > Display< / code > .< / li >
< / ul >
< p > < strong > NOTE:< / strong > Deriving requires the < code > derive< / code > feature flag< / p >
2024-07-26 09:42:18 +00:00
< / 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.value_variants" class = "method" > < a class = "src rightside" href = "../src/clap_builder/derive.rs.html#266" > source< / a > < h4 class = "code-header" > fn < a href = "#tymethod.value_variants" class = "fn" > value_variants< / a > < 'a> () -> & 'a < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.slice.html" > [Self]< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > All possible argument values, in display order.< / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "tymethod.to_possible_value" class = "method" > < a class = "src rightside" href = "../src/clap_builder/derive.rs.html#284" > source< / a > < h4 class = "code-header" > fn < a href = "#tymethod.to_possible_value" class = "fn" > to_possible_value< / a > (& self) -> < a class = "enum" href = "https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < < a class = "struct" href = "builder/struct.PossibleValue.html" title = "struct clap::builder::PossibleValue" > PossibleValue< / a > > < / h4 > < / section > < / summary > < div class = "docblock" > < p > The canonical argument value.< / p >
2024-02-13 06:38:44 +00:00
< p > The value is < code > None< / code > for skipped variants.< / p >
2024-07-26 09:42:18 +00:00
< / 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_str" class = "method" > < a class = "src rightside" href = "../src/clap_builder/derive.rs.html#269" > source< / a > < h4 class = "code-header" > fn < a href = "#method.from_str" class = "fn" > from_str< / a > (input: & < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.str.html" > str< / a > , ignore_case: < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.bool.html" > bool< / 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 = "https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title = "struct alloc::string::String" > String< / a > > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Parse an argument into < 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 = "implementors" class = "section-header" > Implementors< a href = "#implementors" class = "anchor" > §< / a > < / h2 > < div id = "implementors-list" > < section id = "impl-ValueEnum-for-ColorChoice" class = "impl" > < a class = "src rightside" href = "../src/clap_builder/util/color.rs.html#92" > source< / a > < a href = "#impl-ValueEnum-for-ColorChoice" class = "anchor" > §< / a > < h3 class = "code-header" > impl < a class = "trait" href = "trait.ValueEnum.html" title = "trait clap::ValueEnum" > ValueEnum< / a > for < a class = "enum" href = "enum.ColorChoice.html" title = "enum clap::ColorChoice" > ColorChoice< / a > < / h3 > < / section > < / div > < script src = "../trait.impl/clap_builder/derive/trait.ValueEnum.js" data-ignore-extern-crates = "clap_builder" async > < / script > < / section > < / div > < / main > < / body > < / html >
