TimePoint

interface TimePoint<T>
Content copied to clipboard

An object that can be placed exactly in time.

An implementor of this interface contains enough information to represent an instant in time. As such, any time point can be compared to another on the timeline and duration units can be added or subtracted.

Types

Companion
Link copied to clipboard
common
object Companion
Content copied to clipboard

Functions

compareTo
Link copied to clipboard
common
open operator fun compareTo(other: TimePoint<*>): Int
Content copied to clipboard

Compares this time point with another time point.

isSameInstantAs
Link copied to clipboard
common
open fun isSameInstantAs(other: TimePoint<*>): Boolean
Content copied to clipboard

Checks if this time point represents the same instant as other. Unlike the equals operator, equality is determined solely by timeline order.

minus
Link copied to clipboard
common
abstract operator fun minus(hours: Hours): T
Content copied to clipboard
abstract operator fun minus(microseconds: Microseconds): T
Content copied to clipboard
abstract operator fun minus(milliseconds: Milliseconds): T
Content copied to clipboard
abstract operator fun minus(minutes: Minutes): T
Content copied to clipboard
abstract operator fun minus(nanoseconds: Nanoseconds): T
Content copied to clipboard
abstract operator fun minus(seconds: Seconds): T
Content copied to clipboard
plus
Link copied to clipboard
common
abstract operator fun plus(hours: Hours): T
Content copied to clipboard
abstract operator fun plus(microseconds: Microseconds): T
Content copied to clipboard
abstract operator fun plus(milliseconds: Milliseconds): T
Content copied to clipboard
abstract operator fun plus(minutes: Minutes): T
Content copied to clipboard
abstract operator fun plus(nanoseconds: Nanoseconds): T
Content copied to clipboard
abstract operator fun plus(seconds: Seconds): T
Content copied to clipboard

Properties

additionalNanosecondsSinceUnixEpoch
Link copied to clipboard
common
open val additionalNanosecondsSinceUnixEpoch: Nanoseconds
Content copied to clipboard

The number of additional nanoseconds on top of secondsSinceUnixEpoch.

millisecondOfUnixEpoch
Link copied to clipboard
common
abstract val millisecondOfUnixEpoch: Long
Content copied to clipboard

The millisecond of the Unix epoch.

millisecondsSinceUnixEpoch
Link copied to clipboard
common
open val millisecondsSinceUnixEpoch: Milliseconds
Content copied to clipboard

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

nanosecond
Link copied to clipboard
common
abstract val nanosecond: Int
Content copied to clipboard

The nanosecond of the second.

secondOfUnixEpoch
Link copied to clipboard
common
abstract val secondOfUnixEpoch: Long
Content copied to clipboard

The second of the Unix epoch.

secondsSinceUnixEpoch
Link copied to clipboard
common
open val secondsSinceUnixEpoch: Seconds
Content copied to clipboard

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

Inheritors

Instant
Link copied to clipboard
OffsetDateTime
Link copied to clipboard
ZonedDateTime
Link copied to clipboard

Extensions

toNSDate
Link copied to clipboard
darwin
fun <T> TimePoint<T>.toNSDate(): <ERROR CLASS>
Content copied to clipboard

Converts this time point to an NSDate.