Skip to content

//core/io.islandtime.measures/Days

Days

common

@JvmInline

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

Constructors

Days

common

fun Days(value: Int)

Types

Name Summary
Companion

common


object Companion

Functions

Name Summary
compareTo

common


open operator override fun compareTo(other: Days): Int
div

common


operator fun div(scalar: Int): Days

operator fun div(scalar: Long): Days

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

common


operator fun minus(days: Days): Days

operator fun minus(hours: Hours): Hours

operator fun minus(microseconds: Microseconds): Microseconds

operator fun minus(milliseconds: Milliseconds): Milliseconds

operator fun minus(minutes: Minutes): Minutes

operator fun minus(nanoseconds: Nanoseconds): Nanoseconds

operator fun minus(seconds: Seconds): Seconds

operator fun minus(weeks: Weeks): Days
plus

common


operator fun plus(days: Days): Days

operator fun plus(hours: Hours): Hours

operator fun plus(microseconds: Microseconds): Microseconds

operator fun plus(milliseconds: Milliseconds): Milliseconds

operator fun plus(minutes: Minutes): Minutes

operator fun plus(nanoseconds: Nanoseconds): Nanoseconds

operator fun plus(seconds: Seconds): Seconds

operator fun plus(weeks: Weeks): Days
rem

common


operator fun rem(scalar: Int): Days

operator fun rem(scalar: Long): Days

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

common


operator fun times(scalar: Int): Days

operator fun times(scalar: Long): Days

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

common


inline fun <T> toComponents(action: (weeks: Weeks, days: Days) -> T): T
toComponentValues

common


inline fun <T> toComponentValues(action: (weeks: Long, days: Int) -> T): T
toDouble

common


fun toDouble(): Double

Converts this duration to a Double value.
toInt

common


fun toInt(): Int

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

common


fun toKotlinDuration(): Duration

Converts this duration to a kotlin.time.Duration.
toLong

common


fun toLong(): Long

Converts this duration to a Long value.
toString

common


open override fun toString(): String

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

common


operator fun unaryMinus(): Days

Negates this duration. @throws ArithmeticException if overflow occurs

Properties

Name Summary
absoluteValue

common

val absoluteValue: Days

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

common

val inHours: Hours

Converts this duration to hours. @throws ArithmeticException if overflow occurs
inMicroseconds

common

val inMicroseconds: Microseconds

Converts this duration to microseconds. @throws ArithmeticException if overflow occurs
inMilliseconds

common

val inMilliseconds: Milliseconds

Converts this duration to milliseconds. @throws ArithmeticException if overflow occurs
inMinutes

common

val inMinutes: Minutes

Converts this duration to minutes. @throws ArithmeticException if overflow occurs
inNanoseconds

common

val inNanoseconds: Nanoseconds

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

common

val inSeconds: Seconds

Converts this duration to seconds. @throws ArithmeticException if overflow occurs
inWholeWeeks

common

val inWholeWeeks: Weeks

Converts this duration to the number of whole weeks.
value

common

val value: Long

The underlying value.

Extensions

Name Summary
asDuration

common


fun Days.asDuration(): Duration
asPeriod

common


fun Days.asPeriod(): Period

Converts this duration into a Period with the same number of days.
minus

common


operator fun Days.minus(period: Period): Period
plus

common


operator fun Days.plus(period: Period): Period
toJavaDuration

jvm


fun Days.toJavaDuration(): Duration

Converts this duration to an equivalent Java Duration.
toJavaPeriod

jvm


fun Days.toJavaPeriod(): Period

Converts this duration to an equivalent Java Period.
toNSTimeInterval

darwin


fun Days.toNSTimeInterval(): <ERROR CLASS>

Converts this duration to an equivalent NSTimeInterval.