BinaryData

BinaryData

An arbitrary binary block.

The arbitrary block is accompanied by a type as a UByte.

The binary data types 0..127 are reserved. The data types 128..255 are available for custom use.

The binary data type 0 is a generic subtype that can be used for any usage.

The KtMongo library provides utilities for some binary data types, like kotlin.uuid.Uuid and Vector.

See also

• BsonValue.decodeBinaryData: Read the binary blob.

• BsonValue.decodeBinaryDataType: Read the subtype.

• BsonFieldWriter.writeBinaryData: Write this type.

Properties

code

val code: Byte

The byte identifier for this particular type.

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

name

expect val name: String

ordinal

expect val ordinal: Int