Argparse.Parser< C > Class Template Reference

Inheritance diagram for Argparse.Parser< C >:

Public Member Functions
partial 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.
partial IParser< C >	AddArguments (params IArgument< C >[] arguments)
	Attach one or more plain arguments to the parser.
partial IParser< C >	AddArgument (IArgument< C > argument)
	Attach a plain argument to the parser.
partial IParser< C >	AddOptions (params IOption< C >[] options)
	Attach one or more value options to the parser.
partial IParser< C >	AddOption (IOption< C > option)
	Attach a value option to the parser.
partial IParser< C >	AddFlags (params Flag< C >[] flags)
	Attach one or more flag-like options to the parser.
partial IParser< C >	AddFlag (Flag< C > flag)
	Attach a flag-like option to the parser.
partial 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>.
partial 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>[])
partial IParser< C >	AddFlags (params Flag< C >[] flags)
	Attach one or more flag-like options to the parser.See also
partial 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>[])
partial IParser< C >	AddOptions (params IOption< C >[] options)
	Attach one or more value options to the parser.See also See also IOption<C, V>, OptionFactory ,
partial IParser< C >	AddArgument (IArgument< C > argument)
	Attach a plain argument to the parser.To attach more plain arguments at once, use AddArguments(IArgument<C>[]).
partial IParser< C >	AddArguments (params IArgument< C >[] arguments)
	Attach one or more plain arguments to the parser.See also See also IArgument<C, V> .
	Parser (C config)
	Creates parser with config context C .
	Parser (Func< C > configFactory)
	Creates parser with config context C .
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
void	PrintHelp (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 DefaultHelpFormatter<T>
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 ()
	Prints a formatted help message to the console with information about parser usage, arguments, options, and subcommand parsers as formatted by DefaultHelpFormatter<T>
void	Parse (IEnumerable< string > args)
	Parses command line-like input from args . Exceptions InvalidParserConfigurationException Thrown when the parser is not configured properly. ParserConversionException Thrown when the parser fails to convert a value from string to the intended type. ParserRuntimeException Thrown when the parser fails to run the action associated with an option, flag or argument or a parser.
void	ParseAndRun (IEnumerable< string > args)
	Parses command line-like input from args and then invoke the action provided to the specific parser in Run. Exceptions InvalidParserConfigurationException Thrown when the parser is not configured properly. ParserConversionException Thrown when the parser fails to convert a value from string to the intended type. ParserRuntimeException Thrown when the parser fails to run the action associated with an option, flag or argument or a parser.

Properties
required HashSet< string >	Names [get]
	The parser name as it will appear in help and debug messages. The names must not start with "-" or "--". There must be at least one name.
required string	Description [get]
	The parser description as it will appear in help.
string	PlainArgumentsDelimiter = "--" [get]
	Used to configure the arguments delimiter, which when parsed gives signal to the parser to treat all subsequent tokens as plain arguments.
C?	Config [get]
	Config context instance. Either passed to the parser in the constructor or created by the parser right before parsing of input.
Func< C >?	ConfigFactory [get]
Action< C, Parser< C > >	Run = (_, _) => { } [get, set]
ReadOnlyDictionary< string, IParser >	SubParsers [get]
	Returns a dictionary of all atached subparsers with keys being names of the commands attached to the parsers.See <see cref="AddSubparser(string, IParser)"
ReadOnlyCollection< Flag< C > >	Flags [get]
	Returns all flag-like options attached to the parser via the methods AddFlag(Flag<C>) and AddFlags(Flag<C>[]).
ReadOnlyCollection< IOption< 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> .
ReadOnlyCollection< IArgument< 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> .

Member Function Documentation

AddArgument() [1/2]

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

inline

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

Implements Argparse.IParser< C >.

AddArgument() [2/2]

partial IParser< C > Argparse.Parser< C >.AddArgument

(

IArgument< C >

argument

)

Attach a plain argument to the parser.To attach more plain arguments at once, use AddArguments(IArgument<C>[]).

Implements Argparse.IParser< C >.

AddArguments() [1/2]

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

inline

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

Implements Argparse.IParser< C >.

AddArguments() [2/2]

partial IParser< C > Argparse.Parser< C >.AddArguments

(

params IArgument< C >[]

arguments

)

Attach one or more plain arguments to the parser.See also

See also

IArgument<C, V>

.

Implements Argparse.IParser< C >.

AddFlag() [1/2]

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

inline

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

Implements Argparse.IParser< C >.

AddFlag() [2/2]

partial IParser< C > Argparse.Parser< 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>[])

Implements Argparse.IParser< C >.

AddFlags() [1/2]

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

inline

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

Implements Argparse.IParser< C >.

