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

Package-level declarations

Types

Async

expect class Async<out T>

内含异步处理操作的类。

actual class Async<out T>

Async 类在 JS 平台的具体实现。

actual class Async<out T>

Async 在 JVM 平台的具体实现。

actual class Async<out T>

Async 类在 native 平台的具体实现。

actual class Async<out T>

Async 类在 JS 平台的具体实现。

AsyncHandler

fun interface AsyncHandler

异步处理接口。

CancellationHandler

fun interface CancellationHandler

取消处理接口。

CompletionHandler

fun interface CompletionHandler<in T>

完成处理接口。

ErrorHandler

fun interface ErrorHandler

错误处理接口。

Inherited properties

onAwait

val <T> Async<T>.onAwait: SelectClause1<T>

获取一个表示此 Async 任务 await 操作的 SelectClause1。

onJoin

val Async<*>.onJoin: SelectClause0

获取一个表示此 Async 任务 join 操作的 SelectClause0。

Functions

completedAsync

fun <T> completedAsync(value: T): Async<T>

将给定的值封装为一个已完成的 Async<T> 对象。

Inherited functions

asAsync

fun <T> Deferred<T>.asAsync(): Async<T>

在 CoroutineScope 上下文中异步执行给定的 block，并返回一个可以用于获取结果、取消任务或添加任务生命周期处理器的 Async 对象。

fun <T> CompletableFuture<out T>.asAsync(): Async<T>

将一个 CompletableFuture 转化为 Async.

await

suspend fun <T> Async<T>.await(): T

在协程中等待此 Async 任务完成，并返回它的结果（如果任务成功完成）或抛出异步抛出的异常（如果任务失败）。此函数会挂起协程直到任务完成。

cancelBy

fun <T> Async<T>.cancelBy(message: String? = null, cause: Throwable?)

取消此 Async 任务，特别是将在任务中抛出一个 CancellationException 以终结任务。如果 message 或 cause 指定了，则它们将被用于创建 CancellationException。

join

suspend fun Async<*>.join()

在协程中等待此 Async 任务完成。此函数挂起协程直到任务完成，但不获取任务结果，也不处理任务失败时的异常。

toAsync

inline fun <T> CoroutineScope.toAsync(crossinline block: suspend () -> T): Async<T>

在 CoroutineScope 上下文中异步执行给定的 block，并返回一个可以用于获取结果、取消任务或添加任务生命周期处理器的 Async 对象。