Kotlin BSON • Multiplatform abstraction for different BSON implementations/opensavvy.ktmongo.bson/BsonValueReader

BsonValueReader

interface BsonValueReader(source)

Representation of a BSON value.

See the type to know which accessor to use. All other accessors will fail with a BsonReaderException.

To obtain instances of this interface, see BsonDocumentReader.read and BsonArrayReader.read.

Implementation constraints

Different implementations of BsonValueReader should be considered equal if they represent the same value, with the same type. That is, both values would result in the exact same BSON sent over the wire. The methods BsonValueReader.Companion.equals and BsonValueReader.Companion.hashCode are provided to facilitate implementation.

Types

object Companion

Properties

abstract val type: BsonType

The type of this value.

Functions

infix fun BsonValueReader.diff(other: BsonValueReader): String?

Analyzes the difference between two BSON values.

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

Reads this reader into an instance of type.

abstract fun readArray(): BsonArrayReader

abstract fun readBinaryData(): ByteArray

readBinaryDataType

abstract fun readBinaryDataType(): UByte

abstract fun readBoolean(): Boolean

abstract fun readDateTime(): Long

readDBPointerId

abstract fun ~~readDBPointerId~~(): ByteArray

readDBPointerNamespace

abstract fun ~~readDBPointerNamespace~~(): String

abstract fun readDecimal128(): ByteArray

abstract fun readDocument(): BsonDocumentReader

abstract fun readDouble(): Double

open fun readInstant(): Instant

Reads an Instant. Conversion function on top of readDateTime.

abstract fun readInt32(): Int

abstract fun readInt64(): Long

abstract fun readJavaScript(): String

readJavaScriptWithScope

abstract fun ~~readJavaScriptWithScope~~(): String

abstract fun readMaxKey()

abstract fun readMinKey()

abstract fun readNull()

abstract fun readObjectId(): ObjectId

readObjectIdBytes

abstract fun readObjectIdBytes(): ByteArray

readRegularExpressionOptions

abstract fun readRegularExpressionOptions(): String

readRegularExpressionPattern

abstract fun readRegularExpressionPattern(): String

abstract fun readString(): String

abstract fun ~~readSymbol~~(): String

abstract fun readTimestamp(): Timestamp

abstract fun ~~readUndefined~~()

abstract override fun toString(): String

JSON representation of this value.