simbot-api/love.forte.simbot.utils

Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract class CyclicIterator<T> : Iterator<T>

无限循环的环形迭代器。CyclicIterator 将会永远拥有结果。

open class DefaultBlockingDispatcherTaskRejectedExecutionException(val runnable: Runnable, val executor: Executor) : RejectedExecutionException

对 RejectedExecutionException 的扩展, 当 DefaultBlockingDispatcher 将会在追加任务被拒绝时抛出此异常并携带 runnable 和 executor 信息供于外部用户捕获并处理.

Link copied to clipboard
typealias Digest = MessageDigest
Link copied to clipboard
interface LazyValue<T> : SuspendFunction0<T>

一个类似于 Deferred 的支持suspend的懒加载器。

Link copied to clipboard
object RandomIDUtil

一般为内部使用的随机ID工具。

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class WeakMap<K, V>(delegateMap: MutableMap<K, WeakReference<V>>) : MutableMap<K, V>

Value值为 weak 的 Map。

Functions

Link copied to clipboard
Link copied to clipboard
fun <T> completedLazyValue(value: T): LazyValue<T>
Link copied to clipboard
fun <T> constIterator(value: T): Iterator<T>
Link copied to clipboard
fun digest(algorithm: String): Digest

根据一个算法名称得到一个对应的信息摘要算法.

inline fun digest(algorithm: String, block: Digest.() -> Unit): ByteArray

根据一个算法名称得到一个对应的信息摘要算法, 并在 block 中使用它, 然后得到摘要结果。

Link copied to clipboard
Link copied to clipboard
fun <T> indexedCycleIterator(lastIndex: Int, valueGet: (Int) -> T): Iterator<T>
Link copied to clipboard
fun <T> lazyValue(initializer: suspend () -> T): LazyValue<T>
fun <T> CoroutineScope.lazyValue(init: Boolean = false, initializer: suspend () -> T): LazyValue<T>
Link copied to clipboard
inline fun md5(block: Digest.() -> Unit): ByteArray

尝试获取 md5 摘要算法，并使用它得到摘要结果。

Link copied to clipboard
fun randomIdStr(random: Random = Random): String
Link copied to clipboard
@InternalSimbotApi
fun <T> runInAsync(block: suspend CoroutineScope.() -> T): CompletableFuture<T>
@InternalSimbotApi
fun <T> runInAsync(scope: CoroutineScope, context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): CompletableFuture<T>

执行一个异步函数，得到 CompletableFuture.

Link copied to clipboard
fun <T> runInBlocking(context: CoroutineContext = DefaultBlockingContext, block: suspend CoroutineScope.() -> T): T

在simbot中提供的 runBlocking 包装。

Link copied to clipboard
fun <T> runInNoScopeBlocking(context: CoroutineContext = DefaultBlockingContext, block: suspend () -> T): T

在simbot中提供的 runBlocking 包装。

Link copied to clipboard
fun <T> runInNoScopeTimeoutBlocking(timeout: Long, context: CoroutineContext = DefaultBlockingContext, block: suspend () -> T): T

如果超时，则抛出 TimeoutException.

Link copied to clipboard
fun <T> runInTimeoutBlocking(timeout: Long, context: CoroutineContext = DefaultBlockingContext, block: suspend CoroutineScope.() -> T): T

如果超时，则抛出 TimeoutException.

Link copied to clipboard
inline suspend fun <T> runWithInterruptible(context: CoroutineContext = RunWithInterruptibleDefaultCoroutineContext, crossinline block: () -> T): T

默认使用 DefaultBlockingDispatcher 作为调度器的可中断执行函数。

Link copied to clipboard
@ExperimentalSimbotApi
fun setRunInBlockingStrategy(strategy: RunInBlockingStrategy)

设置一个 runInBlocking 函数的实际调度逻辑。

