Time¶

class Time

Time control helper. See time.

Constructors¶

@ExperimentalCoroutinesApi
@ExperimentalTime
constructor(environment: TestEnvironment)

@ExperimentalCoroutinesApi
@ExperimentalTime
val Time.clock:

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

@ExperimentalCoroutinesApi
@ExperimentalTime
val Time.now:

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

@ExperimentalCoroutinesApi
val Time.nowMillis: Long

Accesses the current time inside the test, in milliseconds.

val scheduler: TestCoroutineScheduler

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

val source: TimeSource.WithComparableMarks

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

@ExperimentalCoroutinesApi
fun Time.advanceBy(delay: Duration)

Advances the current time by delay.

@ExperimentalCoroutinesApi
fun Time.advanceByMillis(delay: Long)

Advances the current time by delay.

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

@ExperimentalTime
@ExperimentalCoroutinesApi
suspend fun Time.delayUntil(instant: )

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

@ExperimentalTime
@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
fun Time.runCurrent()

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

@ExperimentalTime
@ExperimentalCoroutinesApi
suspend fun Time.set(instant: )

Advances the virtual time until it reaches instant.

@ExperimentalTime
@ExperimentalCoroutinesApi
suspend fun Time.set(isoString: String)

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