kotlinx-datetime/kotlinx.datetime/UtcOffset

UtcOffset

@Serializable(with = UtcOffsetSerializer::class)

actual class UtcOffset(source)

@Serializable(with = UtcOffsetSerializer::class)

expect class UtcOffset(source)

An offset from UTC.

Examples of these values:

Z, an offset of zero;
+05, plus five hours;
-02, minus two hours;
+03:30, plus three hours and thirty minutes;
+01:23:45, plus one hour, 23 minutes, and 45 seconds.

@Serializable(with = UtcOffsetSerializer::class)

actual class UtcOffset(zoneOffset: ZoneOffset)(source)

@Serializable(with = UtcOffsetSerializer::class)

actual class UtcOffset(source)

Constructors

UtcOffset

constructor(zoneOffset: ZoneOffset)

Types

Companion

actual object Companion

expect object Companion

actual object Companion

Formats

actual object Formats

expect object Formats

A collection of predefined formats for parsing and formatting UtcOffset values.

actual object Formats

Properties

totalSeconds

actual val totalSeconds: Int

expect val totalSeconds: Int

The number of seconds from UTC.

actual val totalSeconds: Int

Functions

asTimeZone

fun UtcOffset.asTimeZone(): FixedOffsetTimeZone

Returns the fixed-offset time zone with the given UTC offset.

equals

open operator override fun equals(other: Any?): Boolean

format

fun UtcOffset.format(format: DateTimeFormat<UtcOffset>): String

Formats this value using the given format. Equivalent to calling DateTimeFormat.format on format with this.

hashCode

open override fun hashCode(): Int

toJavaZoneOffset

fun UtcOffset.toJavaZoneOffset(): ZoneOffset

Converts this kotlinx.datetime.UtcOffset value to a java.time.ZoneOffset value.

toString

actual open override fun toString(): String

expect open override fun toString(): String

Converts this UTC offset to the extended ISO-8601 string representation.

actual open override fun toString(): String