kitecore/io.github.yuroyami.kitecore.time/Stopwatch

Stopwatch

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

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

Time is read from timeSource, which defaults to TimeSource.Monotonic. The stopwatch starts out stopped with a zero elapsed value. Stopping keeps the accumulated time; use reset or restart to clear it.

This class is not thread-safe. Confine each instance to a single thread or coroutine, or guard it with external synchronization.

Constructors

Stopwatch

constructor(timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic)

Properties

elapsed

val elapsed: Duration

The total accumulated time, updating live while the stopwatch runs.

isRunning

val isRunning: Boolean

Whether the stopwatch is currently running.

Functions

measure

inline fun <T> measure(block: () -> T): T

Runs block while the stopwatch is running and returns the block's result.

reset

fun reset()

Stops the stopwatch and clears elapsed to Duration.ZERO.

restart

fun restart()

Clears elapsed to Duration.ZERO and starts the stopwatch in one call.

start

fun start()

Starts the stopwatch, doing nothing when it is already running.

stop

fun stop()

Stops the stopwatch and folds the running segment into elapsed, doing nothing when already stopped.