Inheritance diagram for Argparse.IParser< C >:

Public Member Functions
void	PrintHelp (IParserHelpFormatter< C > formatter)
	Prints a formatted help message to the console with information about parser usage, arguments, options, and subcommand parsers as formatted by the provided formatter .

void	PrintHelp (IParserHelpFormatter< C > formatter, TextWriter writer)
	Prints a formatted help message to the provided output `TextWriter` with information about parser usage, arguments, options, and subcommand parsers as formatted by the provided formatter

IParser< C >	AddSubparser (IParser commandParser)
	Attach a subparser to this parser as a subcommand. The subparser is then triggered and used to parse the rest of the input after one of the names of the subparser tokens is found in input.

IParser< C >	AddFlag (Flag< C > flag)
	Attach a flag-like option to the parser.

IParser< C >	AddFlags (params Flag< C >[] flags)
	Attach one or more flag-like options to the parser.

IParser< C >	AddOption (IOption< C > option)
	Attach a value option to the parser.

IParser< C >	AddOptions (params IOption< C >[] options)
	Attach one or more value options to the parser.

IParser< C >	AddArgument (IArgument< C > argument)
	Attach a plain argument to the parser.

IParser< C >	AddArguments (params IArgument< C >[] arguments)
	Attach one or more plain arguments to the parser.

Public Member Functions inherited from Argparse.IParser
void	ParseAndRun (IEnumerable< string > args)
	Parses command line-like input from args and then invoke the action provided to the specific parser in `Run`.

void	Parse (IEnumerable< string > args)
	Parses command line-like input from args .

void	PrintHelp (TextWriter writer)
	Prints a formatted help message to the provided output writer with information about parser usage, arguments, options, and subcommand parsers.

void	PrintHelp ()
	Prints a formatted help message to the console with information about parser usage, arguments, options, and subcommand parsers.

Properties
ReadOnlyCollection< Flag< C > >	Flags `[get]`
	Returns all flag-like options attached to the parser via the methods AddFlag(Flag<C>) and AddFlags(Flag<C>[]).

C?	Config `[get]`

ReadOnlyCollection< IOption< C > >	Options `[get]`
	Returns all value options attached to the parser via the methods AddFlag(Flag<C>) and AddFlags(Flag<C>[]).

ReadOnlyCollection< IArgument< C > >	Arguments `[get]`
	Returns all plain arguments attached to the parser via the methods AddArgument(IArgument<C>)) and AddArguments(IArgument<C>[]).

Properties inherited from Argparse.IParser
HashSet< string >	Names `[get]`

string	Description `[get]`
	The parser description as it will appear in help.

string	PlainArgumentsDelimiter `[get]`

ReadOnlyDictionary< string, IParser >	SubParsers `[get]`
	Returns a dictionary of all atached subparsers with keys being names of the commands attached to the parsers.

Member Function Documentation

◆ AddArgument()

IParser< C > Argparse.IParser< C >.AddArgument ( IArgument< C > argument )

Attach a plain argument to the parser.

To attach more plain arguments at once, use AddArguments(IArgument<C>[]).

See also

See also: IArgument<C, V>

.

Returns: The parent parser as to allow for chaining of calls and fluent syntax.

Exceptions

InvalidParserConfigurationException If the argument comes after an argument with multiplicity set to ArgumentMultiplicity.AllThatFollow

Implemented in Argparse.Parser< C >, and Argparse.Parser< C >.

◆ AddArguments()

IParser< C > Argparse.IParser< C >.AddArguments ( params IArgument< C >[] arguments )

Attach one or more plain arguments to the parser.

See also

See also: IArgument<C, V>

.

Returns: The parent parser as to allow for chaining of calls and fluent syntax.

Exceptions

InvalidParserConfigurationException If there is an argument which comes after an argument with multiplicity set to ArgumentMultiplicity.AllThatFollow

Implemented in Argparse.Parser< C >, and Argparse.Parser< C >.

◆ AddFlag()

IParser< C > Argparse.IParser< C >.AddFlag ( Flag< C > flag )

Attach a flag-like option to the parser.

To attach more Flag<C> objects at once, see AddFlags(Flag<C>[])

Returns: The parent parser as to allow for chaining of calls and fluent syntax.

Exceptions

