kotlin-stdlib/kotlin.time

Package-level declarations

API for representing Duration values and experimental API for measuring time intervals.

Types

AbstractDoubleTimeSource

@ExperimentalTime

abstract class AbstractDoubleTimeSource(val unit: DurationUnit) : TimeSource

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

Since Kotlin 1.3

AbstractLongTimeSource

@ExperimentalTime

abstract class AbstractLongTimeSource(val unit: DurationUnit) : TimeSource

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

Since Kotlin 1.3

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

TestTimeSource

@ExperimentalTime

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.3

TimedValue

@ExperimentalTime

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

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

Since Kotlin 1.3

TimeMark

@ExperimentalTime

abstract class 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.3

TimeSource

@ExperimentalTime

interface TimeSource

A source of time for measuring time intervals.

Since Kotlin 1.3

Properties

days

@ExperimentalTime

val Double.~~days~~: Duration

Returns a Duration equal to this Double number of days.

Since Kotlin 1.3

@ExperimentalTime

val Int.~~days~~: Duration

Returns a Duration equal to this Int number of days.

Since Kotlin 1.3

@ExperimentalTime

val Long.~~days~~: Duration

Returns a Duration equal to this Long number of days.

Since Kotlin 1.3

hours

@ExperimentalTime

val Double.~~hours~~: Duration

Returns a Duration equal to this Double number of hours.

Since Kotlin 1.3

@ExperimentalTime

val Int.~~hours~~: Duration

Returns a Duration equal to this Int number of hours.

Since Kotlin 1.3

@ExperimentalTime

val Long.~~hours~~: Duration

Returns a Duration equal to this Long number of hours.

Since Kotlin 1.3

microseconds

@ExperimentalTime

val Double.~~microseconds~~: Duration

Returns a Duration equal to this Double number of microseconds.

Since Kotlin 1.3

@ExperimentalTime

val Int.~~microseconds~~: Duration

Returns a Duration equal to this Int number of microseconds.

Since Kotlin 1.3

@ExperimentalTime

val Long.~~microseconds~~: Duration

Returns a Duration equal to this Long number of microseconds.

Since Kotlin 1.3

milliseconds

@ExperimentalTime

val Double.~~milliseconds~~: Duration

Returns a Duration equal to this Double number of milliseconds.

Since Kotlin 1.3

@ExperimentalTime

val Int.~~milliseconds~~: Duration

Returns a Duration equal to this Int number of milliseconds.

Since Kotlin 1.3

@ExperimentalTime

val Long.~~milliseconds~~: Duration

Returns a Duration equal to this Long number of milliseconds.

Since Kotlin 1.3

minutes

@ExperimentalTime

val Double.~~minutes~~: Duration

Returns a Duration equal to this Double number of minutes.

Since Kotlin 1.3

@ExperimentalTime

val Int.~~minutes~~: Duration

Returns a Duration equal to this Int number of minutes.

Since Kotlin 1.3

@ExperimentalTime

val Long.~~minutes~~: Duration

Returns a Duration equal to this Long number of minutes.

Since Kotlin 1.3

nanoseconds

@ExperimentalTime

val Double.~~nanoseconds~~: Duration

Returns a Duration equal to this Double number of nanoseconds.

Since Kotlin 1.3

@ExperimentalTime

val Int.~~nanoseconds~~: Duration

Returns a Duration equal to this Int number of nanoseconds.

Since Kotlin 1.3

@ExperimentalTime

val Long.~~nanoseconds~~: Duration

Returns a Duration equal to this Long number of nanoseconds.

Since Kotlin 1.3

seconds

@ExperimentalTime

val Double.~~seconds~~: Duration

Returns a Duration equal to this Double number of seconds.

Since Kotlin 1.3

@ExperimentalTime

val Int.~~seconds~~: Duration

Returns a Duration equal to this Int number of seconds.

Since Kotlin 1.3

@ExperimentalTime

val Long.~~seconds~~: Duration

Returns a Duration equal to this Long number of seconds.

Since Kotlin 1.3

Functions

compareTo

@ExperimentalTime

inline operator fun TimeMark.~~compareTo~~(other: TimeMark): Int

Since Kotlin 1.3

measureTime

@ExperimentalTime

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

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

Since Kotlin 1.3

measureTime

@ExperimentalTime

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

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

Since Kotlin 1.3

measureTimedValue

@ExperimentalTime

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 elapsed time interval.

Since Kotlin 1.3

measureTimedValue

@ExperimentalTime

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

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

Since Kotlin 1.3

minus

@ExperimentalTime

inline operator fun TimeMark.~~minus~~(other: TimeMark): Duration

Since Kotlin 1.3

Thanks for your feedback!

Was this page helpful?