Kotlin BSON/opensavvy.ktmongo.bson/BsonDocument

BsonDocument

@Serializable(with = ContextualSerializer::class)

interface BsonDocument(source)

A BSON document.

To create instances of this class, 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

val bson: BsonDocument = …

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

The iteration order of a BSON document is preserved: fields appear in the same order as they are written in.

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 BsonDocument.Companion.equals and BsonDocument.Companion.hashCode are provided as default implementations.

Types

Companion

object Companion

Field

interface Field

A pair of a name and a value.

Properties

factory

abstract val factory: BsonFactory

The instance of BsonFactory that created this instance.

fields

abstract val fields: Set<String>

Returns the set of fields in this document.

size

abstract val size: Int

The number of fields in this document.

Functions

asIterable

abstract fun asIterable(): Iterable<BsonDocument.Field>

Creates an Iterable that wraps this document.

asMap

abstract fun asMap(): Map<String, BsonValue>

Creates a Map view of this document.

asSequence

abstract fun asSequence(): Sequence<BsonDocument.Field>

Creates a Sequence of the fields in this document.

asValue

abstract fun asValue(): BsonValue

Returns the BsonValue equivalent to this document.

infix inline fun <T> BsonDocument.at(path: BsonPath): T

Finds the first value that matches path in a given BSON document.

decode

@LowLevelApi

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

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

decode

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

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

diff

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

Analyzes the difference between two BSON documents.

get

abstract operator fun get(field: String): BsonValue?

Returns the element with named field.

isEmpty

open fun isEmpty(): Boolean

Returns true if this document has no fields.

isNotEmpty

open fun isNotEmpty(): Boolean

Returns true if this document has at least one field.

iterator

abstract operator fun iterator(): Iterator<BsonDocument.Field>

Iterates over the fields in this document.

select

inline fun <T> BsonDocument.select(@Language(value = "JSONPath") path: String): Sequence<T>

inline fun <T> BsonDocument.select(path: BsonPath): Sequence<T>

Finds all values that match path in a given BSON document.

selectFirst

inline fun <T> BsonDocument.selectFirst(@Language(value = "JSONPath") path: String): T

inline fun <T> BsonDocument.selectFirst(path: BsonPath): T

Finds the first value that matches path in a given BSON document.

toByteArray

abstract fun toByteArray(): ByteArray

Generates a ByteArray of the raw BSON representation of this value.

toString

abstract override fun toString(): String

JSON representation of this BsonDocument object, as a String.