Struct pretty_exec::clap::PossibleValue

[−]

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

Expand description

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 help to possible values.

Examples

let cfg = Arg::new("config")
    .takes_value(true)
    .value_name("FILE")
    .value_parser([
        PossibleValue::new("fast"),
        PossibleValue::new("slow").help("slower than fast"),
        PossibleValue::new("secret speed").hide(true)
    ]);

Implementations

impl<'help> PossibleValue<'help>

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

Create a PossibleValue with its name.

The name will be used to decide whether 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

PossibleValue::new("fast")

pub fn help(self, help: &'help str) -> PossibleValue<'help>

Sets the help description of the value.

This is typically displayed in completions (where supported) and should be a short, one-line description.

Examples

PossibleValue::new("slow")
    .help("not fast")

pub fn hide(self, yes: bool) -> PossibleValue<'help>

Hides this value from help and shell completions.

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

Examples

PossibleValue::new("secret")
    .hide(true)

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

Sets a hidden alias for this argument value.

Examples

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

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

Sets multiple hidden aliases for this argument value.

Examples

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

impl<'help> PossibleValue<'help>

Reflection

pub fn get_name(&self) -> &'help str

Get the name of the argument value

pub fn get_help(&self) -> Option<&'help str>

Get the help specified for this argument, if any

pub fn is_hidden(&self) -> bool

Deprecated, replaced with PossibleValue::is_hide_set

pub fn is_hide_set(&self) -> bool

Report if PossibleValue::hide is set

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

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

pub fn get_name_and_aliases(&self) -> impl Iterator<Item = &'help 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 = PossibleValue::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));

Trait Implementations

impl<'help> Clone for PossibleValue<'help>

fn clone(&self) -> PossibleValue<'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

impl<'help> Debug for PossibleValue<'help>

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

Formats the value using the given formatter. Read more

impl<'help> Default for PossibleValue<'help>

fn default() -> PossibleValue<'help>

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

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'help> PartialEq<PossibleValue<'help>> for PossibleValue<'help>

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

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

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

This method tests for !=.

impl<'help> Eq for PossibleValue<'help>

impl<'help> StructuralEq for PossibleValue<'help>

impl<'help> StructuralPartialEq for PossibleValue<'help>

Auto Trait Implementations

impl<'help> RefUnwindSafe for PossibleValue<'help>

impl<'help> Send for PossibleValue<'help>

impl<'help> Sync for PossibleValue<'help>

impl<'help> Unpin for PossibleValue<'help>

impl<'help> UnwindSafe for PossibleValue<'help>

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,

const: unstable · source

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

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

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

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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<X> Pipe for X

fn pipe<Return, Function>(self, f: Function) -> Return where
Function: FnOnce(Self) -> Return,

Apply f to self. Read more

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Return where
Function: FnOnce(&'a Self) -> Return,

Apply f to &self. Read more

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Return where
Function: FnOnce(&'a mut Self) -> Return,

Apply f to &mut self. Read more

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
 Self: AsRef<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait AsRef<Param>. Read more

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Return where
 Self: AsMut<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait AsMut<Param>. Read more

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
 Self: Deref<Target = Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait Deref<Target = Param>. Read more

fn pipe_deref_mut<'a, Param, Return, Function>(
 &'a mut self,
 f: Function
) -> Return where
 Self: DerefMut<Target = Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait [DerefMut<Target = Param>]. Read more

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
 Self: Borrow<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait Borrow<Param>. Read more

fn pipe_borrow_mut<'a, Param, Return, Function>(
 &'a mut self,
 f: Function
) -> Return where
 Self: BorrowMut<Param>,
 Param: 'a + ?Sized,
 Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait BorrowMut<Param>. Read more

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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

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

Performs the conversion.

Struct pretty_exec::clap::PossibleValue

Implementations

impl<'help> PossibleValue<'help>

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

pub fn help(self, help: &'help str) -> PossibleValue<'help>

pub fn hide(self, yes: bool) -> PossibleValue<'help>

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

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

impl<'help> PossibleValue<'help>

pub fn get_name(&self) -> &'help str

pub fn get_help(&self) -> Option<&'help str>

pub fn is_hidden(&self) -> bool

pub fn is_hide_set(&self) -> bool

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

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

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

Trait Implementations

impl<'help> Clone for PossibleValue<'help>

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

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

impl<'help> Debug for PossibleValue<'help>

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

impl<'help> Default for PossibleValue<'help>

fn default() -> PossibleValue<'help>

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

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

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

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

impl<'help> PartialEq<PossibleValue<'help>> for PossibleValue<'help>

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

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

impl<'help> Eq for PossibleValue<'help>

impl<'help> StructuralEq for PossibleValue<'help>

impl<'help> StructuralPartialEq for PossibleValue<'help>

Auto Trait Implementations

impl<'help> RefUnwindSafe for PossibleValue<'help>

impl<'help> Send for PossibleValue<'help>

impl<'help> Sync for PossibleValue<'help>

impl<'help> Unpin for PossibleValue<'help>

impl<'help> UnwindSafe for PossibleValue<'help>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<X> Pipe for X

fn pipe<Return, Function>(self, f: Function) -> Return where Function: FnOnce(Self) -> Return,

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Return where Function: FnOnce(&'a Self) -> Return,

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Return where Function: FnOnce(&'a mut Self) -> Return,

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where Self: AsRef<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a Param) -> Return,

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Return where Self: AsMut<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a mut Param) -> Return,

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where Self: Deref<Target = Param>, Param: 'a + ?Sized, Function: FnOnce(&'a Param) -> Return,

fn pipe_deref_mut<'a, Param, Return, Function>( &'a mut self, f: Function) -> Return where Self: DerefMut<Target = Param>, Param: 'a + ?Sized, Function: FnOnce(&'a mut Param) -> Return,

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Return where Self: Borrow<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a Param) -> Return,

fn pipe_borrow_mut<'a, Param, Return, Function>( &'a mut self, f: Function) -> Return where Self: BorrowMut<Param>, Param: 'a + ?Sized, Function: FnOnce(&'a mut Param) -> Return,

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

pub fn aliases<I>(self, names: I) -> PossibleValue<'help> 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>,

fn pipe<Return, Function>(self, f: Function) -> Return where
Function: FnOnce(Self) -> Return,

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Return where
Function: FnOnce(&'a Self) -> Return,

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Return where
Function: FnOnce(&'a mut Self) -> Return,

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
Self: AsRef<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a Param) -> Return,

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Return where
Self: AsMut<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
Self: Deref<Target = Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a Param) -> Return,

fn pipe_deref_mut<'a, Param, Return, Function>(
&'a mut self,
f: Function
) -> Return where
Self: DerefMut<Target = Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
Self: Borrow<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a Param) -> Return,

fn pipe_borrow_mut<'a, Param, Return, Function>(
&'a mut self,
f: Function
) -> Return where
Self: BorrowMut<Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,

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