Struct Choice 

pub struct Choice {
    pub choices: Vec<String>,
    pub case_sensitive: bool,
}

A parameter type that restricts values to a fixed set of choices.

By default, matching is case-sensitive. Set case_sensitive to false to enable case-insensitive matching.

Fields

choices: Vec<String>

The valid choices.

case_sensitive: bool

Whether matching is case-sensitive.

Implementations

impl Choice

pub fn new<I, S>(choices: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Create a new choice type with the given choices.

pub fn case_sensitive(self, case_sensitive: bool) -> Self

Set whether matching is case-sensitive.

Trait Implementations

impl Clone for Choice

fn clone(&self) -> Choice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Choice

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

Formats the value using the given formatter.

impl TypeConverter for Choice

type Value = String

The Rust type that this parameter type converts to.

fn name(&self) -> &str

Returns the descriptive name of this type (used in error messages).

fn convert(&self, value: &str) -> Result<Self::Value, String>

Convert a string value to the target type.

fn get_missing_message(&self) -> Option<String>

Returns an optional message when a required value is missing.

fn shell_complete(&self, incomplete: &str) -> Vec<CompletionItem>

Returns shell completion items for the given incomplete value.

fn get_metavar(&self) -> Option<String>

Returns the metavar for this type (used in help text).

fn split_envvar_value(&self, value: &str) -> Vec<String>

Split an environment variable value into multiple values.

fn is_composite(&self) -> bool

Whether this type is a composite type (like Tuple).

fn arity(&self) -> usize

The arity (number of values consumed) for composite types.