Kotlin BSON • Multiplatform abstraction for different BSON implementations • opensavvy.ktmongo.bson • BsonFieldWriter

BsonFieldWriter

@LowLevelApi
interface BsonFieldWriter : AnyBsonWriter

Generator of BSON document fields.

This interface is used to write fields in a BSON document.

To write generic values, see BsonValueWriter.

Instances of this interface are commonly obtained by calling the BsonContext.buildDocument function.

Functions

write

@LowLevelApi
abstract fun write(name: String, block: BsonValueWriter.() -> Unit)

writeArray

@LowLevelApi
abstract fun writeArray(name: String, block: BsonValueWriter.() -> Unit)

writeBinaryData

@LowLevelApi
abstract fun writeBinaryData(name: String, type: UByte, data: ByteArray)

writeBoolean

@LowLevelApi
abstract fun writeBoolean(name: String, value: Boolean)

writeDateTime

@LowLevelApi
abstract fun writeDateTime(name: String, value: Long)

writeDBPointer

@LowLevelApi
abstract fun writeDBPointer(name: String, namespace: String, id: ByteArray)

writeDecimal128

@LowLevelApi
abstract fun writeDecimal128(name: String, low: Long, high: Long)

writeDocument

@LowLevelApi
abstract fun writeDocument(name: String, block: BsonFieldWriter.() -> Unit)

writeDouble

@LowLevelApi
abstract fun writeDouble(name: String, value: Double)

writeInstant

@ExperimentalTime
@LowLevelApi
open fun writeInstant(name: String, value: Instant)

Writes an Instant. Conversion function on top of writeDateTime.

writeInt32

@LowLevelApi
open fun writeInt32(name: String, value: Byte)

@LowLevelApi
abstract fun writeInt32(name: String, value: Int)

@LowLevelApi
open fun writeInt32(name: String, value: Short)

writeInt64

@LowLevelApi
abstract fun writeInt64(name: String, value: Long)

writeJavaScript

@LowLevelApi
abstract fun writeJavaScript(name: String, code: String)

writeJavaScriptWithScope

@LowLevelApi
abstract fun writeJavaScriptWithScope(name: String, code: String)

writeMaxKey

@LowLevelApi
abstract fun writeMaxKey(name: String)

writeMinKey

@LowLevelApi
abstract fun writeMinKey(name: String)

writeNull

@LowLevelApi
abstract fun writeNull(name: String)

writeObjectId

@LowLevelApi
abstract fun writeObjectId(name: String, id: ByteArray)

@ExperimentalTime
@LowLevelApi
abstract fun writeObjectId(name: String, id: ObjectId)

writeObjectSafe

@LowLevelApi
abstract fun <T> writeObjectSafe(name: String, obj: T)

Writes an arbitrary obj into a BSON document.

writeRegularExpression

@LowLevelApi
abstract fun writeRegularExpression(name: String, pattern: String, options: String)

writeString

@LowLevelApi
abstract fun writeString(name: String, value: String)

writeSymbol

@LowLevelApi
abstract fun writeSymbol(name: String, value: String)

writeTimestamp

@LowLevelApi
abstract fun writeTimestamp(name: String, value: Timestamp)

writeUndefined

@LowLevelApi
abstract fun writeUndefined(name: String)