Microseconds

value class Microseconds(value: Long) : Comparable<Microseconds>

Constructors

Microseconds
Link copied to clipboard
common
fun Microseconds(value: Int)

Types

Companion
Link copied to clipboard
common
object Companion

Functions

compareTo
Link copied to clipboard
common
open operator override fun compareTo(other: Microseconds): Int
div
Link copied to clipboard
common
operator fun div(scalar: Int): Microseconds
operator fun div(scalar: Long): Microseconds

Returns this duration divided by a scalar value. @throws ArithmeticException if overflow occurs or the scalar is zero

minus
Link copied to clipboard
common
operator fun minus(days: Days): Microseconds
operator fun minus(hours: Hours): Microseconds
operator fun minus(microseconds: Microseconds): Microseconds
operator fun minus(milliseconds: Milliseconds): Microseconds
operator fun minus(minutes: Minutes): Microseconds
operator fun minus(nanoseconds: Nanoseconds): Nanoseconds
operator fun minus(seconds: Seconds): Microseconds
plus
Link copied to clipboard
common
operator fun plus(days: Days): Microseconds
operator fun plus(hours: Hours): Microseconds
operator fun plus(microseconds: Microseconds): Microseconds
operator fun plus(milliseconds: Milliseconds): Microseconds
operator fun plus(minutes: Minutes): Microseconds
operator fun plus(nanoseconds: Nanoseconds): Nanoseconds
operator fun plus(seconds: Seconds): Microseconds
rem
Link copied to clipboard
common
operator fun rem(scalar: Int): Microseconds
operator fun rem(scalar: Long): Microseconds

Returns the remainder of this duration divided by a scalar value.

times
Link copied to clipboard
common
operator fun times(scalar: Int): Microseconds
operator fun times(scalar: Long): Microseconds

Multiplies this duration by a scalar value. @throws ArithmeticException if overflow occurs

toComponents
Link copied to clipboard
common
inline fun <T> toComponents(action: (milliseconds: Milliseconds, microseconds: Microseconds) -> T): T
inline fun <T> toComponents(action: (seconds: Seconds, milliseconds: Milliseconds, microseconds: Microseconds) -> T): T
inline fun <T> toComponents(action: (minutes: Minutes, seconds: Seconds, milliseconds: Milliseconds, microseconds: Microseconds) -> T): T
inline fun <T> toComponents(action: (hours: Hours, minutes: Minutes, seconds: Seconds, milliseconds: Milliseconds, microseconds: Microseconds) -> T): T
inline fun <T> toComponents(action: (days: Days, hours: Hours, minutes: Minutes, seconds: Seconds, milliseconds: Milliseconds, microseconds: Microseconds) -> T): T
toComponentValues
Link copied to clipboard
common
inline fun <T> toComponentValues(action: (milliseconds: Long, microseconds: Int) -> T): T
inline fun <T> toComponentValues(action: (seconds: Long, milliseconds: Int, microseconds: Int) -> T): T
inline fun <T> toComponentValues(action: (minutes: Long, seconds: Int, milliseconds: Int, microseconds: Int) -> T): T
inline fun <T> toComponentValues(action: (hours: Long, minutes: Int, seconds: Int, milliseconds: Int, microseconds: Int) -> T): T
inline fun <T> toComponentValues(action: (days: Long, hours: Int, minutes: Int, seconds: Int, milliseconds: Int, microseconds: Int) -> T): T
toDouble
Link copied to clipboard
common
fun toDouble(): Double

Converts this duration to a Double value.

toInt
Link copied to clipboard
common
fun toInt(): Int

Converts this duration to an Int value. @throws ArithmeticException if overflow occurs

toKotlinDuration
Link copied to clipboard
common
fun toKotlinDuration(): Duration

Converts this duration to a kotlin.time.Duration.

toLong
Link copied to clipboard
common
fun toLong(): Long

Converts this duration to a Long value.

toString
Link copied to clipboard
common
open override fun toString(): String

Converts this duration to an ISO-8601 time interval representation.

unaryMinus
Link copied to clipboard
common
operator fun unaryMinus(): Microseconds

Negates this duration. @throws ArithmeticException if overflow occurs

Properties

absoluteValue
Link copied to clipboard
common
val absoluteValue: Microseconds

The absolute value of this duration. @throws ArithmeticException if overflow occurs

inNanoseconds
Link copied to clipboard
common
val inNanoseconds: Nanoseconds

Converts this duration to nanoseconds. @throws ArithmeticException if overflow occurs

inWholeDays
Link copied to clipboard
common
val inWholeDays: Days

Converts this duration to the number of whole days.

inWholeHours
Link copied to clipboard
common
val inWholeHours: Hours

Converts this duration to the number of whole hours.

inWholeMilliseconds
Link copied to clipboard
common
val inWholeMilliseconds: Milliseconds

Converts this duration to the number of whole milliseconds.

inWholeMinutes
Link copied to clipboard
common
val inWholeMinutes: Minutes

Converts this duration to the number of whole minutes.

inWholeSeconds
Link copied to clipboard
common
val inWholeSeconds: Seconds

Converts this duration to the number of whole seconds.

value
Link copied to clipboard
common
val value: Long

The underlying value.

Extensions

asDuration
Link copied to clipboard
common
fun Microseconds.asDuration(): Duration
toJavaDuration
Link copied to clipboard
fun Microseconds.toJavaDuration(): Duration

Converts this duration to an equivalent Java Duration.

toNSTimeInterval
Link copied to clipboard
darwin
fun Microseconds.toNSTimeInterval(): <ERROR CLASS>

Converts this duration to an equivalent NSTimeInterval.