JvmMongoIterable¶

class JvmMongoIterable<Document : Any> : MongoIterable<Document>

Implementation of MongoIterable based on MongoDB's FindFlow.

To access the inner iterable, see asKotlinMongoIterable.

To convert an existing MongoDB iterable into an instance of this class, see asKtMongo.

Functions¶

open override fun asFlow(): Flow<Document>

Streams the results of this response into a Flow.

@LowLevelApi
fun asKotlinMongoIterable(): FindFlow<Document>

Converts a KtMongo MongoIterable into a MongoDB FindFlow.

open fun asSequence(): Sequence<Document>

open suspend override fun first(): Document

Returns the first document found by this query, or throws an exception.

open suspend override fun firstOrNull(): Document?

Returns the first document found by this query, or null if none were found.

open suspend override fun forEach(action: suspend (Document) -> Unit)

Executes action for each document returned by this query.

open suspend override fun toList(): List<Document>

Reads the entirety of this response into a List.

open fun toSequence(): Sequence<Document>

open suspend fun toSet(): Set<Document>

Reads the entirety of this response into a Set.

open override fun toString(): String