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

Package-level declarations

Types

BaseItems

abstract class BaseItems<out T, out I : BaseItems<T, I>> : Items<T>

Items 的基础抽象类。

CollectionItems

class CollectionItems<T>(collection: Collection<T>) : BaseItems<T, CollectionItems<T>>

使用 List 作为数据来源实现 Items 的基础约定。

FlowItems

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

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

Items

interface Items<out T>

Items 是一个数据预处理序列，类似于 java.util.stream.Stream 或 kotlinx.coroutines.flow.Flow，但是不完全相同。

SequenceItems

class SequenceItems<T>(sequenceFactory: (Items.PreprocessingProperties) -> Sequence<T>) : BaseItems<T, SequenceItems<T>>

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

SimpleChannelIteratorItems

class SimpleChannelIteratorItems<out T>(channelIteratorFactory: (Items.PreprocessingProperties) -> ChannelIterator<T>) : BaseItems<T, SimpleChannelIteratorItems<T>>

Items 的基础实现，通过一个构建 ChannelIterator 的函数实现 Items 约定的功能。

SimpleIteratorItems

class SimpleIteratorItems<out T>(iteratorFactory: (Items.PreprocessingProperties) -> Iterator<T>) : BaseItems<T, SimpleIteratorItems<T>>

Items 的基础阻塞实现，通过提供 Iterator 的工厂函数实现 Items 的基本约定。

SingleValueItems

class SingleValueItems<T>(value: T) : Items<T>

只有一个元素的 Items 实例。

StreamItems

@Api4J

class StreamItems<T> : BaseItems<T, StreamItems<T>>

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

TransformItems

class TransformItems<B, T>(baseItems: Items<B>, transform: suspend (B) -> T) : Items<T>

允许为一个 Items 提供一个转化函数的 Items 代理实现。

Functions

effectedFlow

fun <E> Items.PreprocessingProperties.effectedFlow(block: suspend FlowCollector<E>.() -> Unit): Flow<E>

构建一个flow，并将当前 Items.PreprocessingProperties 作用于最终的 Flow 中。

effectedFlowItems

inline fun <T> CoroutineScope.effectedFlowItems(crossinline block: suspend FlowCollector<T>.() -> Unit): Items<T>

以构建 Flow 的方式构建 Items.

effectedItemsByFlow

inline fun <T> CoroutineScope.effectedItemsByFlow(crossinline flowFactory: () -> Flow<T>): Items<T>

提供 CoroutineScope 和构建 Flow 的函数 flowFactory 来构建 Items.

effectedItemsBySequence

inline fun <T> effectedItemsBySequence(crossinline sequenceFactory: () -> Sequence<T>): Items<T>

提供构建 Sequence 的函数 sequenceFactory 来构建 Items.

effectedSequence

fun <E> Items.PreprocessingProperties.effectedSequence(block: suspend SequenceScope<E>.() -> Unit): Sequence<E>

构建一个sequence，并将当前 Items.PreprocessingProperties 作用于最终的 Sequence 中。

effectedSequenceItems

inline fun <T> effectedSequenceItems(crossinline block: suspend SequenceScope<T>.() -> Unit): Items<T>

以构建 Sequence 的方式构建 Items.

effectOn

fun <E> Items.PreprocessingProperties.effectOn(stream: Stream<E>): Stream<E>

将 Items.PreprocessingProperties 作用于目标 Stream 中。

fun <E> Items.PreprocessingProperties.effectOn(sequence: Sequence<E>): Sequence<E>

将 Items.PreprocessingProperties 作用于目标 Sequence 中。

@ExperimentalSimbotApi

fun <E> Items.PreprocessingProperties.effectOn(iter: ChannelIterator<E>): ChannelIterator<E>

将一个 Items.PreprocessingProperties 作用于目标 ChannelIterator 上。

fun <E> Items.PreprocessingProperties.effectOn(flow: Flow<E>): Flow<E>

将 Items.PreprocessingProperties 作用于目标 Flow 中。

flowItems

inline fun <T> CoroutineScope.flowItems(crossinline block: suspend FlowCollector<T>.(Items.PreprocessingProperties) -> Unit): Items<T>

以构建 Flow 的方式构建 Items.

itemsBy

fun <T> itemsBy(factory: (Items.PreprocessingProperties) -> ChannelIterator<T>): Items<T>

提供构建 ChannelIterator 的函数来构建一个 Items.

itemsByFlow

inline fun <T> CoroutineScope.itemsByFlow(crossinline flowFactory: (Items.PreprocessingProperties) -> Flow<T>): Items<T>

提供 CoroutineScope 和构建 Flow 的函数 flowFactory 来构建 Items.

itemsBySequence

inline fun <T> itemsBySequence(crossinline sequenceFactory: (Items.PreprocessingProperties) -> Sequence<T>): Items<T>

提供构建 Sequence 的函数 sequenceFactory 来构建 Items.

map

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

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

produceItems

inline fun <T> CoroutineScope.produceItems(context: CoroutineContext = EmptyCoroutineContext, capacity: Int = 0, crossinline block: suspend ProducerScope<T>.(Items.PreprocessingProperties) -> Unit): Items<T>

通过 produce 构建 ChannelIterator 来得到一个 Items 实例。

sequenceItems

inline fun <T> sequenceItems(crossinline block: suspend SequenceScope<T>.(Items.PreprocessingProperties) -> Unit): Items<T>

以构建 Sequence 的方式构建 Items.

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 实例。

withLimiter

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

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