Struct pretty_exec::clap::builder::RangedI64ValueParser

[−]

pub struct RangedI64ValueParser<T = i64>where
    T: TryFrom<i64> + Clone + Send + Sync,{ /* private fields */ }

Expand description

Parse number that fall within a range of values

NOTE: To capture negative values, you will also need to set Arg::allow_negative_numbers or Arg::allow_hyphen_values.

Example

Usage:

let mut cmd = clap::Command::new("raw")
    .arg(
        clap::Arg::new("port")
            .long("port")
            .value_parser(clap::value_parser!(u16).range(3000..))
            .action(clap::ArgAction::Set)
            .required(true)
    );

let m = cmd.try_get_matches_from_mut(["cmd", "--port", "3001"]).unwrap();
let port: u16 = *m.get_one("port")
    .expect("required");
assert_eq!(port, 3001);

Semantics:

let value_parser = clap::builder::RangedI64ValueParser::<i32>::new().range(-1..200);
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("-200")).is_err());
assert!(value_parser.parse_ref(&cmd, arg, OsStr::new("300")).is_err());
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("-1")).unwrap(), -1);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("0")).unwrap(), 0);
assert_eq!(value_parser.parse_ref(&cmd, arg, OsStr::new("50")).unwrap(), 50);

Implementations

impl<T> RangedI64ValueParser<T>where
T: TryFrom<i64> + Clone + Send + Sync,

pub fn new() -> RangedI64ValueParser<T>

Select full range of i64

pub fn range(self, range: B) -> RangedI64ValueParser<T>where
B: RangeBounds<i64>,

Narrow the supported range

Trait Implementations

impl<T> Clone for RangedI64ValueParser<T>where
T: Clone + TryFrom<i64> + Send + Sync,

fn clone(&self) -> RangedI64ValueParser<T>

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<T> Debug for RangedI64ValueParser<T>where
T: Debug + TryFrom<i64> + Clone + Send + Sync,

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

Formats the value using the given formatter. Read more

impl<T> Default for RangedI64ValueParser<T>where
T: TryFrom<i64> + Clone + Send + Sync,

fn default() -> RangedI64ValueParser<T>

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

impl<T, B> From for RangedI64ValueParser<T>where
T: TryFrom<i64> + Clone + Send + Sync,
B: RangeBounds<i64>,

fn from(range: B) -> RangedI64ValueParser<T>

Converts to this type from the input type.

impl<T> TypedValueParser for RangedI64ValueParser<T>where
T: 'static + TryFrom<i64> + Clone + Send + Sync,
<T as TryFrom<i64>>::Error: 'static + Send + Sync + Error + ToString,

type Value = T

Argument’s value type

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

Parse the argument value Read more

fn parse(
 &self,
 cmd: &Command,
 arg: Option<&Arg>,
 value: OsString
) -> Result<Self::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 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<T> Copy for RangedI64ValueParser<T>where
T: Copy + TryFrom<i64> + Clone + Send + Sync,

Auto Trait Implementations

impl<T> RefUnwindSafe for RangedI64ValueParser<T>where
T: RefUnwindSafe,

impl<T> Send for RangedI64ValueParser<T>

impl<T> Sync for RangedI64ValueParser<T>

impl<T> Unpin for RangedI64ValueParser<T>where
T: Unpin,

impl<T> UnwindSafe for RangedI64ValueParser<T>where
T: UnwindSafe,

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::RangedI64ValueParser

Example

Implementations

impl<T> RangedI64ValueParser<T>where T: TryFrom<i64> + Clone + Send + Sync,

pub fn new() -> RangedI64ValueParser<T>

pub fn range<B>(self, range: B) -> RangedI64ValueParser<T>where B: RangeBounds<i64>,

Trait Implementations

impl<T> Clone for RangedI64ValueParser<T>where T: Clone + TryFrom<i64> + Send + Sync,

fn clone(&self) -> RangedI64ValueParser<T>

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

impl<T> Debug for RangedI64ValueParser<T>where T: Debug + TryFrom<i64> + Clone + Send + Sync,

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

impl<T> Default for RangedI64ValueParser<T>where T: TryFrom<i64> + Clone + Send + Sync,

fn default() -> RangedI64ValueParser<T>

impl<T, B> From<B> for RangedI64ValueParser<T>where T: TryFrom<i64> + Clone + Send + Sync, B: RangeBounds<i64>,

fn from(range: B) -> RangedI64ValueParser<T>

impl<T> TypedValueParser for RangedI64ValueParser<T>where T: 'static + TryFrom<i64> + Clone + Send + Sync, <T as TryFrom<i64>>::Error: 'static + Send + Sync + Error + ToString,

type Value = T

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

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

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

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> Copy for RangedI64ValueParser<T>where T: Copy + TryFrom<i64> + Clone + Send + Sync,

Auto Trait Implementations

impl<T> RefUnwindSafe for RangedI64ValueParser<T>where T: RefUnwindSafe,

impl<T> Send for RangedI64ValueParser<T>

impl<T> Sync for RangedI64ValueParser<T>

impl<T> Unpin for RangedI64ValueParser<T>where T: Unpin,

impl<T> UnwindSafe for RangedI64ValueParser<T>where T: UnwindSafe,

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>

impl<T> RangedI64ValueParser<T>where
T: TryFrom<i64> + Clone + Send + Sync,

pub fn range<B>(self, range: B) -> RangedI64ValueParser<T>where
B: RangeBounds<i64>,

impl<T> Clone for RangedI64ValueParser<T>where
T: Clone + TryFrom<i64> + Send + Sync,

impl<T> Debug for RangedI64ValueParser<T>where
T: Debug + TryFrom<i64> + Clone + Send + Sync,

impl<T> Default for RangedI64ValueParser<T>where
T: TryFrom<i64> + Clone + Send + Sync,

impl<T, B> From<B> for RangedI64ValueParser<T>where
T: TryFrom<i64> + Clone + Send + Sync,
B: RangeBounds<i64>,

impl<T> TypedValueParser for RangedI64ValueParser<T>where
T: 'static + TryFrom<i64> + Clone + Send + Sync,
<T as TryFrom<i64>>::Error: 'static + Send + Sync + Error + ToString,

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

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

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

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> Copy for RangedI64ValueParser<T>where
T: Copy + TryFrom<i64> + Clone + Send + Sync,

impl<T> RefUnwindSafe for RangedI64ValueParser<T>where
T: RefUnwindSafe,

impl<T> Unpin for RangedI64ValueParser<T>where
T: Unpin,

impl<T> UnwindSafe for RangedI64ValueParser<T>where
T: UnwindSafe,

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>,