Struct pretty_exec::clap::builder::BoolishValueParser

[−]

#[non_exhaustive]
pub struct BoolishValueParser {}

Expand description

Parse bool-like string values, everything else is true

Example

Usage:

let mut cmd = clap::Command::new("raw")
    .arg(
        clap::Arg::new("append")
            .value_parser(clap::builder::BoolishValueParser::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::BoolishValueParser::new();
assert!(value_parser.parse_ref(&cmd, arg, OsStr::new("random")).is_err());
assert!(value_parser.parse_ref(&cmd, arg, OsStr::new("")).is_err());
assert!(value_parser.parse_ref(&cmd, arg, OsStr::new("100")).is_err());
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("true")).unwrap(), true);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("Yes")).unwrap(), true);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("oN")).unwrap(), true);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("1")).unwrap(), true);
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

impl BoolishValueParser

pub fn new() -> BoolishValueParser

Parse bool-like string values, everything else is true

Trait Implementations

impl Clone for BoolishValueParser

fn clone(&self) -> BoolishValueParser

Returns a copy of the value. Read more

1.0.0 · source

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for BoolishValueParser

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

impl Default for BoolishValueParser

fn default() -> BoolishValueParser

Returns the “default value” for a type. Read more

impl TypedValueParser for BoolishValueParser

type Value = bool

Argument’s value type

fn parse_ref(
 &self,
 cmd: &Command,
 arg: Option<&Arg>,
 value: &OsStr
) -> Result<<BoolishValueParser as TypedValueParser>::Value, Error<RichFormatter>>

Parse the argument value Read more

fn possible_values(
&self
) -> Option<Box<dyn Iterator<Item = PossibleValue>, Global>>

Reflect on enumerated value properties Read more

fn parse(
 &self,
 cmd: &Command,
 arg: Option<&Arg>,
 value: OsString
) -> Result<Self::Value, Error<RichFormatter>>

Parse the argument value Read more

fn map<T, F>(self, func: F) -> MapValueParser<Self, F>where
T: Send + Sync + Clone,
F: Fn(Self::Value) -> T + Clone,

Adapt a TypedValueParser from one value to another Read more

fn try_map<T, E, F>(self, func: F) -> TryMapValueParser<Self, F>where
 F: 'static + Fn(Self::Value) -> Result<T, E> + Clone + Send + Sync,
 T: Send + Sync + Clone,
 E: Into<Box<dyn Error + Send + Sync + 'static, Global>>,

Adapt a TypedValueParser from one value to another Read more

impl Copy for BoolishValueParser

Auto Trait Implementations

impl RefUnwindSafe for BoolishValueParser

impl Send for BoolishValueParser

impl Sync for BoolishValueParser

impl Unpin for BoolishValueParser

impl UnwindSafe for BoolishValueParser

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl IntoResettable<ValueParser> for Iwhere
I: Into<ValueParser>,

fn into_resettable(self) -> Resettable<ValueParser>

Convert to the intended resettable type

impl<X> Pipe for X

fn pipe<Return, Function>(self, f: Function) -> Returnwhere
Function: FnOnce(Self) -> Return,

Apply f to self. Read more

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Returnwhere
Function: FnOnce(&'a Self) -> Return,

Apply f to &self. Read more

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Returnwhere
Function: FnOnce(&'a mut Self) -> Return,

Apply f to &mut self. Read more

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
 Self: AsRef<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait AsRef<Param>. Read more

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Returnwhere
 Self: AsMut<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait AsMut<Param>. Read more

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
 Self: Deref<Target = Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait Deref<Target = Param>. Read more

fn pipe_deref_mut<'a, Param, Return, Function>(
 &'a mut self,
 f: Function
) -> Returnwhere
 Self: DerefMut<Target = Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait [DerefMut<Target = Param>]. Read more

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
 Self: Borrow<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait Borrow<Param>. Read more

fn pipe_borrow_mut<'a, Param, Return, Function>(
 &'a mut self,
 f: Function
) -> Returnwhere
 Self: BorrowMut<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait BorrowMut<Param>. Read more

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct pretty_exec::clap::builder::BoolishValueParser

Example

Implementations

impl BoolishValueParser

pub fn new() -> BoolishValueParser

Trait Implementations

impl Clone for BoolishValueParser

fn clone(&self) -> BoolishValueParser

const fn clone_from(&mut self, source: &Self)

