Kotlin BSON/opensavvy.ktmongo.bson/BsonValue

BsonValue

@Serializable(with = ContextualSerializer::class)

interface BsonValue(source)

An arbitrary BSON value.

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.

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.

Equality

Different implementations of this interface are 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 BsonValue.Companion.equals and BsonValue.Companion.hashCode are provided as default implementations.

Types

object Companion

Properties

abstract val factory: BsonFactory

The instance of BsonFactory that created this instance.

abstract val type: BsonType

The native BSON type of this value.

Functions

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

Decodes this value into an instance of the Kotlin type T.

inline fun <T> BsonValue.decode(): T

Decodes this value into an instance of the Kotlin type T.

abstract fun decodeArray(): BsonArray

Decodes this value as a nested BsonArray.

decodeBinaryData

abstract fun decodeBinaryData(): ByteArray

Decodes a binary blob.

decodeBinaryDataType

abstract fun decodeBinaryDataType(): UByte

Decodes the type of a binary blob.

abstract fun decodeBoolean(): Boolean

Decodes this value as a Boolean.

abstract fun decodeDateTime(): Long

Decodes this value as a UTC timestamp in milliseconds since the Unix epoch.

decodeDBPointerId

abstract fun ~~decodeDBPointerId~~(): ObjectId

Decodes this value as the ID of a database pointer.

decodeDBPointerNamespace

abstract fun ~~decodeDBPointerNamespace~~(): String

Decodes this value as the namespace of a database pointer.

decodeDecimal128Bytes

abstract fun decodeDecimal128Bytes(): ByteArray

Decodes this value as the bytes of a Decimal128.

abstract fun decodeDocument(): BsonDocument

Decodes this value as a nested BsonDocument.

abstract fun decodeDouble(): Double

Decodes this value as Double.

open fun decodeInstant(): Instant

Decodes this value as a Kotlin Instant.

abstract fun decodeInt32(): Int

Decodes this value as Int.

abstract fun decodeInt64(): Long

Decodes this value as Long.

decodeJavaScript

abstract fun decodeJavaScript(): String

Decodes this value as JavaScript code.

decodeJavaScriptScope

abstract fun ~~decodeJavaScriptScope~~(): BsonDocument

Decodes this value as a document describing variables some JavaScript code has access to.

abstract fun decodeMaxKey()

Decodes the special BSON value BsonType.MaxKey.

abstract fun decodeMinKey()

Decodes the special BSON value BsonType.MinKey.

abstract fun decodeNull(): Nothing?

Decodes this value as a Kotlin null.

open fun decodeObjectId(): ObjectId

Decodes this value as a ObjectId.

decodeObjectIdBytes

abstract fun decodeObjectIdBytes(): ByteArray

Decodes this value as the bytes of an ObjectId.

decodeRegularExpressionOptions

abstract fun decodeRegularExpressionOptions(): String

Decodes this value as the options of a regular expression.

decodeRegularExpressionPattern

abstract fun decodeRegularExpressionPattern(): String

Decodes this value as the pattern of a regular expression.

abstract fun decodeString(): String

Decodes this value as a string.

abstract fun ~~decodeSymbol~~(): String

Decodes this value as a symbol.

decodeTimestamp

abstract fun decodeTimestamp(): Timestamp

Decodes this value as a Timestamp.

decodeUndefined

abstract fun ~~decodeUndefined~~()

Decodes this value as an undefined value.

open fun decodeVector(): Vector

Decodes a binary Vector.

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

Analyzes the difference between two BSON values.

open fun takeIfPresent(): BsonValue?

Returns this value, unless it is undefined or null, in which case returns null.