kotlin-stdlib/kotlin.time/TimeSource/Monotonic/ValueTimeMark

ValueTimeMark

@ExperimentalTime
@JvmInline
value class ValueTimeMark : ComparableTimeMark(source)

A specialized kotlin.time.TimeMark returned by TimeSource.Monotonic time source.

This time mark is implemented as an inline value class wrapping a platform-dependent time reading value of the default monotonic time source, thus allowing to avoid additional boxing of that value.

The operations plus and minus are also specialized to return ValueTimeMark type.

This time mark implements ComparableTimeMark and therefore is comparable with other time marks obtained from the same TimeSource.Monotonic time source.

Since Kotlin

1.7

Functions

Link copied to clipboard
open operator override fun compareTo(other: ComparableTimeMark): Int

Compares this time mark with the other time mark for order.

Since Kotlin 1.7
operator fun compareTo(other: TimeSource.Monotonic.ValueTimeMark): Int

Compares this time mark with the other time mark for order.

Since Kotlin 1.7
Link copied to clipboard
infix inline fun <T> Comparable<T>.compareTo(other: T): Int

Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other, or a positive number if it's greater than other.

Since Kotlin 1.6
Link copied to clipboard
open override fun elapsedNow(): Duration

Returns the amount of time passed from this mark measured with the time source from which this mark was taken.

Since Kotlin 1.7
Link copied to clipboard
open override fun hasNotPassedNow(): Boolean

Returns false if this time mark has not passed according to the time source from which this mark was taken.

Since Kotlin 1.7
Link copied to clipboard
open override fun hasPassedNow(): Boolean

Returns true if this time mark has passed according to the time source from which this mark was taken.

Since Kotlin 1.7
Link copied to clipboard
open operator override fun minus(other: ComparableTimeMark): Duration

Returns the duration elapsed between the other time mark and this time mark.

Since Kotlin 1.7
open operator override fun minus(duration: Duration): TimeSource.Monotonic.ValueTimeMark

Returns a time mark on the same time source that is behind this time mark by the specified duration.

Since Kotlin 1.7
operator fun minus(other: TimeSource.Monotonic.ValueTimeMark): Duration

Returns the duration elapsed between the other time mark obtained from the same TimeSource.Monotonic time source and this time mark.

Since Kotlin 1.7
Link copied to clipboard
open operator override fun plus(duration: Duration): TimeSource.Monotonic.ValueTimeMark

Returns a time mark on the same time source that is ahead of this time mark by the specified duration.

Since Kotlin 1.7