Link copied to clipboard
Link copied to clipboard
@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <T1, T2> suspendConsumer(isRunWithInterruptible: Boolean = true, function: BiConsumer<T1, T2>): suspend (T1, T2) -> Unit
@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <T1, T2, T3> suspendConsumer(isRunWithInterruptible: Boolean = true, function: Consumer3<T1, T2, T3>): suspend (T1, T2, T3) -> Unit
@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <T1, T2, T3, T4> suspendConsumer(isRunWithInterruptible: Boolean = true, function: Consumer4<T1, T2, T3, T4>): suspend (T1, T2, T3, T4) -> Unit
@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <T1, T2, T3, T4, T5> suspendConsumer(isRunWithInterruptible: Boolean = true, function: Consumer5<T1, T2, T3, T4, T5>): suspend (T1, T2, T3, T4, T5) -> Unit

@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <T> suspendConsumer(isRunWithInterruptible: Boolean = true, function: Consumer<T>): suspend (T) -> Unit

Kotlin api:

Link copied to clipboard
@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <T1, T2, R> suspendFunction(isRunWithInterruptible: Boolean = true, function: BiFunction<T1, T2, R>): suspend (T1, T2) -> R
@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <T1, T2, T3, R> suspendFunction(isRunWithInterruptible: Boolean = true, function: (T1, T2, T3) -> R): suspend (T1, T2, T3) -> R
@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <T1, T2, T3, T4, R> suspendFunction(isRunWithInterruptible: Boolean = true, function: (T1, T2, T3, T4) -> R): suspend (T1, T2, T3, T4) -> R
@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <T1, T2, T3, T4, T5, R> suspendFunction(isRunWithInterruptible: Boolean = true, function: (T1, T2, T3, T4, T5) -> R): suspend (T1, T2, T3, T4, T5) -> R

@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <T, R> suspendFunction(isRunWithInterruptible: Boolean = true, function: Function<T, R>): suspend (T) -> R

Kotlin api:

Link copied to clipboard
@JvmOverloads
@Api4J
@ExperimentalSimbotApi
fun <R> suspendSupplier(isRunWithInterruptible: Boolean = true, function: Supplier<R>): suspend () -> R

Kotlin api:

Link copied to clipboard
fun systemProperties(key: String): String?

获取系统参数。

Link copied to clipboard
fun ByteArray.toHex(): String

将一个 ByteArray 转为16进制的字符串。

fun String.toHex(): ByteArray

将一个16进制的字符串转化为字节数组。

Properties

Link copied to clipboard
@InternalSimbotApi
val DefaultAsyncContext: CoroutineContext

默认的异步调用（Java异步，例如 CompletableFuture 或 runInAsync）上下文。

Link copied to clipboard
@InternalSimbotApi
val DefaultAsyncDispatcher: CoroutineDispatcher

如果 DefaultAsyncDispatcherOrNull 为 null，得到 Dispatchers.Default, 否则得到 DefaultAsyncDispatcherOrNull的值。

Link copied to clipboard
@InternalSimbotApi
val DefaultAsyncDispatcherOrNull: CoroutineDispatcher?

使用在非协程环境下的异步API（例如 runInAsync ）中的默认调度器。 会在首次被获取的时候进行实例化。

Link copied to clipboard
@InternalSimbotApi
val DefaultBlockingContext: CoroutineContext

在 runInBlocking 中使用的默认上下文实例。

Link copied to clipboard
@InternalSimbotApi
val DefaultBlockingDispatcher: CoroutineDispatcher

如果 DefaultBlockingDispatcherOrNull 为 null，得到 Dispatchers.Default, 否则得到 DefaultBlockingDispatcherOrNull的值。

Link copied to clipboard
@InternalSimbotApi
val DefaultBlockingDispatcherOrNull: CoroutineDispatcher?

使用在阻塞API（例如 runInBlocking ）或非Java协程环境中的默认调度器。 会在首次被获取的时候进行实例化。