Struct BoolType 

pub struct BoolType;

A boolean parameter type.

Accepts various string representations of boolean values:

• True: “1”, “true”, “yes”, “on”, “t”, “y”
• False: “0”, “false”, “no”, “off”, “f”, “n”, “”

Implementations

impl BoolType

pub const BOOL_STATES: &'static [&'static str]

List of recognized boolean string values (includes empty string at start).

pub fn str_to_bool(value: &str) -> Option<bool>

Convert a string to a boolean, returning None if not recognized.

Trait Implementations

impl Clone for BoolType

fn clone(&self) -> BoolType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BoolType

impl Debug for BoolType

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

Formats the value using the given formatter.

impl Default for BoolType

fn default() -> BoolType

Returns the “default value” for a type.

impl TypeConverter for BoolType

type Value = bool

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.