Struct TypeReaderResult

Namespace

Kook.Commands

Assembly

Kook.Net.Commands.dll

表示一个类型读取器的解析结果。

public struct TypeReaderResult : IResult

Implements

IResult

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

BestMatch

获取最佳匹配的解析值。

public object? BestMatch { get; }

Property Value

object

Exceptions

InvalidOperationException

解析失败。

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

Values

获取解析的值。

public readonly IReadOnlyCollection<TypeReaderValue> Values { get; }

Property Value

IReadOnlyCollection<TypeReaderValue>

Methods

FromError(CommandError, string)

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

public static TypeReaderResult FromError(CommandError error, string reason)

Parameters

error CommandError

错误类型。

reason string

错误原因。

Returns

TypeReaderResult

一个表示解析失败的 TypeReaderResult。

FromError(IResult)

初始化一个包含指定结果的 TypeReaderResult 结构的新实例，表示一个失败的解析。

public static TypeReaderResult FromError(IResult result)

Parameters

result IResult

要包装的结果。

Returns

TypeReaderResult

一个表示解析失败的 TypeReaderResult。

FromError(Exception)

初始化一个包含指定异常的 TypeReaderResult 结构的新实例，表示一个失败的解析。

public static TypeReaderResult FromError(Exception ex)

Parameters

ex Exception

导致解析失败的异常。

Returns

TypeReaderResult

一个表示解析失败的 TypeReaderResult。

FromSuccess(TypeReaderValue)

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

public static TypeReaderResult FromSuccess(TypeReaderValue value)

Parameters

value TypeReaderValue

解析的值。

Returns

TypeReaderResult

一个表示解析成功的 TypeReaderResult。

FromSuccess(IReadOnlyCollection<TypeReaderValue>)

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

public static TypeReaderResult FromSuccess(IReadOnlyCollection<TypeReaderValue> values)

Parameters

values IReadOnlyCollection<TypeReaderValue>

解析的值。

Returns

TypeReaderResult

一个表示解析成功的 TypeReaderResult。

FromSuccess(object?)

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

public static TypeReaderResult FromSuccess(object? value)

Parameters

value object

解析的值。

Returns

TypeReaderResult

一个表示解析成功的 TypeReaderResult。

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.