kotlinx-datetime/kotlinx.datetime/Clock

Clock

interface Clock(source)

A source of Instant values.

See Clock.System for the clock instance that queries the operating system.

It is not recommended to use Clock.System directly in the implementation. Instead, you can pass a Clock explicitly to the necessary functions or classes. This way, tests can be written deterministically by providing custom Clock implementations to the system under test.

Inheritors

Types

object Companion

A companion object used purely for namespacing.

object System : Clock

The Clock instance that queries the platform-specific system clock as its source of time knowledge.

Functions

@ExperimentalTime

fun Clock.asTimeSource(): TimeSource.WithComparableMarks

Returns a TimeSource that uses this Clock to mark a time instant and to find the amount of time elapsed since that mark.

abstract fun now(): Instant

Returns the Instant corresponding to the current time, according to this clock.

fun Clock.todayIn(timeZone: TimeZone): LocalDate

Returns the current date at the given time zone, according to this Clock.