Struct StringType 

pub struct StringType;

A string parameter type (the default).

Passes through string values unchanged.

Trait Implementations

impl Clone for StringType

fn clone(&self) -> StringType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StringType

impl Debug for StringType

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

Formats the value using the given formatter.

impl Default for StringType

fn default() -> StringType

Returns the “default value” for a type.

impl TypeConverter for StringType

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

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

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.

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.