simbot-api/love.forte.simbot.utils.item/FlowItems

FlowItems

class FlowItems<T>(produceScope: CoroutineScope, flowFactory: (Items.PreprocessingProperties) -> Flow<T>) : BaseItems<T, FlowItems<T>> (source)

使用 Flow 实现 Items 的基本约定。

需要提供一个 produceScope 来作为当 flow 转化为 ChannelIterator 时的作用域。

Author

ForteScarlet

Constructors

FlowItems

constructor(produceScope: CoroutineScope, flowFactory: (Items.PreprocessingProperties) -> Flow<T>)

Properties

batch

protected var batch: Int

limit

protected var limit: Int

offset

protected var offset: Int

preprocessingProperties

protected open val preprocessingProperties: Items.PreprocessingProperties

根据预处理参数构建得到 Items.PreprocessingProperties 实例。

self

protected open override val self: FlowItems<T>

得到作为泛型类型 I 的实例。

Functions

asFlow

open override fun asFlow(): Flow<T>

将当前元素序列转化为 Flow.

asSequence

open override fun asSequence(): Sequence<T>

将当前元素序列转化为 Sequence.

asStream

@Api4J

open override fun asStream(): Stream<out T>

将当前元素序列转化为 Stream.

batch

open override fun batch(size: Int): FlowItems<T>

批次数量。如果支持批次获取的话，则每批次获取 size 的数。通常 size 0 时有效。

collect

open suspend override fun collect(collector: suspend (T) -> Unit)

收集当前数据序列中的元素. collectTo 可能会产生挂起，会直到当前序列中的所有可能产生的元素收集完毕后结束挂起。

@Api4J

open fun collect(collector: Consumer<in T>)

阻塞地收集当前序列中的元素。

collectAsync

@Api4J

open override fun collectAsync(collector: Consumer<in T>): CompletableFuture<Unit>

异步地收集当前序列中的元素。

collectTo

@Api4J

open fun <C : MutableCollection<in T>> collectTo(collector: C): C

阻塞地收集当前序列中的元素到目标 collector 中。

collectToAsync

@Api4J

open override fun <C : MutableCollection<in T>> collectToAsync(collector: C): CompletableFuture<out C>

异步的将内容元素收集到 collector 中。

collectToList

@Api4J

open fun collectToList(): List<T>

阻塞的收集当前序列中的元素到列表中。

collectToListAsync

@Api4J

open fun collectToListAsync(): CompletableFuture<out List<T>>

异步收集当前序列中的元素到列表中。

limit

open override fun limit(count: Int): FlowItems<T>

数据限流。取得的数据条数的最大上限。当 count< 0 时无效。

map

inline fun <B, T> Items<B>.map(crossinline transform: suspend (B) -> T): Items<T>

转化一个 Items 中的元素类型并得到新的 Items 实例。

offset

open override fun offset(count: Int): FlowItems<T>

数据偏移。从 count 数量之后的数据后开始获取。当 count< 0 时无效。

toCollection

inline suspend fun <T, C : MutableCollection<T>> Items<T>.toCollection(collection: C): C

将 Items 中的元素收集为目标集合 C.

toList

inline suspend fun <T> Items<T>.toList(): List<T>

将 Items 中的元素收集为 List.

transform

fun <B, T> Items<B>.transform(transform: suspend (B) -> T): Items<T>

转化一个 Items 中的元素类型并得到新的 Items 实例。

transformBlocking

@JvmStatic

@JvmName(name = "transform")

fun <B, T> Items<B>.transformBlocking(transform: (B) -> T): Items<T>

转化一个 Items 中的元素类型并得到新的 Items 实例。

withLimiter

fun <T> Items<T>.withLimiter(limiter: Limiter): Items<T>

通过 Limiter 对 Items 的预处理参数进行处理。