kitecore/io.github.yuroyami.kitecore.time

Package-level declarations

Types

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

A fixed time budget that starts counting down at construction.

class RateLimiter(val permits: Int, val per: Duration, timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic)

A sliding-window rate limiter that grants at most permits acquisitions within any window of length per.

Stopwatch

class Stopwatch(timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic)

A stopwatch that accumulates elapsed time across start and stop cycles.

Functions

average

fun Iterable<Duration>.average(): Duration

Returns the average of all durations.

backoffSequence

fun backoffSequence(initialDelay: Duration, factor: Double = 2.0, maxDelay: Duration = Duration.INFINITE): Sequence<Duration>

Returns an infinite sequence of exponentially growing backoff delays.

formatClock

fun Duration.formatClock(): String

Formats this duration as a colon-separated clock string, such as "01:23:45".

formatHms

fun Duration.formatHms(): String

Formats this duration as hours, minutes, and seconds, such as "1h 23m 45s".

humanReadable

fun Duration.humanReadable(maxParts: Int = 2): String

Formats this duration as its most significant components, such as "1h 23m".

parseClock

fun parseClock(text: String): Duration

Parses a clock string produced by formatClock back into a Duration.

parseClockOrNull

fun parseClockOrNull(text: String): Duration?

Parses a clock string produced by formatClock, or returns null when text is not valid.

pollUntil

suspend fun pollUntil(interval: Duration, timeout: Duration, condition: suspend () -> Boolean): Boolean

Polls condition until it returns true or timeout elapses, and reports whether it became true.

roundToHours

fun Duration.roundToHours(): Duration

Rounds this duration to the nearest whole hour.

roundToMinutes

fun Duration.roundToMinutes(): Duration

Rounds this duration to the nearest whole minute.

roundToSeconds

fun Duration.roundToSeconds(): Duration

Rounds this duration to the nearest whole second.

sum

fun Iterable<Duration>.sum(): Duration

Returns the sum of all durations, or Duration.ZERO for an empty iterable.

withMinimumDuration

suspend fun <T> withMinimumDuration(minimum: Duration, timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic, block: suspend () -> T): T

Runs block and then delays so the whole call takes at least minimum.