kotlin-stdlib/kotlin.time/TestTimeSource

TestTimeSource

class TestTimeSource : AbstractLongTimeSource(source)

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

The current reading value can be advanced by the specified duration amount with the operator plusAssign:

val timeSource = TestTimeSource()
timeSource += 10.seconds

Implementation note: the current reading value is stored as a Long number of nanoseconds, thus it's capable to represent a time range of approximately ±292 years. Should the reading value overflow as the result of plusAssign operation, an IllegalStateException is thrown.

Since Kotlin

1.3

Constructors

TestTimeSource

fun TestTimeSource()

Functions

markNow

open override fun markNow(): TimeMark

Marks a point in time on this time source.

plusAssign

operator fun plusAssign(duration: Duration)

Advances the current reading value of this time source by the specified duration.

Extensions

measureTime

@ExperimentalTime

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

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

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.