Struct TupleType 

pub struct TupleType { /* private fields */ }

A composite parameter type that collects multiple values with different types.

Unlike regular types with nargs, each position in a tuple can have a different type.

Implementations

impl TupleType

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

where I: IntoIterator<Item = S>, S: AsRef<str>,

Create a new tuple type from a list of type specifiers.

Each specifier should be one of: “string”, “int”, “float”, “bool”

pub fn strings(count: usize) -> Self

Create a tuple of strings.

pub fn ints(count: usize) -> Self

Create a tuple of integers.

impl TupleType

pub fn convert_element( &self, index: usize, value: &str, ) -> Result<TupleValue, String>

Convert a single element at the given index.

This is the preferred way to convert tuple elements - the parser should call this once for each argument consumed.

pub fn convert_values(&self, values: &[&str]) -> Result<Vec<TupleValue>, String>

Convert a slice of pre-split values into a tuple.

This is the standard Click-compatible conversion - the parser provides already-split argument values.

Trait Implementations

impl Debug for TupleType

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

Formats the value using the given formatter.

impl TypeConverter for TupleType

type Value = Vec<TupleValue>

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_metavar(&self) -> Option<String>

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

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.

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

Returns an optional message when a required value is missing.

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

Split an environment variable value into multiple values.

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

Returns shell completion items for the given incomplete value.