Struct OptRule 

pub struct OptRule { /* private fields */ }

A parsing rule that describes one option. This includes the following metadata:

• name: internal lookup name.
• long: optional long form (for example verbose).
• short: optional short form (for example v).
• val_count: number of following values. Zero means this is a flag.

Implementations

impl OptRule

pub const fn new(name: &'static str) -> OptRule

Creates an OptRule with name. No short or long identifier is set.

pub const fn new_auto_long(name: &'static str) -> OptRule

Creates an OptRule whose long identifier equals name.

pub const fn new_auto(name: &'static str) -> OptRule

Creates an OptRule with long equal to name and short set to the first character of name.

pub const fn set_long(self, long: &'static str) -> OptRule

Sets the long identifier.

pub const fn set_short(self, short: char) -> OptRule

Sets the short identifier.

pub const fn set_val_count(self, val_count: usize) -> OptRule

Sets the number of values this option accepts.

pub const fn name(&self) -> &'static str

Returns the rule’s internal name.

pub fn long(&self) -> Option<&'static str>

Returns the long identifier, if any.

pub const fn short(&self) -> Option<char>

Returns the short identifier, if any.

pub const fn val_count(&self) -> usize

Returns how many values this option accepts.