kotlinx-uuid-core/app.softwork.uuid

Package-level declarations

Types

data object BinarySerializer : KSerializer<Uuid>

This serializer is useful with binary formats to reduce size. You may also use it with text formats like json, but it is not that useful (because there will be no size gain) and a serialized Uuid is not human-readable.

UuidParceler

data object UuidParceler : Parceler<Uuid>

Properties

clockSequence

val Uuid.clockSequence: Int

13-bits non-negative number representing a sequence number or a random number depending on Uuid version and variant.

isRfcVariant

val Uuid.isRfcVariant: Boolean

Uuid variant specified and documented by the RFC

MAX

val Uuid.Companion.MAX: Uuid

node

val Uuid.node: Long

Node Uuid part, a 48-bit non-negative number. Depending on version and variant it could be one of the following:

timeStamp

val Uuid.timeStamp: Long

A 60-bits non-negative number. Depending on the Uuid version it could have different semantics:

unixTimeStamp

val Uuid.unixTimeStamp: Long

The Uuidv7 48 bit big-endian unsigned number of Unix epoch timestamp in milliseconds

variant

val Uuid.variant: Int

Uuid variant in range [0..7], similar to version

version

val Uuid.version: Int

Uuid numeric version in range [0..15]

versionNumber

val Uuid.~~versionNumber~~: Int

Uuid numeric version in range [0..15]

Functions

from

fun Uuid.Companion.from(versionNumber: Int, timeStamp: Long, clockSequence: Int, node: Long, variant: Int = 5): Uuid

Creates an instance of Uuid from components

generateUuid

fun Uuid.Companion.generateUuid(bytes: ByteArray): Uuid

Generates a Uuid instance by input bytes applying SHA-1. It doesn't use any random source, so it will produce the same result for the same input values.

fun Uuid.Companion.generateUuid(namespace: Uuid, name: String): Uuid

Generates a Uuid instance by namespace and name applying SHA-1. It doesn't use any random source, so it will produce the same result for the same input values.