Struct OptionBuilder 

pub struct OptionBuilder { /* private fields */ }

An builder struct for AnpOption.

Implementations

impl OptionBuilder

pub fn build(self) -> Result<AnpOption, OptionErr>

Build an AnpOption with configured values.

Error

Returns an error if:

• option and long_option are not specified.
• option or long_option is blank or not valid option name.

The valid option name:

• for a single char - alphabetic only
• for multiple chars - alphabetic, "@", "?"

pub fn arg_name(self, arg_name: &str) -> Self

Set the argument name of the option.

pub fn option(self, opt: &str) -> Self

Set the short option name.

The short option name is not necessary to have a single char. A short option with multiple chars is also valid, like -required.

pub fn long_option(self, long_opt: &str) -> Self

Set the long option name.

pub fn desc(self, description: &str) -> Self

Set the description of the option.

pub fn has_arg(self, has_arg: bool) -> Self

Set whether the option has exactly one argument or no argument.

Also see Self::has_args and Self::number_of_args.

pub fn has_args(self) -> Self

Set the option to having unlimited number of arguments.

Also see Self::has_arg and Self::number_of_args.

pub fn number_of_args(self, number_of_args: usize) -> Self

Set the option to having exactly number_of_args number of arguments.

Also see Self::has_arg and Self::has_args

pub fn optional_arg(self, is_optional: bool) -> Self

Whether argument(s) is optional.

pub fn required(self, required: bool) -> Self

Whether the option is required to passed to command line.

pub fn value_separator(self, value_sep: char) -> Self

Set the value separator for the option.

For example, when the value separator set to ,, the option value -v=1,2,3 is parsed into three values.