#[non_exhaustive]pub struct FalseyValueParser {}
Expand description
Parse false-like string values, everything else is true
See also:
ValueParser::bool
for assuming non-false is trueBoolishValueParser
for different human readable bool representations
§Example
Usage:
let mut cmd = clap::Command::new("raw")
.arg(
clap::Arg::new("append")
.value_parser(clap::builder::FalseyValueParser::new())
.required(true)
);
let m = cmd.try_get_matches_from_mut(["cmd", "true"]).unwrap();
let port: bool = *m.get_one("append")
.expect("required");
assert_eq!(port, true);
Semantics:
let value_parser = clap::builder::FalseyValueParser::new();
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("random")).unwrap(), true);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("100")).unwrap(), true);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("")).unwrap(), false);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("false")).unwrap(), false);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("No")).unwrap(), false);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("oFF")).unwrap(), false);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("0")).unwrap(), false);
Implementations§
source§impl FalseyValueParser
impl FalseyValueParser
sourcepub fn new() -> FalseyValueParser
pub fn new() -> FalseyValueParser
Parse false-like string values, everything else is true
Trait Implementations§
source§impl Clone for FalseyValueParser
impl Clone for FalseyValueParser
source§fn clone(&self) -> FalseyValueParser
fn clone(&self) -> FalseyValueParser
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for FalseyValueParser
impl Debug for FalseyValueParser
source§impl Default for FalseyValueParser
impl Default for FalseyValueParser
source§fn default() -> FalseyValueParser
fn default() -> FalseyValueParser
Returns the “default value” for a type. Read more
source§impl TypedValueParser for FalseyValueParser
impl TypedValueParser for FalseyValueParser
source§fn parse_ref(
&self,
cmd: &Command,
_arg: Option<&Arg>,
value: &OsStr,
) -> Result<<FalseyValueParser as TypedValueParser>::Value, Error>
fn parse_ref( &self, cmd: &Command, _arg: Option<&Arg>, value: &OsStr, ) -> Result<<FalseyValueParser as TypedValueParser>::Value, Error>
Parse the argument value Read more
source§fn possible_values(
&self,
) -> Option<Box<dyn Iterator<Item = PossibleValue> + '_>>
fn possible_values( &self, ) -> Option<Box<dyn Iterator<Item = PossibleValue> + '_>>
Reflect on enumerated value properties Read more
source§fn parse_ref_(
&self,
cmd: &Command,
arg: Option<&Arg>,
value: &OsStr,
_source: ValueSource,
) -> Result<Self::Value, Error>
fn parse_ref_( &self, cmd: &Command, arg: Option<&Arg>, value: &OsStr, _source: ValueSource, ) -> Result<Self::Value, Error>
Parse the argument value Read more
source§fn parse(
&self,
cmd: &Command,
arg: Option<&Arg>,
value: OsString,
) -> Result<Self::Value, Error>
fn parse( &self, cmd: &Command, arg: Option<&Arg>, value: OsString, ) -> Result<Self::Value, Error>
Parse the argument value Read more
source§fn parse_(
&self,
cmd: &Command,
arg: Option<&Arg>,
value: OsString,
_source: ValueSource,
) -> Result<Self::Value, Error>
fn parse_( &self, cmd: &Command, arg: Option<&Arg>, value: OsString, _source: ValueSource, ) -> Result<Self::Value, Error>
Parse the argument value Read more
source§fn map<T, F>(self, func: F) -> MapValueParser<Self, F>
fn map<T, F>(self, func: F) -> MapValueParser<Self, F>
Adapt a
TypedValueParser
from one value to another Read moreimpl Copy for FalseyValueParser
Auto Trait Implementations§
impl Freeze for FalseyValueParser
impl RefUnwindSafe for FalseyValueParser
impl Send for FalseyValueParser
impl Sync for FalseyValueParser
impl Unpin for FalseyValueParser
impl UnwindSafe for FalseyValueParser
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<I> IntoResettable<ValueParser> for Iwhere
I: Into<ValueParser>,
impl<I> IntoResettable<ValueParser> for Iwhere
I: Into<ValueParser>,
source§fn into_resettable(self) -> Resettable<ValueParser>
fn into_resettable(self) -> Resettable<ValueParser>
Convert to the intended resettable type