kitecore/io.github.yuroyami.kitecore.time/Deadline

Deadline

class Deadline(val timeout: Duration, timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic)

A fixed time budget that starts counting down at construction.

Time is read from the given time source, which defaults to TimeSource.Monotonic. A non-positive timeout produces a deadline that is expired from the start. All state is captured at construction, so reading the properties is safe from any coroutine.

Constructors

Deadline

constructor(timeout: Duration, timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic)

Properties

elapsed

val elapsed: Duration

The time passed since construction, growing without bound past timeout.

isExpired

val isExpired: Boolean

Whether the deadline has expired.

progress

val progress: Double

The expired fraction of timeout, from 0.0 to 1.0.

remaining

val remaining: Duration

The time left before expiry, floored at Duration.ZERO.

timeout

val timeout: Duration

The full time budget this deadline was created with.

Functions

await

suspend fun await()

Suspends for the remaining time in a single delay.

checkNotExpired

fun checkNotExpired()

Throws an IllegalStateException when the deadline has expired.

orNull

suspend fun <T> orNull(block: suspend () -> T): T?

Runs block bounded by the remaining time and returns null on expiry.