Collectable

interface Collectable<out T>(source)

一个可收集序列器。

Collectable 应当支持将自身(或其中实际的元素收集方式) 转化为可挂起的流(Flow)或同步序列(Sequence, see IterableCollectable)。

Collectable 不保证可以多次使用,也不建议多次调用 Collectable 中的API。 无论是对于收集还是转化,同一个实例都应仅调用其中某API的一个。 如果需要多次使用,请考虑将其转化为可安全重复使用的类型(例如 List)后再使用。

Collectable 中实际没有需要被挂起的类型时,考虑对外提供普通可迭代的收集器类型 IterableCollectable

在 JVM 中,会使用 Collectables 静态类提供更多辅助API。

Author

ForteScarlet

See also

Inheritors

Functions

Link copied to clipboard
abstract fun asFlow(): Flow<T>

将自身中的元素(或收集器)转化为 Flow

Link copied to clipboard
abstract suspend fun collect(collector: Action<T>)

挂起并收集其中的元素。

Link copied to clipboard
open fun collectAsync(scope: CoroutineScope, collector: Action<T>): Async<Unit>

异步收集其中的元素。

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

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

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

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

Inherited functions

Link copied to clipboard
fun <T : Any> Collectable<T>.asFlux(): Flux<T>

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

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

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

Link copied to clipboard

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

Link copied to clipboard
fun <T, R> Collectable<T>.collect(collector: Collector<T, *, R>): R

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

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

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

Link copied to clipboard
fun <T> Collectable<T>.toList(): List<T>

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

Link copied to clipboard

Collectable 异步地收集为 List。 如果 scopenull,则会视情况使用 GlobalScope 或使用 CompletableFuture.supplyAsync

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

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