//core/io.islandtime.measures/Days
Days¶
common
value class Days(val value: Long) : Comparable<Days>
Constructors¶
| Days | common constructor(value: Int)constructor(value: Long) |
Types¶
| Name | Summary |
|---|---|
| Companion | common object Companion |
Properties¶
| Name | Summary |
|---|---|
| absoluteValue | common val absoluteValue: DaysThe absolute value of this duration. |
| inHours | common val inHours: HoursConverts this duration to hours. |
| inMicroseconds | common val inMicroseconds: MicrosecondsConverts this duration to microseconds. |
| inMilliseconds | common val inMilliseconds: MillisecondsConverts this duration to milliseconds. |
| inMinutes | common val inMinutes: MinutesConverts this duration to minutes. |
| inNanoseconds | common val inNanoseconds: NanosecondsConverts this duration to nanoseconds. |
| inSeconds | common val inSeconds: SecondsConverts this duration to seconds. |
| inWholeWeeks | common val inWholeWeeks: WeeksConverts this duration to the number of whole weeks. |
| value | common val value: LongThe underlying value. |
Functions¶
| Name | Summary |
|---|---|
| asDuration | common fun Days.asDuration(): Duration |
| asPeriod | common fun Days.asPeriod(): PeriodConverts this duration into a Period with the same number of days. |
| compareTo | common open operator override fun compareTo(other: Days): Int |
| div | common operator fun div(scalar: Int): Daysoperator fun div(scalar: Long): DaysReturns this duration divided by a scalar value. |
| minus | common operator fun minus(days: Days): Daysoperator fun minus(hours: Hours): Hoursoperator fun minus(microseconds: Microseconds): Microsecondsoperator fun minus(milliseconds: Milliseconds): Millisecondsoperator fun minus(minutes: Minutes): Minutesoperator fun minus(nanoseconds: Nanoseconds): Nanosecondsoperator fun minus(seconds: Seconds): Secondsoperator fun minus(weeks: Weeks): Days |
| minus | common operator fun Days.minus(period: Period): Period |
| plus | common operator fun plus(days: Days): Daysoperator fun plus(hours: Hours): Hoursoperator fun plus(microseconds: Microseconds): Microsecondsoperator fun plus(milliseconds: Milliseconds): Millisecondsoperator fun plus(minutes: Minutes): Minutesoperator fun plus(nanoseconds: Nanoseconds): Nanosecondsoperator fun plus(seconds: Seconds): Secondsoperator fun plus(weeks: Weeks): Days |
| plus | common operator fun Days.plus(period: Period): Period |
| rem | common operator fun rem(scalar: Int): Daysoperator fun rem(scalar: Long): DaysReturns the remainder of this duration divided by a scalar value. |
| times | common operator fun times(scalar: Int): Daysoperator fun times(scalar: Long): DaysMultiplies this duration by a scalar value. |
| 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(): DoubleConverts this duration to a Double value. |
| toInt | common fun toInt(): IntConverts this duration to an Int value. |
| toJavaDuration | jvm fun Days.toJavaDuration(): DurationConverts this duration to an equivalent Java Duration. |
| toJavaPeriod | jvm fun Days.toJavaPeriod(): PeriodConverts this duration to an equivalent Java Period. |
| toKotlinDuration | common fun toKotlinDuration(): DurationConverts this duration to a kotlin.time.Duration. |
| toLong | common fun toLong(): LongConverts this duration to a Long value. |
| toNSTimeInterval | darwin fun Days.toNSTimeInterval(): <Error class: unknown class>Converts this duration to an equivalent NSTimeInterval. |
| toString | common open override fun toString(): StringConverts this duration to an ISO-8601 time interval representation. |
| unaryMinus | common operator fun unaryMinus(): DaysNegates this duration. |