Struct clap::ArgValue

source · [−]

pub struct ArgValue<'help> { /* private fields */ }

Expand description

The representation of a possible value of an argument.

This is used for specifying possible values of Args.

NOTE: This struct is likely not needed for most usecases as it is only required to hide single values from help messages and shell completions or to attach about to possible values.

Examples

let cfg = Arg::new("config")
      .takes_value(true)
      .value_name("FILE")
      .possible_value(ArgValue::new("fast"))
      .possible_value(ArgValue::new("slow").about("slower than fast"))
      .possible_value(ArgValue::new("secret speed").hidden(true));

Implementations

source

impl<'help> ArgValue<'help>

Getters

source

pub fn get_name(&self) -> &str

Get the name of the argument value

source

pub fn get_about(&self) -> Option<&str>

Get the help specified for this argument, if any

source

pub fn is_hidden(&self) -> bool

Should the value be hidden from help messages and completion

source

pub fn get_visible_name(&self) -> Option<&str>

Get the name if argument value is not hidden, None otherwise

source

pub fn get_name_and_aliases(&self) -> impl Iterator<Item = &str>

Returns all valid values of the argument value. Namely the name and all aliases.

source

pub fn matches(&self, value: &str, ignore_case: bool) -> bool

Tests if the value is valid for this argument value

The value is valid if it is either the name or one of the aliases.

Examples

let arg_value = ArgValue::new("fast").alias("not-slow");

assert!(arg_value.matches("fast", false));
assert!(arg_value.matches("not-slow", false));

assert!(arg_value.matches("FAST", true));
assert!(!arg_value.matches("FAST", false));

source

impl<'help> ArgValue<'help>

source

pub fn new(name: &'help str) -> Self

Creates a new instance of ArgValue using a string name. The name will be used to decide wether this value was provided by the user to an argument.

NOTE: In case it is not hidden it will also be shown in help messages for arguments that use it as a possible value and have not hidden them through Arg::hide_possible_values(true).

Examples

ArgValue::new("fast")

source

pub fn about(self, about: &'help str) -> Self

Sets the help text of the value that will be displayed to the user when completing the value in a compatible shell. Typically, this is a short description of the value.

Examples

ArgValue::new("slow")
    .about("not fast")

source

pub fn hidden(self, yes: bool) -> Self

Hides this value from help text and shell completions.

This is an alternative to hiding through Arg::hide_possible_values(true), if you only want to hide some values.

Examples

ArgValue::new("secret")
    .hidden(true)

source

pub fn alias(self, name: &'help str) -> Self

Sets an alias for this argument value.

The alias will be hidden from completion and help texts.

Examples

ArgValue::new("slow")
    .alias("not-fast")

source

pub fn aliases(self, names: I) -> Self where
I: IntoIterator<Item = &'help str>,

Sets multiple aliases for this argument value.

The aliases will be hidden from completion and help texts.

Examples

ArgValue::new("slow")
    .aliases(["not-fast", "snake-like"])

Trait Implementations

source

impl<'help> Clone for ArgValue<'help>

source

fn clone(&self) -> ArgValue<'help>

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<'help> Debug for ArgValue<'help>

source

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

Formats the value using the given formatter. Read more

source

impl<'help> Default for ArgValue<'help>

source

fn default() -> ArgValue<'help>

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

source

impl<'help> From<&'help &'help str> for ArgValue<'help>

source

fn from(s: &'help &'help str) -> Self

Performs the conversion.

source

impl<'help> From<&'help str> for ArgValue<'help>

source

fn from(s: &'help str) -> Self

Performs the conversion.

source

impl<'help> PartialEq<ArgValue<'help>> for ArgValue<'help>

source

fn eq(&self, other: &ArgValue<'help>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &ArgValue<'help>) -> bool

This method tests for !=.

source

impl<'help> Eq for ArgValue<'help>

source

impl<'help> StructuralEq for ArgValue<'help>

source

impl<'help> StructuralPartialEq for ArgValue<'help>

Auto Trait Implementations

impl<'help> RefUnwindSafe for ArgValue<'help>

impl<'help> Send for ArgValue<'help>

impl<'help> Sync for ArgValue<'help>

impl<'help> Unpin for ArgValue<'help>

impl<'help> UnwindSafe for ArgValue<'help>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

pub fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct clap::ArgValue

Implementations

impl<'help> ArgValue<'help>

pub fn get_name(&self) -> &str

pub fn get_about(&self) -> Option<&str>

pub fn is_hidden(&self) -> bool

pub fn get_visible_name(&self) -> Option<&str>

pub fn get_name_and_aliases(&self) -> impl Iterator<Item = &str>

pub fn matches(&self, value: &str, ignore_case: bool) -> bool

impl<'help> ArgValue<'help>

pub fn new(name: &'help str) -> Self

pub fn about(self, about: &'help str) -> Self

pub fn hidden(self, yes: bool) -> Self

pub fn alias(self, name: &'help str) -> Self

pub fn aliases<I>(self, names: I) -> Self where I: IntoIterator<Item = &'help str>,

Trait Implementations

impl<'help> Clone for ArgValue<'help>

fn clone(&self) -> ArgValue<'help>

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

impl<'help> Debug for ArgValue<'help>

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

impl<'help> Default for ArgValue<'help>

fn default() -> ArgValue<'help>

impl<'help> From<&'help &'help str> for ArgValue<'help>

fn from(s: &'help &'help str) -> Self

impl<'help> From<&'help str> for ArgValue<'help>

fn from(s: &'help str) -> Self

impl<'help> PartialEq<ArgValue<'help>> for ArgValue<'help>

fn eq(&self, other: &ArgValue<'help>) -> bool

fn ne(&self, other: &ArgValue<'help>) -> bool

impl<'help> Eq for ArgValue<'help>

impl<'help> StructuralEq for ArgValue<'help>

impl<'help> StructuralPartialEq for ArgValue<'help>

Auto Trait Implementations

impl<'help> RefUnwindSafe for ArgValue<'help>

impl<'help> Send for ArgValue<'help>

impl<'help> Sync for ArgValue<'help>

impl<'help> Unpin for ArgValue<'help>

impl<'help> UnwindSafe for ArgValue<'help>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

pub fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

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

pub fn aliases<I>(self, names: I) -> Self where
I: IntoIterator<Item = &'help str>,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

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

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

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