core / io.islandtime / kotlin.String / toOffsetDateTime

toOffsetDateTime

(iosArm64) fun String.toOffsetDateTime(): OffsetDateTime
(iosX64) fun String.toOffsetDateTime(): OffsetDateTime
(jvm) fun String.toOffsetDateTime(): OffsetDateTime
(macosX64) fun String.toOffsetDateTime(): OffsetDateTime
(tvosArm64) fun String.toOffsetDateTime(): OffsetDateTime
(tvosX64) fun String.toOffsetDateTime(): OffsetDateTime
(watchosArm64) fun String.toOffsetDateTime(): OffsetDateTime
(watchosX86) fun String.toOffsetDateTime(): OffsetDateTime

Converts a string to an OffsetDateTime.

The string is assumed to be an ISO-8601 date-time with the UTC offset in extended format. For example, 2019-05-30T02:30+01:00. The output of OffsetDateTime.toString can be safely parsed using this method.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed date-time or offset is invalid

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

Converts a string to an OffsetDateTime 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 a Date, Time and UtcOffset.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed date-time or offset is invalid