kotlin-stdlib/kotlin.time

Package-level declarations

API for measuring time intervals and calculating durations.

For more information, see our Time measurement guide.

API for measuring time intervals and calculating durations.

For more information, see our Time measurement guide.

API for measuring time intervals and calculating durations.

For more information, see our Time measurement guide.

API for measuring time intervals and calculating durations.

For more information, see our Time measurement guide.

API for measuring time intervals and calculating durations.

For more information, see our Time measurement guide.

API for measuring time intervals and calculating durations.

For more information, see our Time measurement guide.

Types

AbstractDoubleTimeSource

@ExperimentalTime

abstract class ~~AbstractDoubleTimeSource~~(val unit: DurationUnit) : TimeSource.WithComparableMarks

An abstract class used to implement time sources that return their readings as Double values in the specified unit.

Since Kotlin 1.3

AbstractLongTimeSource

abstract class AbstractLongTimeSource(val unit: DurationUnit) : TimeSource.WithComparableMarks

An abstract class used to implement time sources that return their readings as Long values in the specified unit.

Since Kotlin 1.9

ComparableTimeMark

interface ComparableTimeMark : TimeMark, Comparable<ComparableTimeMark>

A TimeMark that can be compared for difference with other time marks obtained from the same TimeSource.WithComparableMarks time source.

Since Kotlin 1.9

value class Duration : Comparable<Duration>

Represents the amount of time one instant of time is away from another instant.

Since Kotlin 1.6

expect enum DurationUnit : Enum<DurationUnit>

The list of possible time measurement units, in which a duration can be expressed.

Since Kotlin 1.6

actual enum DurationUnit : Enum<DurationUnit>

Since Kotlin 1.6

actual enum DurationUnit : Enum<DurationUnit>

Since Kotlin 1.6

actual enum DurationUnit : Enum<DurationUnit>

Since Kotlin 1.6

actual enum DurationUnit : Enum<DurationUnit>

Since Kotlin 1.8

actual enum DurationUnit : Enum<DurationUnit>

Since Kotlin 1.8

ExperimentalTime

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalTime

This annotation marks the experimental preview of the standard library API for measuring time and working with durations.

Since Kotlin 1.3

class TestTimeSource : AbstractLongTimeSource

A time source that has programmatically updatable readings. It is useful as a predictable source of time in tests.

Since Kotlin 1.9

data class TimedValue<T>(val value: T, val duration: Duration)

Data class representing a result of executing an action, along with the duration of the elapsed time interval.

Since Kotlin 1.9

interface TimeMark

Represents a time point notched on a particular TimeSource. Remains bound to the time source it was taken from and allows querying for the duration of time elapsed from that point (see the function elapsedNow).

Since Kotlin 1.9

interface TimeSource

A source of time for measuring time intervals.

Since Kotlin 1.9

Functions

inline fun measureTime(block: () -> Unit): Duration

Executes the given function block and returns the duration of the elapsed time interval.

Since Kotlin 1.9

inline fun TimeSource.measureTime(block: () -> Unit): Duration

inline fun TimeSource.Monotonic.measureTime(block: () -> Unit): Duration

Executes the given function block and returns the duration of the elapsed time interval.

Since Kotlin 1.9

measureTimedValue

inline fun <T> measureTimedValue(block: () -> T): TimedValue<T>

Executes the given function block and returns an instance of TimedValue class, containing both the result of the function execution and the duration of the elapsed time interval.

Since Kotlin 1.9

measureTimedValue

inline fun <T> TimeSource.measureTimedValue(block: () -> T): TimedValue<T>

inline fun <T> TimeSource.Monotonic.measureTimedValue(block: () -> T): TimedValue<T>

Executes the given function block and returns an instance of TimedValue class, containing both the result of function execution and the duration of the elapsed time interval.

Since Kotlin 1.9

inline operator fun Double.times(duration: Duration): Duration

inline operator fun Int.times(duration: Duration): Duration

Returns a duration whose value is the specified duration value multiplied by this number.

Since Kotlin 1.6

fun Double.toDuration(unit: DurationUnit): Duration

Returns a Duration equal to this Double number of the specified unit.

Since Kotlin 1.6

fun Int.toDuration(unit: DurationUnit): Duration

Returns a Duration equal to this Int number of the specified unit.

Since Kotlin 1.6

fun Long.toDuration(unit: DurationUnit): Duration

Returns a Duration equal to this Long number of the specified unit.

Since Kotlin 1.6

fun TimeUnit.toDurationUnit(): DurationUnit

Converts this java.util.concurrent.TimeUnit enum value to the corresponding kotlin.time.DurationUnit value.

Since Kotlin 1.8

inline fun Duration.toJavaDuration(): Duration

Converts kotlin.time.Duration value to java.time.Duration value.

Since Kotlin 1.6

toKotlinDuration

inline fun Duration.toKotlinDuration(): Duration

Converts java.time.Duration value to kotlin.time.Duration value.

Since Kotlin 1.6

fun DurationUnit.toTimeUnit(): TimeUnit

Converts this kotlin.time.DurationUnit enum value to the corresponding java.util.concurrent.TimeUnit value.

Since Kotlin 1.8

Thanks for your feedback!

Was this page helpful?