Platform and version requirements: JVM (1.6), JS (1.6), Native (1.6)
inline class Duration : Comparable<Duration>
Represents the amount of time one instant of time is away from another instant.
A negative duration is possible in a situation when the second instant is earlier than the first one.
The type can store duration values up to ±146 years with nanosecond precision, and up to ±146 million years with millisecond precision. If a duration-returning operation provided in kotlin.time produces a duration value that doesn't fit into the above range, the returned Duration is infinite.
An infinite duration value Duration.INFINITE can be used to represent infinite timeouts.
To construct a duration use either the extension function toDuration, or the extension properties hours, minutes, seconds, and so on, available on Int, Long, and Double numeric types.
To get the value of this duration expressed in a particular duration units use the functions toInt, toLong, and toDouble or the properties inWholeHours, inWholeMinutes, inWholeSeconds, inWholeNanoseconds, and so on.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns the absolute value of this value. The returned value is always non-negative.
val absoluteValue: Duration
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Double number of days.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Double number of hours.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Double number of microseconds.
val inMicroseconds: Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Double number of milliseconds.
val inMilliseconds: Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Double number of minutes.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Double number of nanoseconds.
val inNanoseconds: Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Double number of seconds.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Long number of days.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Long number of hours.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Long number of microseconds.
val inWholeMicroseconds: Long
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Long number of milliseconds.
val inWholeMilliseconds: Long
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Long number of minutes.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Long number of nanoseconds.
val inWholeNanoseconds: Long
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The value of this duration expressed as a Long number of seconds.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
fun compareTo(other: Duration): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a duration whose value is this duration value divided by the given scale number.
operator fun div(scale: Int): Duration
operator fun div(scale: Double): Duration
Returns a number that is the ratio of this and other duration values.
operator fun div(other: Duration): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns true, if the duration value is finite.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns true, if the duration value is infinite.
fun isInfinite(): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns true, if the duration value is less than zero.
fun isNegative(): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns true, if the duration value is greater than zero.
fun isPositive(): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a duration whose value is the difference between this and other duration values.
operator fun minus(other: Duration): Duration
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a duration whose value is the sum of this and other duration values.
operator fun plus(other: Duration): Duration
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a duration whose value is this duration value multiplied by the given scale number.
operator fun times(scale: Int): Duration
operator fun times(scale: Double): Duration
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Splits this duration into days, hours, minutes, seconds, and nanoseconds and executes the given action with these components. The result of action is returned as the result of this function.
fun <T> toComponents(
action: (days: Long, hours: Int, minutes: Int, seconds: Int, nanoseconds: Int) -> T
): T
Splits this duration into hours, minutes, seconds, and nanoseconds and executes the given action with these components. The result of action is returned as the result of this function.
fun <T> toComponents(
action: (hours: Long, minutes: Int, seconds: Int, nanoseconds: Int) -> T
): T
Splits this duration into minutes, seconds, and nanoseconds and executes the given action with these components. The result of action is returned as the result of this function.
fun <T> toComponents(
action: (minutes: Long, seconds: Int, nanoseconds: Int) -> T
): T
Splits this duration into seconds, and nanoseconds and executes the given action with these components. The result of action is returned as the result of this function.
fun <T> toComponents(
action: (seconds: Long, nanoseconds: Int) -> T
): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns the value of this duration expressed as a Double number of the specified unit.
fun toDouble(unit: DurationUnit): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns the value of this duration expressed as an Int number of the specified unit.
fun toInt(unit: DurationUnit): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns an ISO-8601 based string representation of this duration.
fun toIsoString(): String
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns the value of this duration expressed as a Long number of the specified unit.
fun toLong(unit: DurationUnit): Long
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns the value of this duration expressed as a Long number of milliseconds.
fun toLongMilliseconds(): Long
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns the value of this duration expressed as a Long number of nanoseconds.
fun toLongNanoseconds(): Long
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a string representation of this duration value expressed as a combination of numeric components, each in its own unit.
Returns a string representation of this duration value expressed in the given unit and formatted with the specified decimals number of digits after decimal point.
fun toString(unit: DurationUnit, decimals: Int = 0): String
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns the negative of this value.
operator fun unaryMinus(): Duration
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a Duration equal to this Int number of days.
val Int.days: <ERROR CLASS>
Returns a Duration equal to this Long number of days.
val Long.days: <ERROR CLASS>
Returns a Duration equal to this Double number of days.
val Double.days: <ERROR CLASS>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a Duration equal to this Int number of hours.
val Int.hours: <ERROR CLASS>
Returns a Duration equal to this Long number of hours.
val Long.hours: <ERROR CLASS>
Returns a Duration equal to this Double number of hours.
val Double.hours: <ERROR CLASS>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The duration whose value is positive infinity. It is useful for representing timeouts that should never expire.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a Duration equal to this Int number of microseconds.
val Int.microseconds: <ERROR CLASS>
Returns a Duration equal to this Long number of microseconds.
val Long.microseconds: <ERROR CLASS>
Returns a Duration equal to this Double number of microseconds.
val Double.microseconds: <ERROR CLASS>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a Duration equal to this Int number of milliseconds.
val Int.milliseconds: <ERROR CLASS>
Returns a Duration equal to this Long number of milliseconds.
val Long.milliseconds: <ERROR CLASS>
Returns a Duration equal to this Double number of milliseconds.
val Double.milliseconds: <ERROR CLASS>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a Duration equal to this Int number of minutes.
val Int.minutes: <ERROR CLASS>
Returns a Duration equal to this Long number of minutes.
val Long.minutes: <ERROR CLASS>
Returns a Duration equal to this Double number of minutes.
val Double.minutes: <ERROR CLASS>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a Duration equal to this Int number of nanoseconds.
val Int.nanoseconds: <ERROR CLASS>
Returns a Duration equal to this Long number of nanoseconds.
val Long.nanoseconds: <ERROR CLASS>
Returns a Duration equal to this Double number of nanoseconds.
val Double.nanoseconds: <ERROR CLASS>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Returns a Duration equal to this Int number of seconds.
val Int.seconds: <ERROR CLASS>
Returns a Duration equal to this Long number of seconds.
val Long.seconds: <ERROR CLASS>
Returns a Duration equal to this Double number of seconds.
val Double.seconds: <ERROR CLASS>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
The duration equal to exactly 0 seconds.
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Converts the given time duration value expressed in the specified sourceUnit into the specified targetUnit.
fun convert(
value: Double,
sourceUnit: DurationUnit,
targetUnit: DurationUnit
): Double
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)
Returns a Duration representing the specified value number of days.
fun days(value: Int): Duration
fun days(value: Long): Duration
fun days(value: Double): Duration
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)
Returns a Duration representing the specified value number of hours.
fun hours(value: Int): Duration
fun hours(value: Long): Duration
fun hours(value: Double): Duration
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)
Returns a Duration representing the specified value number of microseconds.
fun microseconds(value: Int): Duration
fun microseconds(value: Long): Duration
fun microseconds(value: Double): Duration
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)
Returns a Duration representing the specified value number of milliseconds.
fun milliseconds(value: Int): Duration
fun milliseconds(value: Long): Duration
fun milliseconds(value: Double): Duration
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)
Returns a Duration representing the specified value number of minutes.
fun minutes(value: Int): Duration
fun minutes(value: Long): Duration
fun minutes(value: Double): Duration
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)
Returns a Duration representing the specified value number of nanoseconds.
fun nanoseconds(value: Int): Duration
fun nanoseconds(value: Long): Duration
fun nanoseconds(value: Double): Duration
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Parses a string that represents a duration and returns the parsed Duration value.
fun parse(value: String): Duration
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Parses a string that represents a duration in ISO-8601 format and returns the parsed Duration value.
fun parseIsoString(value: String): Duration
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Parses a string that represents a duration in ISO-8601 format and returns the parsed Duration value, or null if the string doesn't represent a duration in ISO-8601 format.
fun parseIsoStringOrNull(value: String): Duration?
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Parses a string that represents a duration and returns the parsed Duration value, or null if the string doesn't represent a duration in any of the supported formats.
fun parseOrNull(value: String): Duration?
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)
Returns a Duration representing the specified value number of seconds.
fun seconds(value: Int): Duration
fun seconds(value: Long): Duration
fun seconds(value: Double): Duration
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Ensures that this value is not less than the specified minimumValue.
fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Ensures that this value is not greater than the specified maximumValue.
fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
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
Platform and version requirements: JVM (1.6), JS (1.6), Native (1.6)
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
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
Creates a range from this Comparable value to the specified that value.
operator fun <T : Comparable<T>> T.rangeTo(
that: T
): ClosedRange<T>
Platform and version requirements: JVM (1.6), JRE8 (1.6)
Converts kotlin.time.Duration value to java.time.Duration value.
fun Duration.toJavaDuration(): Duration