Struct clap::builder::PossibleValuesParser
source · [−]pub struct PossibleValuesParser(_);
Expand description
Verify the value is from an enumerated set of PossibleValue
.
See also:
Example
Usage:
let mut cmd = clap::Command::new("raw")
.arg(
clap::Arg::new("color")
.value_parser(clap::builder::PossibleValuesParser::new(["always", "auto", "never"]))
.required(true)
);
let m = cmd.try_get_matches_from_mut(["cmd", "always"]).unwrap();
let port: &String = m.get_one("color")
.expect("required");
assert_eq!(port, "always");
Semantics:
let value_parser = clap::builder::PossibleValuesParser::new(["always", "auto", "never"]);
assert!(value_parser.parse_ref(&cmd, arg, OsStr::new("random")).is_err());
assert!(value_parser.parse_ref(&cmd, arg, OsStr::new("")).is_err());
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("always")).unwrap(), "always");
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("auto")).unwrap(), "auto");
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("never")).unwrap(), "never");
Implementations
sourceimpl PossibleValuesParser
impl PossibleValuesParser
sourcepub fn new(values: impl Into<PossibleValuesParser>) -> Self
pub fn new(values: impl Into<PossibleValuesParser>) -> Self
Verify the value is from an enumerated set pf PossibleValue
.
Trait Implementations
sourceimpl Clone for PossibleValuesParser
impl Clone for PossibleValuesParser
sourcefn clone(&self) -> PossibleValuesParser
fn clone(&self) -> PossibleValuesParser
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PossibleValuesParser
impl Debug for PossibleValuesParser
sourceimpl<I, T> From<I> for PossibleValuesParser where
I: IntoIterator<Item = T>,
T: Into<PossibleValue<'static>>,
impl<I, T> From<I> for PossibleValuesParser where
I: IntoIterator<Item = T>,
T: Into<PossibleValue<'static>>,
sourceimpl TypedValueParser for PossibleValuesParser
impl TypedValueParser for PossibleValuesParser
sourcefn parse_ref(
&self,
cmd: &Command<'_>,
arg: Option<&Arg<'_>>,
value: &OsStr
) -> Result<Self::Value, Error>
fn parse_ref(
&self,
cmd: &Command<'_>,
arg: Option<&Arg<'_>>,
value: &OsStr
) -> Result<Self::Value, Error>
Parse the argument value Read more
sourcefn parse(
&self,
cmd: &Command<'_>,
arg: Option<&Arg<'_>>,
value: OsString
) -> Result<String, Error>
fn parse(
&self,
cmd: &Command<'_>,
arg: Option<&Arg<'_>>,
value: OsString
) -> Result<String, Error>
Parse the argument value Read more
sourcefn possible_values(
&self
) -> Option<Box<dyn Iterator<Item = PossibleValue<'static>>>>
fn possible_values(
&self
) -> Option<Box<dyn Iterator<Item = PossibleValue<'static>>>>
Reflect on enumerated value properties Read more
Auto Trait Implementations
impl RefUnwindSafe for PossibleValuesParser
impl Send for PossibleValuesParser
impl Sync for PossibleValuesParser
impl Unpin for PossibleValuesParser
impl UnwindSafe for PossibleValuesParser
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more