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

BsonArray

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

expect class BsonArray : BsonArray(source)

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

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

val bson: BsonArray = …

for (element in bson) {
    println("Element: $element")
}

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

actual class BsonArray : BsonArray(source)

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

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

Types

Serializer

expect object Serializer : KSerializer<BsonArray>

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

actual object Serializer : KSerializer<BsonArray>

Properties

factory

expect open override val factory: BsonFactory

actual open override val factory: BsonFactory

indices

open val indices: IntRange

lastIndex

open val lastIndex: Int

raw

val raw: BsonArray

size

abstract val size: Int

open override val size: Int

Functions

asIterable

expect open override fun asIterable(): Iterable<BsonValue>

actual open override fun asIterable(): Iterable<BsonValue>

asList

expect open override fun asList(): List<BsonValue>

actual open override fun asList(): List<BsonValue>

asSequence

expect open override fun asSequence(): Sequence<BsonValue>

actual open override fun asSequence(): Sequence<BsonValue>

asValue

expect open override fun asValue(): BsonValue

actual open override fun asValue(): BsonValue

decode

@LowLevelApi

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

@LowLevelApi

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

decodeElements

@LowLevelApi

open fun <T> decodeElements(type: KType): List<T>

@LowLevelApi

open fun <T> decodeElements(type: KType): List<T>

equals

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

get

expect open operator override fun get(index: Int): BsonValue?

actual open operator override fun get(index: Int): BsonValue?

hashCode

open override fun hashCode(): Int

isEmpty

open fun isEmpty(): Boolean

open override fun isEmpty(): Boolean

isNotEmpty

open fun isNotEmpty(): Boolean

iterator

expect open operator override fun iterator(): Iterator<BsonValue>

actual open operator override fun iterator(): Iterator<BsonValue>

toString

abstract override fun toString(): String

open override fun toString(): String

withIndex

expect open override fun withIndex(): Iterable<IndexedValue<BsonValue>>

actual open override fun withIndex(): Iterable<IndexedValue<BsonValue>>