Kotlin BSON • Compatibility with the official MongoDB implementation/opensavvy.ktmongo.bson.official/BsonValue

BsonValue

@Serializable(with = BsonValue.Serializer::class)

expect class BsonValue : BsonValue(source)

Implementation of opensavvy.ktmongo.bson.BsonValue based on the official MongoDB drivers.

The BSON specification only allows root documents, so it is not possible to instantiate this interface directly with a complex structure. This interface is used to decode the fields of a BsonDocument or the items of a BsonArray.

To instantiate a BsonDocument or BsonArray, see BsonFactory.

This page describes the BSON implementation based on the official MongoDB drivers. To learn more about the general BSON operations, see opensavvy.ktmongo.bson.BsonArray.

Navigating BSON types

This interface is part of the BSON trinity:

BsonDocument represents an entire BSON document.
BsonArray represents an array of BSON values.
BsonValue represents a single value in isolation.

Usage

If this BSON value is the serialized form of a Kotlin DTO, see decode.

This interface provides methods for decoding the different BSON native types, like decodeInt32, decodeObjectId and decodeInstant.

Some BSON types cannot be represented by a single Kotlin type, so multiple methods are provided to decode their components. For example: decodeRegularExpressionPattern and decodeRegularExpressionOptions.

@Serializable(with = BsonValue.Serializer::class)

actual class BsonValue : BsonValue(source)

Implementation of a KtMongo opensavvy.ktmongo.bson.BsonValue that wraps a org.bson.BsonValue.

To create an instance of this class, see BsonFactory.readValue.

Types

expect object Serializer : KSerializer<BsonValue>

Serializer for the official opensavvy.ktmongo.bson.official.BsonValue implementation.

actual object Serializer : KSerializer<BsonValue>

Properties

expect open override val factory: BsonFactory

actual open override val factory: BsonFactory

val raw: BsonValue

abstract val type: BsonType

open override val type: BsonType

Functions

abstract fun <T> decode(type: KType): T

open override fun <T> decode(type: KType): T

expect open override fun decodeArray(): BsonArray

actual open override fun decodeArray(): BsonArray

decodeBinaryData

abstract fun decodeBinaryData(): ByteArray

open override fun decodeBinaryData(): ByteArray

decodeBinaryDataType

abstract fun decodeBinaryDataType(): UByte

open override fun decodeBinaryDataType(): UByte

abstract fun decodeBoolean(): Boolean

open override fun decodeBoolean(): Boolean

abstract fun decodeDateTime(): Long

open override fun decodeDateTime(): Long

decodeDBPointerId

abstract fun ~~decodeDBPointerId~~(): ObjectId

open override fun ~~decodeDBPointerId~~(): ObjectId

decodeDBPointerNamespace

abstract fun ~~decodeDBPointerNamespace~~(): String

open override fun ~~decodeDBPointerNamespace~~(): String

decodeDecimal128Bytes

abstract fun decodeDecimal128Bytes(): ByteArray

open override fun decodeDecimal128Bytes(): ByteArray

expect open override fun decodeDocument(): BsonDocument

actual open override fun decodeDocument(): BsonDocument

abstract fun decodeDouble(): Double

open override fun decodeDouble(): Double

open fun decodeInstant(): Instant

open fun decodeInstant(): Instant

abstract fun decodeInt32(): Int

open override fun decodeInt32(): Int

abstract fun decodeInt64(): Long

open override fun decodeInt64(): Long

decodeJavaScript

abstract fun decodeJavaScript(): String

open override fun decodeJavaScript(): String

decodeJavaScriptScope

abstract fun ~~decodeJavaScriptScope~~(): BsonDocument

open override fun ~~decodeJavaScriptScope~~(): BsonDocument

abstract fun decodeMaxKey()

open override fun decodeMaxKey()

abstract fun decodeMinKey()

open override fun decodeMinKey()

abstract fun decodeNull(): Nothing?

open override fun decodeNull(): Nothing?

open fun decodeObjectId(): ObjectId

open fun decodeObjectId(): ObjectId

decodeObjectIdBytes

abstract fun decodeObjectIdBytes(): ByteArray

open override fun decodeObjectIdBytes(): ByteArray

decodeRegularExpressionOptions

abstract fun decodeRegularExpressionOptions(): String

open override fun decodeRegularExpressionOptions(): String

decodeRegularExpressionPattern

abstract fun decodeRegularExpressionPattern(): String

open override fun decodeRegularExpressionPattern(): String

abstract fun decodeString(): String

open override fun decodeString(): String

abstract fun ~~decodeSymbol~~(): String

open override fun ~~decodeSymbol~~(): String

decodeTimestamp

abstract fun decodeTimestamp(): Timestamp

open override fun decodeTimestamp(): Timestamp

decodeUndefined

abstract fun ~~decodeUndefined~~()

open override fun ~~decodeUndefined~~()

open fun decodeVector(): Vector

open fun decodeVector(): Vector

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open fun takeIfPresent(): BsonValue?

open fun takeIfPresent(): BsonValue?

open override fun toString(): String