simbot-common-core/love.forte.simbot.common.id/StringID

StringID

@Serializable(with = StringID.Serializer::class)

class StringID : ID(source)

一个使用字符串 String 作为ID值的 ID 实现。

任何 ID 类型都可以作为一个字符串类型进行序列化。如果希望通用化 ID ，无视它的具体类型而作为字符串进行序列化，参考序列化器 AsStringIDSerializer。

Types

Companion

object Companion

Serializer

object Serializer : KSerializer<StringID>

将ID视为字符串进行序列化/反序列化的序列化器。

Properties

value

val value: String

字符串ID的源值

Inherited properties

literal

val ID.literal: String

同 ID.toString, 得到 ID 的字面值。

Functions

compareTo

open operator override fun compareTo(other: ID): Int

使 StringID 与某任意类型的 ID 排序。

copy

open override fun copy(): StringID

复制一个当前ID。

equals

open operator override fun equals(other: Any?): Boolean

判断另外一个 ID 是否与当前 ID 字面值相同。

equalsExact

open override fun equalsExact(other: Any?): Boolean

判断另外一个 ID 是否与当前 ID 字面值与类型均相同。

hashCode

open override fun hashCode(): Int

ID 的源值 hashcode，等于对应的源值的 hashcode。

toString

open override fun toString(): String

ID 的 字面值 字符串。

Inherited functions

toInt

@JvmOverloads

@JvmName(name = "toInt")

inline fun ID.toInt(notNumerical: ID.() -> Int = { literal.toInt() }): Int

尝试将 this 转化为 Int。如果为 NumericalID 则直接使用 NumericalID.toInt, 否则使用 notNumerical 转化。默认会尝试使用 literal.toInt()。

toIntID

@JvmOverloads

@JvmName(name = "toIntID")

inline fun ID.toIntID(notNumerical: ID.() -> IntID = { literal.toInt().ID }): IntID

尝试将 this 转为 IntID 类型。如果不是数字ID，则会使用 notNumerical 获取结果。默认使用 String.toInt。

toIntOrNull

@JvmOverloads

@JvmName(name = "toIntOrNull")

inline fun ID.toIntOrNull(notNumerical: ID.() -> Int? = { literal.toIntOrNull() }): Int?

尝试将 this 转化为 Int。如果为 NumericalID 则直接使用 NumericalID.toInt, 否则使用 notNumerical 转化。默认会尝试使用 literal.toIntOrNull()。

toLong

@JvmOverloads

@JvmName(name = "toLong")

inline fun ID.toLong(notNumerical: ID.() -> Long = { literal.toLong() }): Long

尝试将 this 转化为 Long。如果为 NumericalID 则直接使用 NumericalID.toLong, 否则使用 notNumerical 转化。默认会尝试使用 literal.toLong()。

toLongID

@JvmOverloads

@JvmName(name = "toLongID")

inline fun ID.toLongID(notNumerical: ID.() -> LongID = { literal.toLong().ID }): LongID

尝试将 this 转为 LongID 类型。如果不是数字ID，则会使用 notNumerical 获取结果。默认使用 String.toLong。

toLongOrNull

@JvmOverloads

@JvmName(name = "toLongOrNull")

inline fun ID.toLongOrNull(notNumerical: ID.() -> Long? = { literal.toLongOrNull() }): Long?

尝试将 this 转化为 Long。如果为 NumericalID 则直接使用 NumericalID.toLong, 否则使用 notNumerical 转化。默认会尝试使用 literal.toLongOrNull()。

toUInt

@JvmOverloads

@JvmName(name = "toUInt")

inline fun ID.toUInt(notNumerical: ID.() -> UInt = { literal.toUInt() }): UInt

尝试将 this 转化为 UInt。如果为 NumericalID 则直接使用 NumericalID.toInt.toUInt, 否则使用 notNumerical 转化。默认会尝试使用 literal.toUInt()。

toUIntID

@JvmOverloads

@JvmName(name = "toUIntID")

inline fun ID.toUIntID(notNumerical: ID.() -> UIntID = { literal.toUInt().ID }): UIntID

尝试将 this 转为 UIntID 类型。如果不是数字ID，则会使用 notNumerical 获取结果。默认使用 String.toUInt。

toUIntOrNull

@JvmOverloads

@JvmName(name = "toUIntOrNull")

inline fun ID.toUIntOrNull(notNumerical: ID.() -> UInt? = { literal.toUIntOrNull() }): UInt?

尝试将 this 转化为 UInt。如果为 NumericalID 则直接使用 NumericalID.toInt.toUInt, 否则使用 notNumerical 转化。默认会尝试使用 literal.toUIntOrNull()。

toULong

@JvmOverloads

@JvmName(name = "toULong")

inline fun ID.toULong(notNumerical: ID.() -> ULong = { literal.toULong() }): ULong

尝试将 this 转化为 ULong。如果为 NumericalID 则直接使用 NumericalID.toLong.toULong, 否则使用 notNumerical 转化。默认会尝试使用 literal.toULong()。

toULongID

@JvmOverloads

@JvmName(name = "toULongID")

inline fun ID.toULongID(notNumerical: ID.() -> ULongID = { literal.toULong().ID }): ULongID

尝试将 this 转为 ULongID 类型。如果不是数字ID，则会使用 notNumerical 获取结果。默认使用 String.toULong。

toULongOrNull

@JvmOverloads

@JvmName(name = "toULongOrNull")

inline fun ID.toULongOrNull(notNumerical: ID.() -> ULong? = { literal.toULongOrNull() }): ULong?

尝试将 this 转化为 ULong。如果为 NumericalID 则直接使用 NumericalID.toLong.toULong, 否则使用 notNumerical 转化。默认会尝试使用 literal.toULongOrNull()。