Struct ValueRange

struct ValueRange { ... }

Values per occurrence for an argument

Implementations

impl ValueRange

fn new<impl Into<Self>: Into<Self>>(range: impl Into<Self>) -> Self

Create a range

Panics

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

Examples

# use clap_builder as clap;
# use clap::builder::ValueRange;
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:

# use clap_builder as clap;
# use clap::builder::ValueRange;
let range = ValueRange::new(10..5);  // Panics!
fn min_values(self: &Self) -> usize

Fewest number of values the argument accepts

fn max_values(self: &Self) -> usize

Most number of values the argument accepts

fn takes_values(self: &Self) -> bool

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

Examples

# use clap_builder as clap;
# use clap::builder::ValueRange;
let range = ValueRange::new(5);
assert!(range.takes_values());

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

impl Clone for ValueRange

fn clone(self: &Self) -> ValueRange

impl Copy for ValueRange

impl Debug for ValueRange

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

impl Default for ValueRange

fn default() -> Self

impl Display for ValueRange

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

impl Eq for ValueRange

impl Freeze for ValueRange

impl From for ValueRange

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

impl From for ValueRange

fn from(fixed: usize) -> Self

impl From for ValueRange

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

impl From for ValueRange

fn from(_: RangeFull) -> Self

impl From for ValueRange

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

impl From for ValueRange

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

impl From for ValueRange

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

impl Hash for ValueRange

fn hash<__H: $crate::hash::Hasher>(self: &Self, state: &mut __H)

impl PartialEq for ValueRange

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

impl RangeBounds for ValueRange

fn start_bound(self: &Self) -> Bound<&usize>
fn end_bound(self: &Self) -> Bound<&usize>

impl RefUnwindSafe for ValueRange

impl Send for ValueRange

impl StructuralPartialEq for ValueRange

impl Sync for ValueRange

impl Unpin for ValueRange

impl UnsafeUnpin for ValueRange

impl UnwindSafe for ValueRange

impl<I> IntoResettable for ValueRange

fn into_resettable(self: Self) -> Resettable<ValueRange>

impl<T> Any for ValueRange

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for ValueRange

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for ValueRange

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

impl<T> CloneToUninit for ValueRange

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

impl<T> From for ValueRange

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToOwned for ValueRange

fn to_owned(self: &Self) -> T
fn clone_into(self: &Self, target: &mut T)

impl<T> ToString for ValueRange

fn to_string(self: &Self) -> String

impl<T, U> Into for ValueRange

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom for ValueRange

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

impl<T, U> TryInto for ValueRange

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