Skip to main content

Struct ParseResult

Contains information for the parsing result from the command service's parser.

Assembly: Discord.Net.Commands.dll​
View Source​
Declaration
public struct ParseResult : IResult

Properties​

ArgValues​

View Source​
Declaration
public readonly IReadOnlyList<TypeReaderResult> ArgValues { get; }

ParamValues​

View Source​
Declaration
public readonly IReadOnlyList<TypeReaderResult> ParamValues { get; }

Error​

Describes the error type that may have occurred during the operation.

View Source​
Declaration
public readonly CommandError? Error { get; }

ErrorReason​

Describes the reason for the error.

View Source​
Declaration
public readonly string ErrorReason { get; }

ErrorParameter​

Provides information about the parameter that caused the parsing error.

View Source​
Declaration
public readonly ParameterInfo ErrorParameter { get; }

IsSuccess​

Indicates whether the operation was successful or not.

View Source​
Declaration
public readonly bool IsSuccess { get; }

Methods​

FromSuccess(IReadOnlyList<TypeReaderResult>, IReadOnlyList<TypeReaderResult>)​

View Source​
Declaration
public static ParseResult FromSuccess(IReadOnlyList<TypeReaderResult> argValues, IReadOnlyList<TypeReaderResult> paramValues)
Returns​

Discord.Commands.ParseResult

Parameters​
TypeName
System.Collections.Generic.IReadOnlyList<Discord.Commands.TypeReaderResult>argValues
System.Collections.Generic.IReadOnlyList<Discord.Commands.TypeReaderResult>paramValues

FromSuccess(IReadOnlyList<TypeReaderValue>, IReadOnlyList<TypeReaderValue>)​

View Source​
Declaration
public static ParseResult FromSuccess(IReadOnlyList<TypeReaderValue> argValues, IReadOnlyList<TypeReaderValue> paramValues)
Returns​

Discord.Commands.ParseResult

Parameters​
TypeName
System.Collections.Generic.IReadOnlyList<Discord.Commands.TypeReaderValue>argValues
System.Collections.Generic.IReadOnlyList<Discord.Commands.TypeReaderValue>paramValues

FromError(CommandError, String)​

View Source​
Declaration
public static ParseResult FromError(CommandError error, string reason)
Returns​

Discord.Commands.ParseResult

Parameters​
TypeName
Discord.Commands.CommandErrorerror
System.Stringreason

FromError(CommandError, String, ParameterInfo)​

View Source​
Declaration
public static ParseResult FromError(CommandError error, string reason, ParameterInfo parameterInfo)
Returns​

Discord.Commands.ParseResult

Parameters​
TypeName
Discord.Commands.CommandErrorerror
System.Stringreason
Discord.Commands.ParameterInfoparameterInfo

FromError(Exception)​

View Source​
Declaration
public static ParseResult FromError(Exception ex)
Returns​

Discord.Commands.ParseResult

Parameters​
TypeName
System.Exceptionex

FromError(IResult)​

View Source​
Declaration
public static ParseResult FromError(IResult result)
Returns​

Discord.Commands.ParseResult

Parameters​
TypeName
Discord.Commands.IResultresult

FromError(IResult, ParameterInfo)​

View Source​
Declaration
public static ParseResult FromError(IResult result, ParameterInfo parameterInfo)
Returns​

Discord.Commands.ParseResult

Parameters​
TypeName
Discord.Commands.IResultresult
Discord.Commands.ParameterInfoparameterInfo

ToString()​

View Source​
Declaration
public override string ToString()
Returns​

System.String

Implements​