Package-level declarations¶

Utilities to read and write BSON.

Types¶

@LowLevelApi
sealed interface AnyBsonWriter

Parent interface for type parameters that can accept either BsonValueWriter or BsonFieldWriter.

interface Bson

A BSON document.

interface BsonArray

A BSON array.

@LowLevelApi
interface BsonArrayReader

Utilities for decomposing a BsonArray into its elements.

@LowLevelApi
interface BsonDocumentReader

Utilities for decomposing a Bson document into its fields.

interface BsonFactory

Entrypoint for creating Bson and BsonArray instances.

interface BsonFieldWriteable

An object that can be represented as fields in a BSON document.

@LowLevelApi
interface BsonFieldWriter : AnyBsonWriter

Generator of BSON document fields.

sealed interface BsonPath

Access specific fields in arbitrary BSON documents using a JSONPath-like API.

class BsonReaderException(message: String, cause: Throwable? = null) : IllegalStateException

Exception thrown when BSON reading fails.

enum BsonType : Enum<BsonType>

The different data types supported in BSON documents.

@LowLevelApi
interface BsonValueReader

Representation of a BSON value.

interface BsonValueWriteable

An object that can be represented as a BSON value (value of a field, item in an array, an array itself).

@LowLevelApi
interface BsonValueWriter : AnyBsonWriter

Generator of BSON values.

@DslMarker
annotation class BsonWriterDsl

Annotation to mark types that are part of the BSON writer DSL.

annotation class ExperimentalBsonPathApi

const val DEPRECATED_IN_BSON_SPEC: String

Deprecation messages for BSON functionality that is deprecated in the BSON spec.

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

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

inline fun <T : Any> Bson.read(): T?

Reads this document into an instance of type T.

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

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

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

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

inline fun <T : Any> BsonFactory.write(obj: T): Bson

Writes an arbitrary Kotlin obj into a top-level BSON document.