Struct SearchResult

Namespace

Kook.Commands

Assembly

Kook.Net.Commands.dll

表示一个命令搜索的结果。

public struct SearchResult : IResult

Implements

IResult

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Commands

获取所有搜索到的命令。

public readonly IReadOnlyList<CommandMatch> Commands { get; }

Property Value

IReadOnlyList<CommandMatch>

Error

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

public readonly CommandError? Error { get; }

Property Value

CommandError?

ErrorReason

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

public readonly string? ErrorReason { get; }

Property Value

string

IsSuccess

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

public bool IsSuccess { get; }

Property Value

bool

Text

获取用于搜索的文本。

public readonly string? Text { get; }

Property Value

string

Methods

FromError(CommandError, string)

初始化一个包含指定错误类型和原因的 SearchResult 结构的新实例，表示一个失败的搜索。

public static SearchResult FromError(CommandError error, string reason)

Parameters

error CommandError

搜索失败的类型。

reason string

搜索失败的原因。

Returns

SearchResult

一个表示搜索失败的 SearchResult。

FromError(IResult)

初始化一个包含指定结果的 SearchResult 结构的新实例，表示一个失败的搜索。

public static SearchResult FromError(IResult result)

Parameters

result IResult

失败的结果。

Returns

SearchResult

一个表示搜索失败的 SearchResult。

FromError(Exception)

初始化一个包含指定异常的 SearchResult 结构的新实例，表示一个失败的搜索。

public static SearchResult FromError(Exception ex)

Parameters

ex Exception

导致搜索失败的异常。

Returns

SearchResult

一个表示搜索失败的 SearchResult。

FromSuccess(string, IReadOnlyList<CommandMatch>)

初始化一个不包含任何错误的 SearchResult 结构的新实例，表示一个成功的搜索。

public static SearchResult FromSuccess(string text, IReadOnlyList<CommandMatch> commands)

Parameters

text string

用于搜索的文本。

commands IReadOnlyList<CommandMatch>

搜索到的命令。

Returns

SearchResult

一个表示搜索成功的 SearchResult。

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.