Struct clap::builder::RangedI64ValueParser

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

Parse number that fall within a range of 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..))
            .takes_value(true)
            .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: TryFrom<i64> + Clone + Send + Sync> RangedI64ValueParser<T>

pub fn new() -> Self

Select full range of i64

pub fn range<B: RangeBounds<i64>>(self, range: B) -> Self

Narrow the supported range

Examples found in repository

examples/tutorial_builder/04_02_parse.rs (line 8)

↕

fn main() {
    let matches = command!() // requires `cargo` feature
        .arg(
            arg!(<PORT>)
                .help("Network port to use")
                .value_parser(value_parser!(u16).range(1..)),
        )
        .get_matches();

    // Note, it's safe to call unwrap() because the arg is required
    let port: u16 = *matches
        .get_one::<u16>("PORT")
        .expect("'PORT' is required and parsing will fail if its missing");
    println!("PORT = {}", port);
}

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn from(range: B) -> Self

Converts to this type from the input type.

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

type Value = T

Argument’s value type

fn parse_ref(
    &self,
    cmd: &Command<'_>,
    arg: Option<&Arg<'_>>,
    raw_value: &OsStr
) -> Result<Self::Value, Error>

Parse the argument value

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

Parse the argument value

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

Reflect on enumerated value properties

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

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