BsonArrayReader¶

@LowLevelApi
interface BsonArrayReader

Utilities for decomposing a BsonArray into its elements.

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

val bson: BsonArray = …

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

Different implementations of BsonArrayReader should be considered equal if they have the same elements in the same order. The methods BsonArrayReader.Companion.equals and BsonArrayReader.Companion.hashCode are provided to facilitate implementation.

Types¶

object Companion

abstract val elements: List<BsonValueReader>

A list of all elements in this reader.

open val indices: IntRange

A range of the valid indices in this array.

open val size: Int

The number of elements in this array.

abstract fun asValue(): BsonValueReader

Reads this entire array as a BsonValueReader.

@LowLevelApi
infix fun BsonArrayReader.diff(other: BsonArrayReader): String?

Analyzes the difference between two BSON arrays.

abstract fun read(index: Int): BsonValueReader?

Attempts to read an element at index index.

abstract fun <T : Any> read(type: KType, klass: KClass<T>): T?

Reads this document into an instance of type.

abstract fun toBson(): BsonArray

Reads this document into a BsonArray instance.

abstract override fun toString(): String

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