BsonDocumentReader¶

@LowLevelApi
interface BsonDocumentReader

Utilities for decomposing a Bson document into its fields.

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

val bson: Bson = …

for ((name, field) in bson.read().entries) {
    println("Field: $name • ${field.type}")
}

Properties¶

abstract val entries: Map<String, BsonValueReader>

A map allowing to go through all key-value pairs in the document.

abstract fun asValue(): BsonValueReader

Reads this entire document as a BsonValueReader.

abstract fun read(name: String): BsonValueReader?

Attempts to read a field named name.

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

Reads this document into an instance of type.

abstract fun toBson(): Bson

Reads this document into a Bson instance.

abstract override fun toString(): String

JSON representation of the document this BsonDocumentReader is reading, as a String.