simbot-common-core/love.forte.simbot.common.collectable/SynchronouslyIterateCollectable

SynchronouslyIterateCollectable

interface SynchronouslyIterateCollectable<out T> : Collectable<T> , Iterable<T> (source)

SynchronouslyIterateCollectable 包含迭代、收集和异步收集元素的相关方法。它是 Collectable 接口的一个具体化，为我们提供了对可同步迭代集合元素进行操作的能力。类型参数 T 定义了集合元素的类型。

注意：此接口下的方法有一些是不支持挂起的，如果你希望使用协程处理集合中的元素，可以使用 asFlow 方法将集合转化为Flow对象

Inheritors

IterableCollectable

SequenceCollectable

FlowSynchronouslyIterateCollectable

Functions

open suspend override fun collect(collector: Action<T>)

收集当前元素。等同于 forEach，无实际的挂起行为。

open override fun collectAsync(scope: CoroutineScope, collector: Action<T>): Async<Unit>

异步收集其中的元素。

abstract fun forEach(action: Action<T>)

普通地迭代当前收集器中的元素。

abstract fun toList(): List<T>

转化或收集为一个 List。

Inherited functions

@JvmName(name = "valueOf")

fun <T> Iterable<T>.asCollectable(): IterableCollectable<T>

将 Iterable 转换为 IterableCollectable 的函数.

abstract fun asFlow(): Flow<T>

将自身中的元素（或收集器）转化为 Flow。

fun <T : Any> Collectable<T>.asFlux(): Flux<T>

将 Collectable 转化为 Flux。需要环境中存在 kotlinx-coroutines-reactor 依赖。

fun <T> Collectable<T>.asStream(produceScope: CoroutineScope? = null): Stream<T>

将一个 Collectable 转化为 Stream。如果是 IterableCollectable 或 SequenceCollectable，则会使用它们的 asSequence 进行转化，否则会使用 Collectable 中合适的方法进行适当的阻塞转化。

asSynchronouslyIterateCollectable

fun <T> Collectable<T>.asSynchronouslyIterateCollectable(produceScope: CoroutineScope): SynchronouslyIterateCollectable<T>

将一个 Collectable 转化为可以提供同步迭代能力的迭代器 SynchronouslyIterateCollectable。

fun <T, R> Collectable<T>.collect(collector: Collector<T, *, R>): R

使用 Collector 阻塞地收集 Collectable 中的元素。

fun <T, R> Collectable<T>.collectAsync(scope: CoroutineScope? = null, collector: Collector<T, *, R>): CompletableFuture<R>

使用 Collector 异步地收集 Collectable 中的元素。如果 scope 为 null，则会视情况使用 GlobalScope 或使用 CompletableFuture.supplyAsync。

abstract operator fun iterator(): Iterator<T>

fun <T> Collectable<T>.toList(): List<T>

将 Collectable 阻塞地收集为 List。会根据类型适当地优化与避免阻塞挂起操作。

fun <T> Collectable<T>.toListAsync(scope: CoroutineScope? = null): CompletableFuture<List<T>>

将 Collectable 异步地收集为 List。如果 scope 为 null，则会视情况使用 GlobalScope 或使用 CompletableFuture.supplyAsync。

open fun <R> transform(transformer: SuspendReserve.Transformer<Flow<T>, R>): R

使用 SuspendReserve.Transformer 对 flow 的值进行转化处理。更多说明参考全量参数的重载函数。

open fun <R> transform(scope: CoroutineScope, context: CoroutineContext, transformer: SuspendReserve.Transformer<Flow<T>, R>): R

使用 SuspendReserve.Transformer 对 flow 的值进行转化处理。例如在 JVM 中，可以使用 SuspendReserves.flux() 转化为 reactor.core.publisher.Flux 或使用 SuspendReserves.list() 转化为 List。

fun <T, R> Collectable<T>.~~transform~~(scope: CoroutineScope = GlobalScope, transformer: SuspendReserve.Transformer<Flow<T>, R>): R

使用 SuspendReserve.Transformer 对 Collectable.asFlow 的结果进行转化，例如可以使用 SuspendReserves.flux() 转化为 Flux 或 SuspendReserves.list() 转化为 List。注意：部分转化器可能会要求运行时存在一些依赖，请注意参考它们的注释与说明。