BsonType¶

enum BsonType : Enum<BsonType>

The different data types supported in BSON documents.

Note that the BSON type is available as the property code. The property <strong>ordinal</strong> is meaningless on this type, and may change over time.

External resources¶

BSON spec

Entries¶

`Double`¶

Double

A 64-bit floating-point number, represented by the Kotlin class kotlin.Double.

`String`¶

String

A UTF-8 encoded string, represented by the Kotlin class kotlin.String.

`Document`¶

Document

An arbitrary document, represented by the Kotlin interface Bson.

`Array`¶

Array

An array of arbitrary values, represented by the Kotlin interface BsonArray.

`ObjectId`¶

ObjectId

A 12-bytes, time-sorted unique identifier for documents, represented by the Kotlin class ObjectId.

`Boolean`¶

Boolean

A boolean value, represented by the Kotlin class kotlin.Boolean.

`Datetime`¶

Datetime

A date and time in UTC, represented by the Kotlin class kotlin.time.Instant.

`DBPointer`¶

DBPointer

A reference to a document in another collection.

`Symbol`¶

Symbol

`JavaScriptWithScope`¶

JavaScriptWithScope

A string of JavaScript code, accompanied by a document containing variables.

`Int32`¶

Int32

A 32-bit signed integer, represented by the Kotlin class kotlin.Int.

`Timestamp`¶

Timestamp

A special type used in MongoDB logs, represented by the Kotlin class Timestamp. In most situations, users should use Datetime instead.

`Int64`¶

Int64

A 64-bit signed integer, represented by the Kotlin class kotlin.Long.

`MinKey`¶

MinKey

A special value containing the minimum possible value.

`MaxKey`¶

MaxKey

A special value containing the maximum possible value.

Types¶

`Companion`¶

object Companion

Properties¶

code¶

val code: Byte

The byte identifier for this particular type.

Guaranteed to be in the range -1 (MinKey) to 127 (MaxKey).

entries¶

val entries: EnumEntries<BsonType>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

`name`¶

expect val name: String

`ordinal`¶

expect val ordinal: Int

Functions¶

valueOf¶

fun valueOf(value: String): BsonType

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

IllegalArgumentException: if this enum type has no constant with the specified name

values¶

fun values(): Array<BsonType>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.