clap::builder

Struct ValueRange

pub struct ValueRange { /* private fields */ }
Expand description

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. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for ValueRange

§

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

Formats the value using the given formatter. Read more
§

impl Default for ValueRange

§

fn default() -> ValueRange

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

impl Display for ValueRange

§

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

Formats the value using the given formatter. Read more
§

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. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl PartialEq for ValueRange

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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. Read more
§

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

End index bound. Read more
1.35.0 · Source§

fn contains<U>(&self, item: &U) -> bool
where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range. Read more
§

impl Copy for ValueRange

§

impl Eq for ValueRange

§

impl StructuralPartialEq for ValueRange

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.

§

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

§

fn into_resettable(self) -> Resettable<ValueRange>

Convert to the intended resettable type
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

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

Source§

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.