Struct clap::builder::ValueRange

pub struct ValueRange { /* private fields */ }

Values per occurrence for an argument

Implementations

impl ValueRange

pub const EMPTY: ValueRange = _

Nor argument values, or a flag

pub const SINGLE: ValueRange = _

A single argument value, the most common case for options

pub fn new(range: impl Into<ValueRange>) -> ValueRange

Create a range

Panics

If the end is less than the start (debug builds)

Examples

let range = ValueRange::new(5);
let range = ValueRange::new(5..10);
let range = ValueRange::new(5..=10);
let range = ValueRange::new(5..);
let range = ValueRange::new(..10);
let range = ValueRange::new(..=10);

While this will panic:

let range = ValueRange::new(10..5);  // Panics!

pub fn min_values(&self) -> usize

Fewest number of values the argument accepts

pub fn max_values(&self) -> usize

Most number of values the argument accepts

pub fn takes_values(&self) -> bool

Report whether the argument takes any values (ie is a flag)

Examples

let range = ValueRange::new(5);
assert!(range.takes_values());

let range = ValueRange::new(0);
assert!(!range.takes_values());

Trait Implementations

impl Clone for ValueRange

fn clone(&self) -> ValueRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValueRange

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

Formats the value using the given formatter.

impl Default for ValueRange

fn default() -> ValueRange

Returns the “default value” for a type.

impl Display for ValueRange

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

Formats the value using the given formatter.

impl From<Range<usize>> for ValueRange

fn from(range: Range<usize>) -> ValueRange

Converts to this type from the input type.

impl From<RangeFrom<usize>> for ValueRange

fn from(range: RangeFrom<usize>) -> ValueRange

Converts to this type from the input type.

impl From<RangeFull> for ValueRange

fn from(_: RangeFull) -> ValueRange

Converts to this type from the input type.

impl From<RangeInclusive<usize>> for ValueRange

fn from(range: RangeInclusive<usize>) -> ValueRange

Converts to this type from the input type.

impl From<RangeTo<usize>> for ValueRange

fn from(range: RangeTo<usize>) -> ValueRange

Converts to this type from the input type.

impl From<RangeToInclusive<usize>> for ValueRange

fn from(range: RangeToInclusive<usize>) -> ValueRange

Converts to this type from the input type.

impl From<usize> for ValueRange

fn from(fixed: usize) -> ValueRange

Converts to this type from the input type.

impl Hash for ValueRange

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ValueRange

fn eq(&self, other: &ValueRange) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RangeBounds<usize> for ValueRange

fn start_bound(&self) -> Bound<&usize>

Start index bound.

fn end_bound(&self) -> Bound<&usize>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

impl Copy for ValueRange

impl Eq for ValueRange

impl StructuralPartialEq for ValueRange