Skip to content

Kotlin BSON • Multiplatform abstraction for different BSON implementationsopensavvy.ktmongo.bsonBsonArrayReader

BsonArrayReader

@LowLevelApi
interface BsonArrayReader

Utilities for decomposing a BsonArray into its elements.

To obtain an instance of this interface, see BsonArray.reader.

Example

val bson: BsonArray = 

for ((index, field) in bson.read().elements.withIndex()) {
    println("[$index] • ${field.type}")
}

Properties

elements

abstract val elements: List<BsonValueReader>

A list of all elements in this reader.

Functions

asValue

abstract fun asValue(): BsonValueReader

Reads this entire array as a BsonValueReader.

read

abstract fun read(index: Int): BsonValueReader?

Attempts to read an element at index index.

toBson

abstract fun toBson(): BsonArray

Reads this document into a BsonArray instance.

toString

abstract override fun toString(): String

JSON representation of the array this BsonArrayReader is reading, as a String.