Kotlin BSON • Pure Kotlin Multiplatform implementation/opensavvy.ktmongo.bson.multiplatform/BsonValue

BsonValue

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

class BsonValue : BsonValue(source)

Pure Kotlin implementation of opensavvy.ktmongo.bson.BsonValue.

The BSON specification only allows root documents, so it is not possible to instantiate this class directly with a complex structure. This class 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 multiplatform implementation. To learn more about the general BSON operations, see opensavvy.ktmongo.bson.BsonValue.

Navigating BSON types

This class 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.

Thread-safety

This class is not thread-safe. Although it is not possible to mutate its state, this class uses internal mutation to lazily decode the BSON stream.

Types

object Serializer : KSerializer<BsonValue>

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

Properties

open override val factory: BsonFactory

open override val type: BsonType

Functions

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

open override fun decodeArray(): BsonArray

decodeBinaryData

open override fun decodeBinaryData(): ByteArray

decodeBinaryDataType

open override fun decodeBinaryDataType(): UByte

open override fun decodeBoolean(): Boolean

open override fun decodeDateTime(): Long

decodeDBPointerId

open override fun decodeDBPointerId(): ObjectId

decodeDBPointerNamespace

open override fun decodeDBPointerNamespace(): String

decodeDecimal128Bytes

open override fun decodeDecimal128Bytes(): ByteArray

open override fun decodeDocument(): BsonDocument

open override fun decodeDouble(): Double

open fun decodeInstant(): Instant

open override fun decodeInt32(): Int

open override fun decodeInt64(): Long

decodeJavaScript

open override fun decodeJavaScript(): String

decodeJavaScriptScope

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

open override fun decodeMaxKey()

open override fun decodeMinKey()

open override fun decodeNull(): Nothing?

open fun decodeObjectId(): ObjectId

decodeObjectIdBytes

open override fun decodeObjectIdBytes(): ByteArray

decodeRegularExpressionOptions

open override fun decodeRegularExpressionOptions(): String

decodeRegularExpressionPattern

open override fun decodeRegularExpressionPattern(): String

open override fun decodeString(): String

open override fun decodeSymbol(): String

decodeTimestamp

open override fun decodeTimestamp(): Timestamp

decodeUndefined

open override fun decodeUndefined()

open fun decodeVector(): Vector

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

open override fun hashCode(): Int

open fun takeIfPresent(): BsonValue?

open override fun toString(): String