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

toDateTimeInterval

(iosArm64) fun String.toDateTimeInterval(): DateTimeInterval
(iosX64) fun String.toDateTimeInterval(): DateTimeInterval
(jvm) fun String.toDateTimeInterval(): DateTimeInterval
(macosX64) fun String.toDateTimeInterval(): DateTimeInterval
(tvosArm64) fun String.toDateTimeInterval(): DateTimeInterval
(tvosX64) fun String.toDateTimeInterval(): DateTimeInterval
(watchosArm64) fun String.toDateTimeInterval(): DateTimeInterval
(watchosX86) fun String.toDateTimeInterval(): DateTimeInterval

Convert a string to a DateTimeInterval.

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

Examples:

1990-01-04T03/1991-08-30T15:30:05.123
../1991-08-30T15:30:05.123
1990-01-04T03/..
../..
(empty string)

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed time is invalid

(iosArm64)

fun String.toDateTimeInterval(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateTimeInterval

(iosX64)

fun String.toDateTimeInterval(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateTimeInterval

(jvm)

fun String.toDateTimeInterval(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateTimeInterval

(macosX64)

fun String.toDateTimeInterval(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateTimeInterval

(tvosArm64)

fun String.toDateTimeInterval(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateTimeInterval

(tvosX64)

fun String.toDateTimeInterval(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateTimeInterval

(watchosArm64)

fun String.toDateTimeInterval(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateTimeInterval

(watchosX86)

fun String.toDateTimeInterval(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateTimeInterval

Convert a string to a DateTimeInterval using a specific parser.

A set of predefined parsers can be found in DateTimeParsers.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed interval is invalid