core / io.islandtime.ranges / kotlin.String / toOffsetDateTimeInterval

toOffsetDateTimeInterval

(iosArm64) fun String.toOffsetDateTimeInterval(): OffsetDateTimeInterval
(iosX64) fun String.toOffsetDateTimeInterval(): OffsetDateTimeInterval
(jvm) fun String.toOffsetDateTimeInterval(): OffsetDateTimeInterval
(macosX64) fun String.toOffsetDateTimeInterval(): OffsetDateTimeInterval

Convert a string to an OffsetDateTimeInterval.

The string is assumed to be an ISO-8601 time interval representation in extended format. The output of OffsetDateTimeInterval.toString can be safely parsed using this method.

Examples:

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed time is invalid

(iosArm64) fun String.toOffsetDateTimeInterval(parser: GroupedDateTimeParser): OffsetDateTimeInterval
(iosX64) fun String.toOffsetDateTimeInterval(parser: GroupedDateTimeParser): OffsetDateTimeInterval
(jvm) fun String.toOffsetDateTimeInterval(parser: GroupedDateTimeParser): OffsetDateTimeInterval
(macosX64) fun String.toOffsetDateTimeInterval(parser: GroupedDateTimeParser): OffsetDateTimeInterval

Convert a string to an OffsetDateTimeInterval using a specific parser.

A set of predefined parsers can be found in DateTimeParsers.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed time is invalid