InvalidParserConfigurationException On invalid parser configuration, e.g. duplicate flag name

Implemented in Argparse.Parser< C >, and Argparse.Parser< C >.

◆ AddFlags()

IParser< C > Argparse.IParser< C >.AddFlags ( params Flag< C >[] flags )

Attach one or more flag-like options to the parser.

See also

See also: Flag<C>

.

Returns: The parent parser as to allow for chaining of calls and fluent syntax.

Exceptions

InvalidParserConfigurationException On invalid parser configuration, e.g. duplicate flag name

Implemented in Argparse.Parser< C >, and Argparse.Parser< C >.

◆ AddOption()

IParser< C > Argparse.IParser< C >.AddOption ( IOption< C > option )

Attach a value option to the parser.

To attach more IOption<C,V> objects at once, see AddOptions(IOption<C>[])

See also

See also: IOption<C, V>, OptionFactory

Returns: The parent parser as to allow for chaining of calls and fluent syntax.

Exceptions

InvalidParserConfigurationException On invalid parser configuration, e.g. duplicate option name

Implemented in Argparse.Parser< C >, and Argparse.Parser< C >.

◆ AddOptions()

IParser< C > Argparse.IParser< C >.AddOptions ( params IOption< C >[] options )

Attach one or more value options to the parser.

See also

See also: IOption<C, V>, OptionFactory

,

Returns: The parent parser as to allow for chaining of calls and fluent syntax.

Exceptions

InvalidParserConfigurationException On invalid parser configuration, e.g. duplicate option name

Implemented in Argparse.Parser< C >, and Argparse.Parser< C >.

◆ AddSubparser()

IParser< C > Argparse.IParser< C >.AddSubparser ( IParser commandParser )

Attach a subparser to this parser as a subcommand. The subparser is then triggered and used to parse the rest of the input after one of the names of the subparser tokens is found in input.

See Parser<C>.

Parameters

commandParser Parser to attach.

Returns: The parent parser as to allow for chaining of calls and fluent syntax.

Implemented in Argparse.Parser< C >, and Argparse.Parser< C >.

◆ PrintHelp() [1/2]

void Argparse.IParser< C >.PrintHelp ( IParserHelpFormatter< C > formatter )

Prints a formatted help message to the console with information about parser usage, arguments, options, and subcommand parsers as formatted by the provided formatter .

Implemented in Argparse.Parser< C >.

◆ PrintHelp() [2/2]

void Argparse.IParser< C >.PrintHelp	(	IParserHelpFormatter< C >	formatter,
		TextWriter	writer )

Prints a formatted help message to the provided output TextWriter with information about parser usage, arguments, options, and subcommand parsers as formatted by the provided formatter

Implemented in Argparse.Parser< C >.

Property Documentation

◆ Arguments

ReadOnlyCollection<IArgument<C> > Argparse.IParser< C >.Arguments

get

Returns all plain arguments attached to the parser via the methods AddArgument(IArgument<C>)) and AddArguments(IArgument<C>[]).

See also

See also: IArgument<C, V>

.

Implemented in Argparse.Parser< C >.

◆ Config

C? Argparse.IParser< C >.Config

get

Config context instance. Either passed to the parser in the constructor or created by the parser right before parsing of input.

Implemented in Argparse.Parser< C >.

◆ Flags

ReadOnlyCollection<Flag<C> > Argparse.IParser< C >.Flags

get

Returns all flag-like options attached to the parser via the methods AddFlag(Flag<C>) and AddFlags(Flag<C>[]).

Implemented in Argparse.Parser< C >.

◆ Options

ReadOnlyCollection<IOption<C> > Argparse.IParser< C >.Options

get

Returns all value options attached to the parser via the methods AddFlag(Flag<C>) and AddFlags(Flag<C>[]).

See also

See also: Option<C, V>

.

Implemented in Argparse.Parser< C >.

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

argsparse/IParser.cs

Public Member Functions

Properties

Member Function Documentation

◆ AddArgument()

◆ AddArguments()

◆ AddFlag()

◆ AddFlags()

◆ AddOption()

◆ AddOptions()

◆ AddSubparser()

◆ PrintHelp() [1/2]

◆ PrintHelp() [2/2]

Property Documentation

◆ Arguments

◆ Config

◆ Flags

◆ Options