Struct clap::builder::ValueRange

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

Values per occurrence for an argument

Implementations§

source§

impl ValueRange

source

pub const EMPTY: ValueRange = _

Nor argument values, or a flag

source

pub const SINGLE: ValueRange = _

A single argument value, the most common case for options

source

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

pub fn min_values(&self) -> usize

Fewest number of values the argument accepts

source

pub fn max_values(&self) -> usize

Most number of values the argument accepts

source

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§

source§

impl Clone for ValueRange

source§

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

impl Debug for ValueRange

source§

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

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

impl Default for ValueRange

source§

fn default() -> ValueRange

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

impl Display for ValueRange

source§

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

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

impl From<Range<usize>> for ValueRange

source§

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

Converts to this type from the input type.
source§

impl From<RangeFrom<usize>> for ValueRange

source§

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

Converts to this type from the input type.
source§

impl From<RangeFull> for ValueRange

source§

fn from(_: RangeFull) -> ValueRange

Converts to this type from the input type.
source§

impl From<RangeInclusive<usize>> for ValueRange

source§

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

Converts to this type from the input type.
source§

impl From<RangeTo<usize>> for ValueRange

source§

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

Converts to this type from the input type.
source§

impl From<RangeToInclusive<usize>> for ValueRange

source§

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

Converts to this type from the input type.
source§

impl From<usize> for ValueRange

source§

fn from(fixed: usize) -> ValueRange

Converts to this type from the input type.
source§

impl Hash for ValueRange

source§

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

impl PartialEq for ValueRange

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl RangeBounds<usize> for ValueRange

source§

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

Start index bound. Read more
source§

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

impl Copy for ValueRange

source§

impl Eq for ValueRange

source§

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> 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<ValueRange> for I
where I: Into<ValueRange>,

source§

fn into_resettable(self) -> Resettable<ValueRange>

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

§

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.