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

ObjectId¶

@ExperimentalTime
@Serializable
(with = ObjectId.Serializer::class)class ObjectId : Comparable<ObjectId>

A 12-bytes identifier for MongoDB objects.

This class allows accessing all fields of an ObjectId as well as constructing instances from existing data. However, it doesn't provide a way to generate new randomized ObjectId instances (as that depends on the database configuration). To do so, see opensavvy.ktmongo.bson.BsonContext.newId.

Constructors¶

`ObjectId`¶

constructor(timestamp: Instant, processId: Long, counter: Int)

Constructs a new ObjectId from its different components.

constructor(bytes: ByteArray)

Constructs a new ObjectId by reading a byte array.

constructor(hex: String)

Constructs a new ObjectId by reading a hexadecimal representation.

Types¶

`Companion`¶

object Companion

`Serializer`¶

@ExperimentalTime
@LowLevelApi
class Serializer : KSerializer<ObjectId>

Default serializer for ObjectId.

Properties¶

`bytes`¶

val bytes: ByteArray

Generates a byte representation of this ObjectId instance.

`counter`¶

val counter: Int

A 3-byte incrementing counter per client-side process, initialized to a random value. Always positive.

`hex`¶

val hex: String

Generates a hex representation of this ObjectId instance.

`processId`¶

val processId: Long

5-byte random value generated per client-side process.

`timestamp`¶

val timestamp: Instant

The ObjectId creation timestamp, with a resolution of one second.

Functions¶

`compareTo`¶

operator fun compareTo(other: Instant): Int

open operator override fun compareTo(other: ObjectId): Int

`equals`¶

open operator override fun equals(other: Any?): Boolean

`hashCode`¶

open override fun hashCode(): Int

`toString`¶

open override fun toString(): String