Kotlin BSON/opensavvy.ktmongo.bson/BsonArray

BsonArray

@Serializable(with = ContextualSerializer::class)

interface BsonArray(source)

A BSON array.

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: BsonArray = …

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

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

Types

Companion

object Companion

Properties

factory

abstract val factory: BsonFactory

The instance of BsonFactory that created this instance.

indices

open val indices: IntRange

lastIndex

open val lastIndex: Int

size

abstract val size: Int

The number of items in this array.

Functions

asIterable

abstract fun asIterable(): Iterable<BsonValue>

Creates an Iterable that wraps this array.

asList

abstract fun asList(): List<BsonValue>

Creates a List view of this array.

asSequence

abstract fun asSequence(): Sequence<BsonValue>

Creates a Sequence of the items in this array.

asValue

abstract fun asValue(): BsonValue

Returns the BsonValue equivalent to this array.

decode

@LowLevelApi

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

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

decode

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

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

decodeElements

@LowLevelApi

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

Decodes this array into a List of the Kotlin type T.

decodeElements

inline fun <T> BsonArray.decodeElements(): List<T>

Decodes this array into a List of the Kotlin type T.

diff

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

Analyzes the difference between two BSON arrays.

get

abstract operator fun get(index: Int): BsonValue?

Returns the element in the array at index.

isEmpty

open fun isEmpty(): Boolean

Returns true if this array has no elements.

isNotEmpty

open fun isNotEmpty(): Boolean

Returns true if this array has at least one element.

iterator

abstract operator fun iterator(): Iterator<BsonValue>

Iterates over the elements in this array.

toString

abstract override fun toString(): String

JSON representation of this BsonArray, as a String.

withIndex

abstract fun withIndex(): Iterable<IndexedValue<BsonValue>>

Iterates over this array, returning both each item and its index.