Class MatchResult

Namespace

Kook.Commands

Assembly

Kook.Net.Commands.dll

表示一个命令的匹配结果。

public class MatchResult : IResult

Inheritance

object

MatchResult

Implements

IResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

Error

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

public CommandError? Error { get; }

Property Value

CommandError?

ErrorReason

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

public string? ErrorReason { get; }

Property Value

string

IsSuccess

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

public bool IsSuccess { get; }

Property Value

bool

Match

获取在命令执行期间可能与输入文本匹配的命令。

public CommandMatch? Match { get; }

Property Value

CommandMatch?

Pipeline

获取命令在执行工作流中的阶段。

public IResult? Pipeline { get; }

Property Value

IResult

Methods

FromError(CommandError, string)

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

public static MatchResult FromError(CommandError error, string reason)

Parameters

error CommandError

命令匹配失败的类型。

reason string

命令匹配失败的原因。

Returns

MatchResult

一个表示匹配失败的 MatchResult。

FromError(IResult)

初始化一个包含指定失败结果的 MatchResult 类的新实例，表示一个失败的匹配。

public static MatchResult FromError(IResult result)

Parameters

result IResult

失败的结果。

Returns

MatchResult

一个表示匹配失败的 MatchResult。

FromError(IResult, CommandError, string)

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

public static MatchResult FromError(IResult pipeline, CommandError error, string reason)

Parameters

pipeline IResult

命令执行工作流中的阶段。

error CommandError

错误类型。

reason string

错误原因。

Returns

MatchResult

一个表示匹配失败的 MatchResult。

FromError(Exception)

初始化一个包含指定异常的 MatchResult 类的新实例，表示一个失败的匹配。

public static MatchResult FromError(Exception ex)

Parameters

ex Exception

导致匹配失败的异常。

Returns

MatchResult

一个表示匹配失败的 MatchResult。

FromSuccess(CommandMatch, IResult)

初始化一个不包含任何错误的 MatchResult 类的新实例，表示一个成功的匹配。

public static MatchResult FromSuccess(CommandMatch match, IResult pipeline)

Parameters

match CommandMatch

命令匹配信息。

pipeline IResult

命令执行工作流中的阶段。

Returns

MatchResult

一个表示匹配成功的 MatchResult。

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.