Struct SpecChoices 

#[non_exhaustive]
pub struct SpecChoices {
    pub choices: Vec<String>,
    pub details: Vec<SpecChoice>,
    pub ignore_case: bool,
    pub strict: bool,
    pub run: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

choices: Vec<String>

details: Vec<SpecChoice>

Metadata for canonical values that need more than the shorthand string form.

ignore_case: bool

Match canonical values and aliases without regard to ASCII case.

strict: bool

Whether values outside the declared set are rejected.

run: Option<String>

A shell command whose output lists further values, one per line.

Run only where a program is running: when a value is checked, when a word is being completed, and for a help page asked for with crate::docs::cli::render_runtime_help or by --help during a parse. Generated documentation and code never run it, and describe it instead.

Implementations

impl SpecChoices

pub fn new(choices: impl IntoIterator<Item = impl Into<String>>) -> Self

The set of values an arg or flag accepts.

impl SpecChoices

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

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

The command whose output lists further values, if the choices name one.

pub fn values(&self) -> Vec<String>

The declared values, and those named by env=. Never runs run=: see Self::values_from_run and Self::resolved_values for that.

pub fn values_from_run( &self, env: Option<&HashMap<String, String>>, ) -> Result<Vec<String>, UsageErr>

Run run= and return the values it printed: one per line, trimmed, with blank lines skipped. Empty when the choices name no command.

env is added to the command’s environment, for a caller parsing against a different one (see crate::Parser::with_env). Within a single parse or help page the same command runs once, however many values are checked against it.

pub fn resolved_values( &self, env: Option<&HashMap<String, String>>, ) -> Result<Vec<String>, UsageErr>

Every value these choices offer: the declared ones, env=’s, and what run= prints, without repeats. What completion offers and what a running program’s help lists.

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

Whether value is one of the declared values or those named by env=. Never runs run=.

Trait Implementations

impl Clone for SpecChoices

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpecChoices

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

Formats the value using the given formatter.

impl Default for SpecChoices

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpecChoices

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SpecChoices

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.