Table of Contents

Struct ParseResult

Namespace
Kook.Commands
Assembly
Kook.Net.Commands.dll

表示一个命令的解析结果。

public struct ParseResult : IResult
Implements
Inherited Members

Properties

ArgValues

获取所有实参解析结果。

public readonly IReadOnlyList<TypeReaderResult> ArgValues { get; }

Property Value

IReadOnlyList<TypeReaderResult>

Error

获取在命令执行期间发生的异常信息,如果没有异常则为 null

public readonly CommandError? Error { get; }

Property Value

CommandError?

ErrorParameter

获取在解析过程中导致解析错误的参数信息。

public readonly ParameterInfo? ErrorParameter { get; }

Property Value

ParameterInfo

ErrorReason

获取在命令执行期间发生的异常的原因,如果没有异常则为 null

public readonly string? ErrorReason { get; }

Property Value

string

IsSuccess

获取命令执行的结果是否为成功。

public bool IsSuccess { get; }

Property Value

bool

ParamValues

获取所有形参解析结果。

public readonly IReadOnlyList<TypeReaderResult> ParamValues { get; }

Property Value

IReadOnlyList<TypeReaderResult>

Methods

FromError(CommandError, string)

初始化一个包含指定错误类型和原因的 ParseResult 结构的新实例,表示一个失败的匹配。

public static ParseResult FromError(CommandError error, string reason)

Parameters

error CommandError

命令匹配失败的类型。

reason string

参数解析失败的原因。

Returns

ParseResult

一个表示解析失败的 ParseResult

FromError(CommandError, string, ParameterInfo)

初始化一个包含指定错误类型和原因的 ParseResult 结构的新实例,表示一个失败的匹配。

public static ParseResult FromError(CommandError error, string reason, ParameterInfo parameterInfo)

Parameters

error CommandError

命令匹配失败的类型。

reason string

参数解析失败的原因。

parameterInfo ParameterInfo

导致解析失败的参数信息。

Returns

ParseResult

一个表示解析失败的 ParseResult

FromError(IResult)

初始化一个包含指定异常的 ParseResult 结构的新实例,表示一个失败的匹配。

public static ParseResult FromError(IResult result)

Parameters

result IResult

失败的结果。

Returns

ParseResult

一个表示匹配失败的 MatchResult

FromError(IResult, ParameterInfo)

初始化一个包含指定异常的 ParseResult 结构的新实例,表示一个失败的匹配。

public static ParseResult FromError(IResult result, ParameterInfo parameterInfo)

Parameters

result IResult

失败的结果。

parameterInfo ParameterInfo

导致解析失败的参数信息。

Returns

ParseResult

一个表示匹配失败的 MatchResult

FromError(Exception)

初始化一个包含指定异常的 ParseResult 结构的新实例,表示一个失败的匹配。

public static ParseResult FromError(Exception ex)

Parameters

ex Exception

导致匹配失败的异常。

Returns

ParseResult

一个表示匹配失败的 MatchResult

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

初始化一个不包含任何错误的 ParseResult 结构的新实例,表示一个成功的解析。

public static ParseResult FromSuccess(IReadOnlyList<TypeReaderResult> argValues, IReadOnlyList<TypeReaderResult> paramValues)

Parameters

argValues IReadOnlyList<TypeReaderResult>

实参解析结果。

paramValues IReadOnlyList<TypeReaderResult>

形参解析结果。

Returns

ParseResult

一个表示匹配成功的 ParseResult

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

初始化一个不包含任何错误的 ParseResult 结构的新实例,表示一个成功的解析。

public static ParseResult FromSuccess(IReadOnlyList<TypeReaderValue> argValues, IReadOnlyList<TypeReaderValue> paramValues)

Parameters

argValues IReadOnlyList<TypeReaderValue>

实参解析结果。

paramValues IReadOnlyList<TypeReaderValue>

形参解析结果。

Returns

ParseResult

一个表示匹配成功的 ParseResult

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.