//core/io.islandtime.measures/Duration

Duration

A duration of time at nanosecond precision.

For many applications, working with specific units like IntHours or LongSeconds is more efficient and plenty adequate. However, when working with larger durations at sub-second precision, overflow is a very real possibility. Duration is capable of representing fixed, nanosecond-precision durations that span the entire supported time scale, making it more suitable for these use cases.

class Duration : Comparable<Duration>

Types

Companion

common

object Companion

Functions

compareTo

common

open operator override fun compareTo(other: Duration): Int

div

common

Divides this duration by a scalar value.

operator fun div(scalar: Int): Duration

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

isNegative

common

Checks if this duration is negative.

fun isNegative(): Boolean

isPositive

common

Checks if this duration is positive.

fun isPositive(): Boolean

isZero

common

Checks if this duration is zero.

fun isZero(): Boolean

minus

common

operator fun minus(other: Duration): Duration

operator fun minus(days: IntDays): Duration

operator fun minus(days: LongDays): Duration

operator fun minus(hours: IntHours): Duration

operator fun minus(hours: LongHours): Duration

operator fun minus(minutes: IntMinutes): Duration

operator fun minus(minutes: LongMinutes): Duration

operator fun minus(seconds: IntSeconds): Duration

operator fun minus(seconds: LongSeconds): Duration

operator fun minus(milliseconds: IntMilliseconds): Duration

operator fun minus(milliseconds: LongMilliseconds): Duration

operator fun minus(microseconds: IntMicroseconds): Duration

operator fun minus(microseconds: LongMicroseconds): Duration

operator fun minus(nanoseconds: IntNanoseconds): Duration

operator fun minus(nanoseconds: LongNanoseconds): Duration

plus

common

operator fun plus(other: Duration): Duration

operator fun plus(days: IntDays): Duration

operator fun plus(days: LongDays): Duration

operator fun plus(hours: IntHours): Duration

operator fun plus(hours: LongHours): Duration

operator fun plus(minutes: IntMinutes): Duration

operator fun plus(minutes: LongMinutes): Duration

operator fun plus(seconds: IntSeconds): Duration

operator fun plus(seconds: LongSeconds): Duration

operator fun plus(milliseconds: IntMilliseconds): Duration

operator fun plus(milliseconds: LongMilliseconds): Duration

operator fun plus(microseconds: IntMicroseconds): Duration

operator fun plus(microseconds: LongMicroseconds): Duration

operator fun plus(nanoseconds: IntNanoseconds): Duration

operator fun plus(nanoseconds: LongNanoseconds): Duration

times

common

Multiples this duration by a scalar value.

operator fun times(scalar: Int): Duration

toComponents

common

Breaks this duration down into individual unit components, assuming a 24-hour day length.

inline fun <T> toComponents(action: (LongDays, IntHours, IntMinutes, IntSeconds, IntNanoseconds) -> T): T

Breaks this duration down into individual unit components.

inline fun <T> toComponents(action: (LongHours, IntMinutes, IntSeconds, IntNanoseconds) -> T): T

inline fun <T> toComponents(action: (LongMinutes, IntSeconds, IntNanoseconds) -> T): T

inline fun <T> toComponents(action: (LongSeconds, IntNanoseconds) -> T): T

toKotlinDuration

common

Converts this duration to a kotlin.time.Duration. Since Kotlin's Duration type is based on a floating-point number, precision may be lost.

@ExperimentalTime()

fun toKotlinDuration(): Duration

toString

common

open override fun toString(): String

truncatedTo

common

Returns this duration, rounded down to match the precision of a given unit.

fun truncatedTo(unit: TimeUnit): Duration

unaryMinus

common

operator fun unaryMinus(): Duration

Properties

absoluteValue

common

The absolute value of this duration.

val absoluteValue: Duration

inDays

common

Converts this duration into the number of 24-hour days represented by it.

val inDays: LongDays

inHours

common

Converts this duration into the number of whole hours represented by it.

val inHours: LongHours

inMicroseconds

common

Converts this duration into the number of whole microseconds represented by it.

val inMicroseconds: LongMicroseconds

inMilliseconds

common

Converts this duration into the number of whole milliseconds represented by it.

val inMilliseconds: LongMilliseconds

inMinutes

common

Converts this duration into the number of whole minutes represented by it.

val inMinutes: LongMinutes

inNanoseconds

common

Converts this duration into LongNanoseconds.

val inNanoseconds: LongNanoseconds

inSeconds

common

Returns the number of whole seconds in this duration.

val inSeconds: LongSeconds

nanosecondAdjustment

common

val nanosecondAdjustment: IntNanoseconds

seconds

common

val seconds: LongSeconds

Extensions

toJavaDuration

jvm

Converts this duration to an equivalent Java Duration.

fun Duration.toJavaDuration(): Duration

toNSTimeInterval

darwin

Converts this duration to an equivalent NSTimeInterval.

fun Duration.toNSTimeInterval(): <ERROR CLASS>