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

Package-level declarations

Types

AsStringIDSerializer

object AsStringIDSerializer : KSerializer<ID>

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

@Serializable(with = AsStringIDSerializer::class)

sealed class ID : Comparable<ID>

ID 是用于表示 唯一标识 的不可变类值类型。

ID4J

annotation class ID4J

一个设计为仅供 Java 用户使用的API

IDContainer

interface IDContainer

一个拥有 ID 属性的“ID容器”。

IntID

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

class IntID : SignedNumericID

一个通过 32位整型 (Int) 作为ID值的 NumericalID 实现。

LongID

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

class LongID : SignedNumericID

一个通过 64位整型 (Long) 作为ID值的 NumericalID 实现。

NumericalID

sealed class NumericalID : ID

通过一个数字作为ID值的 ID 实现。主要有2个子抽象类型：

SignedNumericID

sealed class SignedNumericID : NumericalID

通过一个有符号数字作为ID值的 NumericalID 实现。

StringID

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

class StringID : ID

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

UIntID

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

class UIntID : UnsignedNumericID

一个通过 32位无符号整型 (unsigned int) 作为ID值的 NumericalID 实现。

ULongID

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

class ULongID : UnsignedNumericID

一个通过 64位无符号整型 (unsigned long) 作为ID值的 NumericalID 实现。

UnsignedNumericID

sealed class UnsignedNumericID : NumericalID

通过一个无符号数字作为ID值的 NumericalID 实现。

UUID

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

class UUID : ID

一个不可变的 "universally unique identifier" (UUID) 。

Inherited properties

@ExperimentalUuidApi

@get:JvmName(name = "uuid")

val Uuid.ID: UUID

通过一个 kotlin.uuid.Uuid 构建 UUID.

javaUUID

val UUID.javaUUID: UUID

将 UUID 转化为 Java UUID。

literal

val ID.literal: String

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

simbotUUID

val UUID.simbotUUID: UUID

将 Java UUID 转化为 UUID。

Functions

intIDOf

@JvmName(name = "of")

@ID4J

fun intIDOf(value: Int): IntID

longIDOf

@JvmName(name = "of")

@ID4J

fun longIDOf(value: Long): LongID

randomUUID

fun ~~randomUUID~~(random: Random): UUID

通过 java.util.Random 构建随机的 UUID。

stringIDOf

@JvmName(name = "of")

@ID4J

fun stringIDOf(value: CharSequence): StringID

@JvmName(name = "of")

@ID4J

fun stringIDOf(value: String): StringID

uIntIDOf

@JvmName(name = "ofUInt")

@ID4J

fun uIntIDOf(value: String): UIntID

@JvmName(name = "ofUInt")

@ID4J

fun uIntIDOf(value: UInt): UIntID

uLongIDOf

@JvmName(name = "ofULong")

fun uLongIDOf(value: ULong): ULongID

构建一个 ULongID.

@JvmName(name = "ofULong")

@ID4J

fun uLongIDOf(value: String): ULongID

uuidOf

@JvmName(name = "uuid")

@ID4J

fun uuidOf(javaRandom: Random?): UUID

使用 java.util.Random 得到一个随机的 UUID。

@JvmName(name = "uuid")

@ID4J

fun uuidOf(javaUuid: UUID): UUID

将 java.util.UUID 转化为 UUID。

@JvmName(name = "uuid")

@JvmOverloads

@ID4J

fun uuidOf(random: Random? = null): UUID

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()。

toJava

@ID4J

fun UUID.toJava(): UUID

将 UUID 转化为 java.util.UUID。

toKotlin

@ExperimentalUuidApi

fun UUID.toKotlin(): Uuid

将一个 UUID 转化为 kotlin.uuid.Uuid .

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()。

toUUIDSigs

inline fun <T> String.toUUIDSigs(block: (most: Long, least: Long) -> T): T

尝试将字符串解析为UUID的高低64位整型。