Properties

required HashSet< string > Names [get]

Names the options as they will be parsed by the parser. Names of long options are prefixed with two dashes '–' Names of short options are prefixed with one dash '-' One option can represent both long and short options.

Exceptions

ArgumentException Thrown when set to an empty array or any of the provided names is in an invalid format.

string ValuePlaceHolder = "<value>" [get]

Value used in help message as placeholder for value. e.g. when set to FILE for option –output, the help message will be: –output=FILE.

required string Description [get]

Description of the option as it should appear in help write-up.

required Action< C, V > Action [get]

Action to be carried out upon parsing and conversion of the option from the input.

bool IsRequired = false [get]

If true, the parser will produce an error state upon finishing parsing without encountering the option.

required Func< string, V > Converter [get]

Function to convert the option value parsed as a string from the input to the target type.

Detailed Description

Models a parser option which is to accept a value provided by the user.

Template Parameters

C	The cofiguration context type for the given parser, see Parser<C>
V	Type of the value the provided string is to be converted to. ///

Property Documentation

◆ Converter

required Func<string, V> Argparse.Option< C, V >.Converter

get

Function to convert the option value parsed as a string from the input to the target type.

Converters may throw exceptions, they will be caught and the parser will throw ParserConversionException

Some of the basic converters are available in ConverterFactory

It is good practice to not use converters to store the value or manipulate outer state.

◆ Description

required string Argparse.Option< C, V >.Description

get

Description of the option as it should appear in help write-up.

Implements Argparse.IOption< C >.

◆ IsRequired

bool Argparse.Option< C, V >.IsRequired = false

get

If true, the parser will produce an error state upon finishing parsing without encountering the option.

Implements Argparse.IOption< C >.

◆ Names

required HashSet<string> Argparse.Option< C, V >.Names

get

Names the options as they will be parsed by the parser. Names of long options are prefixed with two dashes '–' Names of short options are prefixed with one dash '-' One option can represent both long and short options.

Exceptions

ArgumentException Thrown when set to an empty array or any of the provided names is in an invalid format.

Implements Argparse.IOption< C >.

◆ ValuePlaceHolder

string Argparse.Option< C, V >.ValuePlaceHolder = "<value>"

get

Value used in help message as placeholder for value. e.g. when set to FILE for option –output, the help message will be: –output=FILE.

Implements Argparse.IOption< C >.

The documentation for this class was generated from the following file:

argsparse/Option.cs