Struct ExecuteResult

Namespace

HeyBox.Interactions

Assembly

HeyBox.Net.Interactions.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

获取操作过程中可能发生的错误类型。

public readonly InteractionCommandError? Error { get; }

Property Value

InteractionCommandError?

一个 InteractionCommandError，指示操作过程中可能发生的错误类型； 如果操作成功，则为 null。

ErrorReason

获取错误原因。

public readonly string? ErrorReason { get; }

Property Value

string

包含错误原因的字符串。

Exception

获取命令执行过程中可能发生的异常。

public readonly Exception? Exception { get; }

Property Value

Exception

IsSuccess

指示操作是否成功。

public bool IsSuccess { get; }

Property Value

bool

如果结果为正，则为 true；否则为 false。

Methods

FromError(IResult)

用指定的结果初始化一个新的 ExecuteResult；这可能是成功的执行，也可能不是， 具体取决于 Error 和 ErrorReason 的值。

public static ExecuteResult FromError(IResult result)

Parameters

result IResult

要继承的结果。

Returns

ExecuteResult

一个继承了 IResult 错误类型和原因的 ExecuteResult。

FromError(InteractionCommandError, string)

用指定的 InteractionCommandError 及其原因初始化一个新的 ExecuteResult， 表示执行不成功。

public static ExecuteResult FromError(InteractionCommandError commandError, string reason)

Parameters

commandError InteractionCommandError

错误类型。

reason string

错误原因。

Returns

ExecuteResult

一个包含 InteractionCommandError 和原因的 ExecuteResult。

FromError(Exception)

用指定的异常初始化一个新的 ExecuteResult，表示执行不成功。

public static ExecuteResult FromError(Exception exception)

Parameters

exception Exception

导致命令执行失败的异常。

Returns

ExecuteResult

一个包含导致执行不成功的异常的 ExecuteResult，以及类型为 Exception 的 InteractionCommandError 和异常消息作为原因。

FromSuccess()

初始化一个新的 ExecuteResult，没有错误，表示执行成功。

public static ExecuteResult FromSuccess()

Returns

ExecuteResult

一个不包含任何错误的 ExecuteResult。

ToString()

获取指示执行结果的字符串。

public override string ToString()

Returns

string

如果 IsSuccess 为 true，则为 Success；否则为 "Error: ErrorReason"。