Struct ExecuteResult

Namespace

Kook.Commands

Assembly

Kook.Net.Commands.dll

表示一个命令的整体执行结果的信息。

public struct ExecuteResult : IResult

Implements

IResult

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Error

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

public readonly CommandError? Error { get; }

Property Value

CommandError?

ErrorReason

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

public readonly string? ErrorReason { get; }

Property Value

string

Exception

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

public readonly Exception? Exception { get; }

Property Value

Exception

IsSuccess

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

public bool IsSuccess { get; }

Property Value

bool

Methods

FromError(CommandError, string)

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

public static ExecuteResult FromError(CommandError error, string reason)

Parameters

error CommandError

错误类型。

reason string

错误原因。

Returns

ExecuteResult

一个表示执行失败的 ExecuteResult。

FromError(IResult)

初始化一个包含指定结果的 ExecuteResult 结构的新实例，根据指定的 Error 和 ErrorReason，这可能是一个成功的执行，也可能是一个失败的执行。

public static ExecuteResult FromError(IResult result)

Parameters

result IResult

要包装的结果。

Returns

ExecuteResult

一个表示执行结果的 ExecuteResult，错误类型和原因与 result 相同。

FromError(Exception?)

初始化一个包含指定异常的 ExecuteResult 结构的新实例，表示一个失败的执行。

public static ExecuteResult FromError(Exception? ex)

Parameters

ex Exception

导致执行失败的异常。

Returns

ExecuteResult

一个包含导致执行失败的异常的 ExecuteResult，其错误类型为 Exception，原因为异常消息。

FromSuccess()

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

public static ExecuteResult FromSuccess()

Returns

ExecuteResult

一个表示执行成功的 ExecuteResult。

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.