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...

Inheritance diagram for CommandLine.ParserResult< T >:

Package Functions
	ParserResult (IEnumerable< Error > errors, TypeInfo typeInfo)

	ParserResult (T value, TypeInfo typeInfo)

Properties
ParserResultType	Tag `[get]`
	Parser result type discriminator, defined as CommandLine.ParserResultType enumeration.

TypeInfo	TypeInfo `[get]`

T	Value `[get]`
	Gets the instance with parsed values. If one or more errors occures, `default` is returned.

IEnumerable< Error >	Errors `[get]`
	Gets the sequence of parsing errors. If there are no errors, then an empty IEnumerable is returned.

Detailed Description

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.

Template Parameters

T	The type with attributes that define the syntax of parsing rules.

Definition at line 56 of file ParserResult.cs.

Constructor & Destructor Documentation

◆ ParserResult() [1/2]

CommandLine.ParserResult< T >.ParserResult	(	IEnumerable< Error >	errors,
		TypeInfo	typeInfo
	)

package

Definition at line 58 of file ParserResult.cs.

        {
            Tag = ParserResultType.NotParsed;
            TypeInfo = typeInfo ?? TypeInfo.Create(typeof(T));
            Errors = errors ?? new Error[0];
            Value = default;
        }

◆ ParserResult() [2/2]

CommandLine.ParserResult< T >.ParserResult	(	T	value,
		TypeInfo	typeInfo
	)

package

Definition at line 66 of file ParserResult.cs.

        {
            Value = value ?? throw new ArgumentNullException(nameof(value));
            Tag = ParserResultType.Parsed;
            TypeInfo = typeInfo ?? TypeInfo.Create(value.GetType());
            Errors = new Error[0];
        }

Property Documentation

◆ Errors

IEnumerable<Error> CommandLine.ParserResult< T >.Errors

get

Gets the sequence of parsing errors. If there are no errors, then an empty IEnumerable is returned.

Definition at line 89 of file ParserResult.cs.

89{ get; }

◆ Tag

ParserResultType CommandLine.ParserResult< T >.Tag

get

Parser result type discriminator, defined as CommandLine.ParserResultType enumeration.

Definition at line 77 of file ParserResult.cs.

77{ get; }

◆ TypeInfo

TypeInfo CommandLine.ParserResult< T >.TypeInfo

get

Definition at line 79 of file ParserResult.cs.

79{ get; }

◆ Value

T CommandLine.ParserResult< T >.Value

get

Gets the instance with parsed values. If one or more errors occures, default is returned.

Definition at line 84 of file ParserResult.cs.

84{ get; }

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

deps/commandlineparser/src/CommandLine/ParserResult.cs

Package Functions

Properties