kotlin-stdlib / kotlin.time / ComparableTimeMark

ComparableTimeMark

Common
JVM
JS
Native
1.9
interface ComparableTimeMark : 
    TimeMark,
    Comparable<ComparableTimeMark>
(source)

A TimeMark that can be compared for difference with other time marks obtained from the same TimeSource.WithComparableMarks time source.

Functions

Common
JVM
JS
Native
1.0

compareTo

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

open operator fun compareTo(other: ComparableTimeMark): Int
Common
JVM
JS
Native
1.0

equals

Returns true if two time marks from the same time source represent the same moment of time, and false otherwise, including the situation when the time marks were obtained from different time sources.

abstract fun equals(other: Any?): Boolean
Common
JVM
JS
Native
1.0

hashCode

Returns a hash code value for the object. The general contract of hashCode is:

abstract fun hashCode(): Int
Common
JVM
JS
Native
1.0

minus

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

open operator fun minus(
    duration: Duration
): ComparableTimeMark

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

abstract operator fun minus(
    other: ComparableTimeMark
): Duration
Common
JVM
JS
Native
1.0

plus

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

abstract operator fun plus(
    duration: Duration
): ComparableTimeMark

Extension Functions

Common
JVM
JS
Native
1.0

coerceAtLeast

Ensures that this value is not less than the specified minimumValue.

fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T
Common
JVM
JS
Native
1.0

coerceAtMost

Ensures that this value is not greater than the specified maximumValue.

fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): T
Common
JVM
JS
Native
1.0

coerceIn

Ensures that this value lies in the specified range minimumValue..maximumValue.

fun <T : Comparable<T>> T.coerceIn(
    minimumValue: T?,
    maximumValue: T?
): T

Ensures that this value lies in the specified range.

fun <T : Comparable<T>> T.coerceIn(
    range: ClosedFloatingPointRange<T>
): T
fun <T : Comparable<T>> T.coerceIn(range: ClosedRange<T>): T
Common
JVM
JS
Native
1.6

compareTo

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.

infix fun <T> Comparable<T>.compareTo(other: T): Int
Common
JVM
JS
Native
1.0

rangeTo

Creates a range from this Comparable value to the specified that value.

operator fun <T : Comparable<T>> T.rangeTo(
    that: T
): ClosedRange<T>
Common
JVM
JS
Native
1.9

rangeUntil

Creates an open-ended range from this Comparable value to the specified that value.

operator fun <T : Comparable<T>> T.rangeUntil(
    that: T
): OpenEndRange<T>