core / io.islandtime / Instant

Instant

(iosArm64, iosX64, jvm, macosX64) class Instant : TimePoint<Instant>, Comparable<Instant>

An instant in time with nanosecond precision.

Properties

(iosArm64, iosX64, jvm, macosX64)

millisecondsSinceUnixEpoch

The number of milliseconds since the Unix epoch of 1970-01-01T00:00Z

val millisecondsSinceUnixEpoch: LongMilliseconds
(iosArm64, iosX64, jvm, macosX64)

nanoOfSecondsSinceUnixEpoch

The number of additional nanoseconds on top of secondsSinceUnixEpoch

val nanoOfSecondsSinceUnixEpoch: IntNanoseconds
(iosArm64, iosX64, jvm, macosX64)

secondsSinceUnixEpoch

The number of seconds since the Unix epoch of 1970-01-01T00:00Z

val secondsSinceUnixEpoch: LongSeconds
(iosArm64, iosX64, jvm, macosX64)

unixEpochMillisecond

The millisecond of the Unix epoch

val unixEpochMillisecond: Long
(iosArm64, iosX64, jvm, macosX64)

unixEpochNanoOfSecond

The nanosecond of the second of the Unix epoch

val unixEpochNanoOfSecond: Int
(iosArm64, iosX64, jvm, macosX64)

unixEpochSecond

The second of the Unix epoch

val unixEpochSecond: Long

Functions

(iosArm64, iosX64, jvm, macosX64)

compareTo

fun compareTo(other: Instant): Int
(iosArm64, iosX64, jvm, macosX64)

equals

fun equals(other: Any?): Boolean
(iosArm64, iosX64, jvm, macosX64)

hashCode

fun hashCode(): Int
(iosArm64, iosX64, jvm, macosX64)

minus

operator fun minus(other: Duration): Instant
operator fun minus(days: IntDays): Instant
operator fun minus(days: LongDays): Instant
operator fun minus(hours: IntHours): Instant
operator fun minus(hours: LongHours): Instant
operator fun minus(minutes: IntMinutes): Instant
operator fun minus(minutes: LongMinutes): Instant
operator fun minus(seconds: IntSeconds): Instant
operator fun minus(seconds: LongSeconds): Instant
operator fun minus(milliseconds: IntMilliseconds): Instant
operator fun minus(milliseconds: LongMilliseconds): Instant
operator fun minus(microseconds: IntMicroseconds): Instant
operator fun minus(microseconds: LongMicroseconds): Instant
operator fun minus(nanoseconds: IntNanoseconds): Instant
operator fun minus(nanoseconds: LongNanoseconds): Instant
(iosArm64, iosX64, jvm, macosX64)

plus

operator fun plus(other: Duration): Instant
operator fun plus(days: IntDays): Instant
operator fun plus(days: LongDays): Instant
operator fun plus(hours: IntHours): Instant
operator fun plus(hours: LongHours): Instant
operator fun plus(minutes: IntMinutes): Instant
operator fun plus(minutes: LongMinutes): Instant
operator fun plus(seconds: IntSeconds): Instant
operator fun plus(seconds: LongSeconds): Instant
operator fun plus(milliseconds: IntMilliseconds): Instant
operator fun plus(milliseconds: LongMilliseconds): Instant
operator fun plus(microseconds: IntMicroseconds): Instant
operator fun plus(microseconds: LongMicroseconds): Instant
operator fun plus(nanoseconds: IntNanoseconds): Instant
operator fun plus(nanoseconds: LongNanoseconds): Instant
(iosArm64, iosX64, jvm, macosX64)

rangeTo

operator fun rangeTo(other: Instant): InstantInterval

toString

Convert this instant to a string in ISO-8601 extended format.

(iosArm64, iosX64, macosX64) fun toString(): <ERROR CLASS>
(jvm) fun toString(): String

Companion Object Properties

(iosArm64, iosX64, jvm, macosX64)

MAX

The largest supported Instant, which can be used as a "far future" sentinel.

val MAX: Instant
(iosArm64, iosX64, jvm, macosX64)

MIN

The smallest supported Instant, which can be used as a "far past" sentinel.

val MIN: Instant
(iosArm64, iosX64, jvm, macosX64)

UNIX_EPOCH

The Instant representing the Unix epoch of 1970-01-01T00:00Z.

val UNIX_EPOCH: Instant

Companion Object Functions

(iosArm64, iosX64, jvm, macosX64)

fromUnixEpochMillisecond

Create an Instant from the millisecond of the Unix epoch.

fun fromUnixEpochMillisecond(millisecond: Long): Instant
(iosArm64, iosX64, jvm, macosX64)

fromUnixEpochSecond

Create an Instant from the second of the Unix epoch.

fun fromUnixEpochSecond(second: Long): Instant
fun fromUnixEpochSecond(second: Long, nanosecondAdjustment: Int): Instant
fun fromUnixEpochSecond(second: Long, nanosecondAdjustment: Long): Instant

Extension Functions

(jvm)

toJavaInstant

fun Instant.toJavaInstant(): Instant