core / io.islandtime / kotlin.String / toOffsetTime

toOffsetTime

(iosArm64) fun String.toOffsetTime(): OffsetTime
(iosX64) fun String.toOffsetTime(): OffsetTime
(jvm) fun String.toOffsetTime(): OffsetTime
(macosX64) fun String.toOffsetTime(): OffsetTime
(tvosArm64) fun String.toOffsetTime(): OffsetTime
(tvosX64) fun String.toOffsetTime(): OffsetTime
(watchosArm64) fun String.toOffsetTime(): OffsetTime
(watchosX86) fun String.toOffsetTime(): OffsetTime

Converts a string to an OffsetTime.

The string is assumed to be an ISO-8601 time with the UTC offset in extended format. For example, 02:30+01:00 or 14:40:23Z. The output of OffsetTime.toString can be safely parsed using this method.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed time or offset is invalid

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

Converts a string to an OffsetTime using a specific parser.

A set of predefined parsers can be found in DateTimeParsers.

Any custom parser must be capable of supplying the fields necessary to resolve both a Time and UtcOffset.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed time or offset is invalid