Struct clap::ArgValue

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

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

impl<'help> ArgValue<'help>

Getters

pub fn get_name(&self) -> &str

Get the name of the argument value

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

Get the help specified for this argument, if any

pub fn is_hidden(&self) -> bool

Should the value be hidden from help messages and completion

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

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

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.

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));

impl<'help> ArgValue<'help>

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")

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")

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)

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")

pub fn aliases<I>(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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> ArgValue<'help>

Returns the “default value” for a type.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

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

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

This method tests for !=.

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

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

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