AddFlags() [2/2]

partial IParser< C > Argparse.Parser< C >.AddFlags

(

params Flag< C >[]

flags

)

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

Implements Argparse.IParser< C >.

AddOption() [1/2]

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

inline

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

Implements Argparse.IParser< C >.

AddOption() [2/2]

partial IParser< C > Argparse.Parser< 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>[])

Implements Argparse.IParser< C >.

AddOptions() [1/2]

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

inline

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

Implements Argparse.IParser< C >.

AddOptions() [2/2]

partial IParser< C > Argparse.Parser< C >.AddOptions

(

params IOption< C >[]

options

)

Attach one or more value options to the parser.See also

See also

IOption<C, V>, OptionFactory

,

Implements Argparse.IParser< C >.

AddSubparser() [1/2]

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

inline

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.

Implements Argparse.IParser< C >.

AddSubparser() [2/2]

partial IParser< C > Argparse.Parser< 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>.

Implements Argparse.IParser< C >.

Parse()

void Argparse.Parser< C >.Parse ( IEnumerable< string > args )

inline

Parses command line-like input from args .

Exceptions

InvalidParserConfigurationException	Thrown when the parser is not configured properly.
ParserConversionException	Thrown when the parser fails to convert a value from string to the intended type.
ParserRuntimeException	Thrown when the parser fails to run the action associated with an option, flag or argument or a parser.

Implements Argparse.IParser.

ParseAndRun()

void Argparse.Parser< C >.ParseAndRun ( IEnumerable< string > args )

inline

Parses command line-like input from args and then invoke the action provided to the specific parser in Run.

Exceptions

InvalidParserConfigurationException	Thrown when the parser is not configured properly.
ParserConversionException	Thrown when the parser fails to convert a value from string to the intended type.
ParserRuntimeException	Thrown when the parser fails to run the action associated with an option, flag or argument or a parser.

Implements Argparse.IParser.

Parser() [1/2]

Argparse.Parser< C >.Parser ( C config )

inline

Creates parser with config context C .

Parameters

config

Instance of config context to be used.

Parser() [2/2]

Argparse.Parser< C >.Parser ( Func< C > configFactory )

inline

Creates parser with config context C .

Parameters

configFactory

Factory method to be used to instantiate the config object when the parser is used.

PrintHelp() [1/4]

void Argparse.Parser< C >.PrintHelp

(

)

Prints a formatted help message to the console with information about parser usage, arguments, options, and subcommand parsers as formatted by DefaultHelpFormatter<T>

Implements Argparse.IParser.

PrintHelp() [2/4]

void Argparse.Parser< 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 .

Implements Argparse.IParser< C >.

PrintHelp() [3/4]

void Argparse.Parser< 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

Implements Argparse.IParser< C >.

PrintHelp() [4/4]

void Argparse.Parser< C >.PrintHelp

(

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 DefaultHelpFormatter<T>

Implements Argparse.IParser.

Property Documentation

Arguments

ReadOnlyCollection<IArgument<C> > Argparse.Parser< 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>

.

Implements Argparse.IParser< C >.

Config

C? Argparse.Parser< C >.Config

get

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

Implements Argparse.IParser< C >.

ConfigFactory

Func<C>? Argparse.Parser< C >.ConfigFactory

get

Factory method used to create config context instance when the parser is run.

Null if the parser is created with a provided config context instance.

Description

required string Argparse.Parser< C >.Description

get

The parser description as it will appear in help.

Implements Argparse.IParser.

Flags

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

get

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

Implements Argparse.IParser< C >.

Names

required HashSet<string> Argparse.Parser< C >.Names

get

The parser name as it will appear in help and debug messages. The names must not start with "-" or "--". There must be at least one name.

Implements Argparse.IParser.

Options

ReadOnlyCollection<IOption<C> > Argparse.Parser< 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>

.

Implements Argparse.IParser< C >.

PlainArgumentsDelimiter

string Argparse.Parser< C >.PlainArgumentsDelimiter = "--"

get

Used to configure the arguments delimiter, which when parsed gives signal to the parser to treat all subsequent tokens as plain arguments.

Implements Argparse.IParser.

Run

Action<C, Parser<C> > Argparse.Parser< C >.Run = (_, _) => { }

getset

Delegate to be run after the parser finishes parsing.

Defaults to an empty action.

SubParsers

ReadOnlyDictionary<string, IParser> Argparse.Parser< C >.SubParsers

get

Returns a dictionary of all atached subparsers with keys being names of the commands attached to the parsers.See <see cref="AddSubparser(string, IParser)"

Implements Argparse.IParser.

---

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

• argsparse/lib/Parser.cs
• argsparse/Parser.cs