kotlin-stdlib/kotlin.time/Duration/Companion

Companion

object Companion(source)

Since Kotlin

1.6

Properties

Link copied to clipboard
val Double.days: Duration

Returns a Duration equal to this Double number of days.

Since Kotlin 1.6
val Int.days: Duration

Returns a Duration equal to this Int number of days.

Since Kotlin 1.6
val Long.days: Duration

Returns a Duration equal to this Long number of days.

Since Kotlin 1.6
Link copied to clipboard
val Double.hours: Duration

Returns a Duration equal to this Double number of hours.

Since Kotlin 1.6
val Int.hours: Duration

Returns a Duration equal to this Int number of hours.

Since Kotlin 1.6
val Long.hours: Duration

Returns a Duration equal to this Long number of hours.

Since Kotlin 1.6
Link copied to clipboard
val INFINITE: Duration

The duration whose value is positive infinity. It is useful for representing timeouts that should never expire.

Since Kotlin 1.6
Link copied to clipboard
val Double.microseconds: Duration

Returns a Duration equal to this Double number of microseconds.

Since Kotlin 1.6
val Int.microseconds: Duration

Returns a Duration equal to this Int number of microseconds.

Since Kotlin 1.6
val Long.microseconds: Duration

Returns a Duration equal to this Long number of microseconds.

Since Kotlin 1.6
Link copied to clipboard
val Double.milliseconds: Duration

Returns a Duration equal to this Double number of milliseconds.

Since Kotlin 1.6
val Int.milliseconds: Duration

Returns a Duration equal to this Int number of milliseconds.

Since Kotlin 1.6
val Long.milliseconds: Duration

Returns a Duration equal to this Long number of milliseconds.

Since Kotlin 1.6
Link copied to clipboard
val Double.minutes: Duration

Returns a Duration equal to this Double number of minutes.

Since Kotlin 1.6
val Int.minutes: Duration

Returns a Duration equal to this Int number of minutes.

Since Kotlin 1.6
val Long.minutes: Duration

Returns a Duration equal to this Long number of minutes.

Since Kotlin 1.6
Link copied to clipboard
val Double.nanoseconds: Duration

Returns a Duration equal to this Double number of nanoseconds.

Since Kotlin 1.6
val Int.nanoseconds: Duration

Returns a Duration equal to this Int number of nanoseconds.

Since Kotlin 1.6
val Long.nanoseconds: Duration

Returns a Duration equal to this Long number of nanoseconds.

Since Kotlin 1.6
Link copied to clipboard
val Double.seconds: Duration

Returns a Duration equal to this Double number of seconds.

Since Kotlin 1.6
val Int.seconds: Duration

Returns a Duration equal to this Int number of seconds.

Since Kotlin 1.6
val Long.seconds: Duration

Returns a Duration equal to this Long number of seconds.

Since Kotlin 1.6
Link copied to clipboard
val ZERO: Duration

The duration equal to exactly 0 seconds.

Since Kotlin 1.6

Functions

Link copied to clipboard
@ExperimentalTime
fun convert(value: Double, sourceUnit: DurationUnit, targetUnit: DurationUnit): Double

Converts the given time duration value expressed in the specified sourceUnit into the specified targetUnit.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
fun days(value: Double): Duration
@ExperimentalTime
fun days(value: Int): Duration
@ExperimentalTime
fun days(value: Long): Duration

Returns a Duration representing the specified value number of days.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
fun hours(value: Double): Duration
@ExperimentalTime
fun hours(value: Int): Duration
@ExperimentalTime
fun hours(value: Long): Duration

Returns a Duration representing the specified value number of hours.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
fun microseconds(value: Double): Duration
@ExperimentalTime
fun microseconds(value: Int): Duration
@ExperimentalTime
fun microseconds(value: Long): Duration

Returns a Duration representing the specified value number of microseconds.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
fun milliseconds(value: Double): Duration
@ExperimentalTime
fun milliseconds(value: Int): Duration
@ExperimentalTime
fun milliseconds(value: Long): Duration

Returns a Duration representing the specified value number of milliseconds.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
fun minutes(value: Double): Duration
@ExperimentalTime
fun minutes(value: Int): Duration
@ExperimentalTime
fun minutes(value: Long): Duration

Returns a Duration representing the specified value number of minutes.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
fun nanoseconds(value: Double): Duration
@ExperimentalTime
fun nanoseconds(value: Int): Duration
@ExperimentalTime
fun nanoseconds(value: Long): Duration

Returns a Duration representing the specified value number of nanoseconds.

Since Kotlin 1.6
Link copied to clipboard
fun parse(value: String): Duration

Parses a string that represents a duration and returns the parsed Duration value.

Since Kotlin 1.6
Link copied to clipboard
fun parseIsoString(value: String): Duration

Parses a string that represents a duration in a restricted ISO-8601 composite representation and returns the parsed Duration value. Composite representation is a relaxed version of ISO-8601 duration format that supports negative durations and negative values of individual components.

Since Kotlin 1.6
Link copied to clipboard
fun parseIsoStringOrNull(value: String): Duration?

Parses a string that represents a duration in restricted ISO-8601 composite representation and returns the parsed Duration value or null if the string doesn't represent a duration in the format acceptable by parseIsoString.

Since Kotlin 1.6
Link copied to clipboard
fun parseOrNull(value: String): Duration?

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.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
fun seconds(value: Double): Duration
@ExperimentalTime
fun seconds(value: Int): Duration
@ExperimentalTime
fun seconds(value: Long): Duration

Returns a Duration representing the specified value number of seconds.

Since Kotlin 1.6