Struct OptionDef 

pub struct OptionDef {
    pub name: String,
    pub short_name: Option<char>,
    pub opt_type: OptionType,
    pub default_value: OptionValue,
    pub description: String,
    pub category: OptionCategory,
    pub min: Option<i64>,
    pub max: Option<u64>,
    pub deprecated: bool,
    pub hidden: bool,
}

Definition/metadata for a single configuration option.

Fields

name: String

short_name: Option<char>

opt_type: OptionType

default_value: OptionValue

description: String

category: OptionCategory

min: Option<i64>

max: Option<u64>

deprecated: bool

hidden: bool

Implementations

impl OptionDef

pub fn new(name: impl Into<String>, opt_type: OptionType) -> Self

pub fn name(&self) -> &str

pub fn short_name(&self) -> Option<char>

pub fn opt_type(&self) -> OptionType

pub fn default_value(&self) -> &OptionValue

pub fn get_category(&self) -> OptionCategory

pub fn is_deprecated(&self) -> bool

pub fn is_hidden(&self) -> bool

pub fn description(&self) -> &str

pub fn parse_value(&self, s: &str) -> Result<OptionValue, String>

Trait Implementations

impl Clone for OptionDef

fn clone(&self) -> OptionDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionDef

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

Formats the value using the given formatter.

impl Default for OptionDef

fn default() -> Self

Returns the “default value” for a type.