Struct clap::builder::RangedI64ValueParser

source ·
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§

source§

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

source

pub fn new() -> RangedI64ValueParser<T>

Select full range of i64

source

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

Narrow the supported range

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> RangedI64ValueParser<T>

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

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

source§

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

Converts to this type from the input type.
source§

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

§

type Value = T

Argument’s value type
source§

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

Parse the argument value Read more
source§

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>

Parse the argument value Read more
source§

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

Parse the argument value Read more
source§

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

Reflect on enumerated value properties Read more
source§

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
source§

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

Adapt a TypedValueParser from one value to another Read more
source§

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

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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.

source§

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

source§

fn into_resettable(self) -> Resettable<ValueParser>

Convert to the intended resettable type
source§

impl<T> ToOwned for T
where 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<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.