impl Debug for BoolishValueParser

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

impl Default for BoolishValueParser

fn default() -> BoolishValueParser

impl TypedValueParser for BoolishValueParser

type Value = bool

fn parse_ref( &self, cmd: &Command, arg: Option<&Arg>, value: &OsStr) -> Result<<BoolishValueParser as TypedValueParser>::Value, Error<RichFormatter>>

fn possible_values( &self) -> Option<Box<dyn Iterator<Item = PossibleValue>, Global>>

fn parse( &self, cmd: &Command, arg: Option<&Arg>, value: OsString) -> Result<Self::Value, Error<RichFormatter>>

fn map<T, F>(self, func: F) -> MapValueParser<Self, F>where T: Send + Sync + Clone, F: Fn(Self::Value) -> T + Clone,

fn try_map<T, E, F>(self, func: F) -> TryMapValueParser<Self, F>where F: 'static + Fn(Self::Value) -> Result<T, E> + Clone + Send + Sync, T: Send + Sync + Clone, E: Into<Box<dyn Error + Send + Sync + 'static, Global>>,

impl Copy for BoolishValueParser

Auto Trait Implementations

impl RefUnwindSafe for BoolishValueParser

impl Send for BoolishValueParser

impl Sync for BoolishValueParser

impl Unpin for BoolishValueParser

impl UnwindSafe for BoolishValueParser

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<I> IntoResettable<ValueParser> for Iwhere I: Into<ValueParser>,

fn into_resettable(self) -> Resettable<ValueParser>

impl<X> Pipe for X

fn pipe<Return, Function>(self, f: Function) -> Returnwhere Function: FnOnce(Self) -> Return,

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Returnwhere Function: FnOnce(&'a Self) -> Return,

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Returnwhere Function: FnOnce(&'a mut Self) -> Return,

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere Self: AsRef<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a Param) -> Return,

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Returnwhere Self: AsMut<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a mut Param) -> Return,

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere Self: Deref<Target = Param>, Param: 'a + ?Sized, Function: FnOnce(&'a Param) -> Return,

fn pipe_deref_mut<'a, Param, Return, Function>( &'a mut self, f: Function) -> Returnwhere Self: DerefMut<Target = Param>, Param: 'a + ?Sized, Function: FnOnce(&'a mut Param) -> Return,

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere Self: Borrow<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a Param) -> Return,

fn pipe_borrow_mut<'a, Param, Return, Function>( &'a mut self, f: Function) -> Returnwhere Self: BorrowMut<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a mut Param) -> Return,

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

fn parse_ref(
&self,
cmd: &Command,
arg: Option<&Arg>,
value: &OsStr
) -> Result<<BoolishValueParser as TypedValueParser>::Value, Error<RichFormatter>>

fn possible_values(
&self
) -> Option<Box<dyn Iterator<Item = PossibleValue>, Global>>

fn parse(
&self,
cmd: &Command,
arg: Option<&Arg>,
value: OsString
) -> Result<Self::Value, Error<RichFormatter>>

fn map<T, F>(self, func: F) -> MapValueParser<Self, F>where
T: Send + Sync + Clone,
F: Fn(Self::Value) -> T + Clone,

fn try_map<T, E, F>(self, func: F) -> TryMapValueParser<Self, F>where
F: 'static + Fn(Self::Value) -> Result<T, E> + Clone + Send + Sync,
T: Send + Sync + Clone,
E: Into<Box<dyn Error + Send + Sync + 'static, Global>>,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<I> IntoResettable<ValueParser> for Iwhere
I: Into<ValueParser>,

fn pipe<Return, Function>(self, f: Function) -> Returnwhere
Function: FnOnce(Self) -> Return,

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Returnwhere
Function: FnOnce(&'a Self) -> Return,

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Returnwhere
Function: FnOnce(&'a mut Self) -> Return,

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
Self: AsRef<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a Param) -> Return,

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Returnwhere
Self: AsMut<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
Self: Deref<Target = Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a Param) -> Return,

fn pipe_deref_mut<'a, Param, Return, Function>(
&'a mut self,
f: Function
) -> Returnwhere
Self: DerefMut<Target = Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Returnwhere
Self: Borrow<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a Param) -> Return,

fn pipe_borrow_mut<'a, Param, Return, Function>(
&'a mut self,
f: Function
) -> Returnwhere
Self: BorrowMut<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,