core / io.islandtime / kotlin.String / toUtcOffset

toUtcOffset

(iosArm64) fun String.toUtcOffset(): UtcOffset
(iosX64) fun String.toUtcOffset(): UtcOffset
(jvm) fun String.toUtcOffset(): UtcOffset
(macosX64) fun String.toUtcOffset(): UtcOffset
(tvosArm64) fun String.toUtcOffset(): UtcOffset
(tvosX64) fun String.toUtcOffset(): UtcOffset
(watchosArm64) fun String.toUtcOffset(): UtcOffset
(watchosX86) fun String.toUtcOffset(): UtcOffset

Converts a string to a UtcOffset.

The string is assumed to be an ISO-8601 UTC offset representation in extended format. For example, Z, +05, or -04:30. The output of UtcOffset.toString can be safely parsed using this method.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed UTC offset is invalid

(iosArm64) fun String.toUtcOffset(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): UtcOffset
(iosX64) fun String.toUtcOffset(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): UtcOffset
(jvm) fun String.toUtcOffset(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): UtcOffset
(macosX64) fun String.toUtcOffset(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): UtcOffset
(tvosArm64) fun String.toUtcOffset(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): UtcOffset
(tvosX64) fun String.toUtcOffset(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): UtcOffset
(watchosArm64) fun String.toUtcOffset(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): UtcOffset
(watchosX86) fun String.toUtcOffset(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): UtcOffset

Converts a string to a UtcOffset using a specific parser.

A set of predefined parsers can be found in DateTimeParsers.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed UTC offset is invalid