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

toDateRange

(iosArm64) fun String.toDateRange(): DateRange
(iosX64) fun String.toDateRange(): DateRange
(jvm) fun String.toDateRange(): DateRange
(macosX64) fun String.toDateRange(): DateRange
(tvosArm64) fun String.toDateRange(): DateRange
(tvosX64) fun String.toDateRange(): DateRange
(watchosArm64) fun String.toDateRange(): DateRange
(watchosX86) fun String.toDateRange(): DateRange

Convert a string to a DateRange.

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

Examples:

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed time is invalid

(iosArm64) fun String.toDateRange(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateRange
(iosX64) fun String.toDateRange(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateRange
(jvm) fun String.toDateRange(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateRange
(macosX64) fun String.toDateRange(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateRange
(tvosArm64) fun String.toDateRange(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateRange
(tvosX64) fun String.toDateRange(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateRange
(watchosArm64) fun String.toDateRange(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateRange
(watchosX86) fun String.toDateRange(parser: GroupedDateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): DateRange

Convert a string to a DateRange using a specific parser.

A set of predefined parsers can be found in DateTimeParsers.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed range is invalid