Struct clap::builder::EnumValueParser
source · [−]Expand description
Parse an ValueEnum
value.
See also:
Example
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
enum ColorChoice {
Always,
Auto,
Never,
}
impl clap::ValueEnum for ColorChoice {
fn value_variants<'a>() -> &'a [Self] {
&[Self::Always, Self::Auto, Self::Never]
}
fn to_possible_value<'a>(&self) -> Option<clap::PossibleValue<'a>> {
match self {
Self::Always => Some(clap::PossibleValue::new("always")),
Self::Auto => Some(clap::PossibleValue::new("auto")),
Self::Never => Some(clap::PossibleValue::new("never")),
}
}
}
// Usage
let mut cmd = clap::Command::new("raw")
.arg(
clap::Arg::new("color")
.value_parser(clap::builder::EnumValueParser::<ColorChoice>::new())
.required(true)
);
let m = cmd.try_get_matches_from_mut(["cmd", "always"]).unwrap();
let port: ColorChoice = *m.get_one("color")
.expect("required");
assert_eq!(port, ColorChoice::Always);
// Semantics
let value_parser = clap::builder::EnumValueParser::<ColorChoice>::new();
// or
let value_parser = clap::value_parser!(ColorChoice);
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(), ColorChoice::Always);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("auto")).unwrap(), ColorChoice::Auto);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("never")).unwrap(), ColorChoice::Never);
Implementations
Trait Implementations
sourceimpl<E: Clone + ValueEnum + Clone + Send + Sync + 'static> Clone for EnumValueParser<E>
impl<E: Clone + ValueEnum + Clone + Send + Sync + 'static> Clone for EnumValueParser<E>
sourcefn clone(&self) -> EnumValueParser<E>
fn clone(&self) -> EnumValueParser<E>
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<E: ValueEnum + Clone + Send + Sync + 'static> TypedValueParser for EnumValueParser<E>
impl<E: ValueEnum + Clone + Send + Sync + 'static> TypedValueParser for EnumValueParser<E>
type Value = E
type Value = E
Argument’s value type
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 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<E> RefUnwindSafe for EnumValueParser<E> where
E: RefUnwindSafe,
impl<E> Send for EnumValueParser<E>
impl<E> Sync for EnumValueParser<E>
impl<E> Unpin for EnumValueParser<E> where
E: Unpin,
impl<E> UnwindSafe for EnumValueParser<E> where
E: UnwindSafe,
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