BadScript 2
Loading...
Searching...
No Matches
CommandLine Namespace Reference

Namespaces

namespace  Core
 
namespace  Infrastructure
 
namespace  Tests
 
namespace  Text
 

Classes

class  BadFormatConversionError
 Models an error generated when a value conversion fails. More...
 
class  BadFormatTokenError
 Models an error generated when an invalid token is detected. More...
 
class  BadVerbSelectedError
 Models an error generated when an unknown verb is detected. More...
 
class  BaseAttribute
 Models a base attribute to define command line syntax. More...
 
class  CastExtensions
 
class  Error
 Base type of all errors. More...
 
class  ErrorExtensions
 
class  GroupOptionAmbiguityError
 
class  HelpRequestedError
 Models an error generated when a user explicitly requests help. More...
 
class  HelpTextExtensions
 
class  HelpVerbRequestedError
 Models an error generated when a user explicitly requests help in verb commands scenario. More...
 
class  InvalidAttributeConfigurationError
 Models an error generated when an invalid token is detected. More...
 
class  MissingGroupOptionError
 
class  MissingRequiredOptionError
 Models an error generated when a required option is required. More...
 
class  MissingValueOptionError
 Models an error generated when an option lacks its value. More...
 
class  MultipleDefaultVerbsError
 Models an error generated when multiple default verbs are defined. More...
 
class  MutuallyExclusiveSetError
 Models an error generated when a an option from another set is defined. More...
 
class  NamedError
 Base type of all erros with name information. More...
 
class  NameInfo
 Models name information, used in CommandLine.Error instances. More...
 
class  NotParsed
 It contains a sequence of CommandLine.Error. More...
 
class  NoVerbSelectedError
 Models an error generated when no verb is selected. More...
 
class  NullInstance
 Models a null result when constructing a ParserResult<T> in a faling verbs scenario. More...
 
class  OptionAttribute
 Models an option specification. More...
 
class  Parsed
 It contains an instance of type T with parsed values. More...
 
class  Parser
 Provides methods to parse command line arguments. More...
 
class  ParserExtensions
 Defines generic overloads for CommandLine.Parser.ParseArguments(IEnumerable<string>,Type[]) method. More...
 
class  ParserResult
 Models a parser result. When inherited by CommandLine.Parsed<T>, it contains an instance of type T with parsed values. When inherited by CommandLine.NotParsed<T>, it contains a sequence of CommandLine.Error. More...
 
class  ParserResultExtensions
 Provides convenience extension methods for CommandLine.ParserResult<T>. More...
 
class  ParserSettings
 Provides settings for CommandLine.Parser. Once consumed cannot be reused. More...
 
class  RepeatedOptionError
 Models an error generated when an option is repeated two or more times. More...
 
class  SequenceOutOfRangeError
 Models an error generated when a sequence value lacks elements. More...
 
class  SetValueExceptionError
 Models as error generated when exception is thrown at Property.SetValue. More...
 
class  TokenError
 Base type of all errors related to bad token detection. More...
 
class  TypeInfo
 
class  UnknownOptionError
 Models an error generated when an unknown option is detected. More...
 
class  UnParserExtensions
 Provides overloads to unparse options instance. More...
 
class  UnParserSettings
 Provides settings for when formatting command line from an options instance../>. More...
 
class  ValueAttribute
 Models an value specification, or better how to handle values not bound to options. More...
 
class  VerbAttribute
 Models a verb command specification. More...
 
class  VersionRequestedError
 Models an error generated when a user explicitly requests version. More...
 

Enumerations

enum  ErrorType {
  BadFormatTokenError , MissingValueOptionError , UnknownOptionError , MissingRequiredOptionError ,
  MutuallyExclusiveSetError , BadFormatConversionError , SequenceOutOfRangeError , RepeatedOptionError ,
  NoVerbSelectedError , BadVerbSelectedError , HelpRequestedError , HelpVerbRequestedError ,
  VersionRequestedError , SetValueExceptionError , InvalidAttributeConfigurationError , MissingGroupOptionError ,
  GroupOptionAmbiguityError , MultipleDefaultVerbsError
}
 Discriminator enumeration of CommandLine.Error derivates. More...
 
