Time

class Time(source)

Time control helper. See time.

Constructors

Time

@ExperimentalCoroutinesApi

constructor(environment: TestEnvironment)

Properties

clock

@ExperimentalCoroutinesApi

val Time.clock: Clock

Creates a Clock that follows the virtual time in this test.

now

@ExperimentalCoroutinesApi

val Time.now: Instant

Access the current virtual time within this test, as an Instant.

nowMillis

@ExperimentalCoroutinesApi

val Time.nowMillis: Long

Accesses the current time inside the test, in milliseconds.

scheduler

val scheduler: TestCoroutineScheduler

Accessor for the underlying TestCoroutineScheduler, which controls the current time.

source

val source: TimeSource.WithComparableMarks

Access a time source which can be used to measure elapsed time, as controlled with time.

Functions

advanceBy

@ExperimentalCoroutinesApi

fun Time.advanceBy(delay: Duration)

Advances the current time by delay.

advanceByMillis

@ExperimentalCoroutinesApi

fun Time.advanceByMillis(delay: Long)

Advances the current time by delay.

advanceUntilIdle

@ExperimentalCoroutinesApi

fun Time.advanceUntilIdle()

Runs all enqueued tasks in the specified order, advancing the virtual time as needed until there are no more scheduled tasks.

delayUntil

@ExperimentalCoroutinesApi

suspend fun Time.delayUntil(isoString: String)

Delays until the virtual time reaches isoString, formatted as an ISO 8601 timestamp, executing all enqueued tasks in order.

@ExperimentalCoroutinesApi

suspend fun Time.delayUntil(instant: Instant)

Delays until the virtual time reaches instant, executing all enqueued tasks in order.

runCurrent

@ExperimentalCoroutinesApi

fun Time.runCurrent()

Runs all enqueued tasks at this moment in the virtual time.

set

@ExperimentalCoroutinesApi

suspend fun Time.set(isoString: String)

Advances the virtual time until it reaches isoString, formatted as an ISO 8601 timestamp.

@ExperimentalCoroutinesApi

suspend fun Time.set(instant: Instant)

Advances the virtual time until it reaches instant.