Struct OptionDef

pub struct OptionDef {
    pub name: String,
    pub value_type: OptionValueType,
    pub description: String,
    pub conflicts_with: Vec<String>,
    pub requires: Vec<String>,
    pub deprecated: Option<String>,
    pub repeatable: bool,
}

Definition of a command-line option

Fields

name: String

Option name (e.g., “–release”, “–features”)

value_type: OptionValueType

Type of value this option expects

description: String

Human-readable description

conflicts_with: Vec<String>

Options that conflict with this one

requires: Vec<String>

Options that are required when this one is used

deprecated: Option<String>

Deprecation message if this option is deprecated

repeatable: bool

Whether this option can appear multiple times

Implementations

impl OptionDef

pub fn flag(name: impl Into<String>, description: impl Into<String>) -> Self

Create a new flag option

pub fn single( name: impl Into<String>, description: impl Into<String>, validator: ValueValidator, ) -> Self

Create a new single value option

pub fn multiple( name: impl Into<String>, description: impl Into<String>, validator: ValueValidator, ) -> Self

Create a new multiple value option

pub fn conflicts_with(self, options: Vec<String>) -> Self

Add conflicting options

pub fn requires(self, options: Vec<String>) -> Self

Add required options

pub fn deprecated(self, message: impl Into<String>) -> Self

Mark as deprecated

pub fn repeatable(self) -> Self

Mark as repeatable

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<'de> Deserialize<'de> for OptionDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OptionDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.