enum  ParserResultType { Parsed , NotParsed }
 Discriminator enumeration of CommandLine.ParserResultType derivates. More...
 

Enumeration Type Documentation

◆ ErrorType

Discriminator enumeration of CommandLine.Error derivates.

Enumerator
BadFormatTokenError 

Value of CommandLine.BadFormatTokenError type.

MissingValueOptionError 

Value of CommandLine.MissingValueOptionError type.

UnknownOptionError 

Value of CommandLine.UnknownOptionError type.

MissingRequiredOptionError 

Value of CommandLine.MissingRequiredOptionError type.

MutuallyExclusiveSetError 

Value of CommandLine.MutuallyExclusiveSetError type.

BadFormatConversionError 

Value of CommandLine.BadFormatConversionError type.

SequenceOutOfRangeError 

Value of CommandLine.SequenceOutOfRangeError type.

RepeatedOptionError 

Value of CommandLine.RepeatedOptionError type.

NoVerbSelectedError 

Value of CommandLine.NoVerbSelectedError type.

BadVerbSelectedError 

Value of CommandLine.BadVerbSelectedError type.

HelpRequestedError 

Value of CommandLine.HelpRequestedError type.

HelpVerbRequestedError 

Value of CommandLine.HelpVerbRequestedError type.

VersionRequestedError 

Value of CommandLine.VersionRequestedError type.

SetValueExceptionError 

Value of CommandLine.SetValueExceptionError type.

InvalidAttributeConfigurationError 

Value of CommandLine.InvalidAttributeConfigurationError type.

MissingGroupOptionError 

Value of CommandLine.MissingGroupOptionError type.

GroupOptionAmbiguityError 

Value of CommandLine.GroupOptionAmbiguityError type.

MultipleDefaultVerbsError 

Value of CommandLine.MultipleDefaultVerbsError type.

Definition at line 12 of file Error.cs.

13 {
18
23
28
33
38
43
48
53
58
63
68
73
78
83
88
93
98
103 }
Models an error generated when a value conversion fails.
Definition Error.cs:418
Models an error generated when an invalid token is detected.
Definition Error.cs:286
Models an error generated when an unknown verb is detected.
Definition Error.cs:445
Models an error generated when a user explicitly requests help.
Definition Error.cs:454
Models an error generated when a user explicitly requests help in verb commands scenario.
Definition Error.cs:463
Models an error generated when an invalid token is detected.
Definition Error.cs:536
Models an error generated when a required option is required.
Definition Error.cs:392
Models an error generated when an option lacks its value.
Definition Error.cs:374
Models an error generated when multiple default verbs are defined.
Definition Error.cs:605
Models an error generated when a an option from another set is defined.
Definition Error.cs:401
Models an error generated when no verb is selected.
Definition Error.cs:495
Models an error generated when an option is repeated two or more times.
Definition Error.cs:436
Models an error generated when a sequence value lacks elements.
Definition Error.cs:427
Models as error generated when exception is thrown at Property.SetValue.
Definition Error.cs:513
Models an error generated when an unknown option is detected.
Definition Error.cs:383
Models an error generated when a user explicitly requests version.
Definition Error.cs:504

◆ ParserResultType

Discriminator enumeration of CommandLine.ParserResultType derivates.

Enumerator
Parsed 

Value of CommandLine.Parsed<T> type.

NotParsed 

Value of CommandLine.NotParsed<T> type.

Definition at line 35 of file ParserResult.cs.

36 {
40 Parsed,
41
46 }
It contains a sequence of CommandLine.Error.
It contains an instance of type T with parsed values.