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

toInstantInterval

(iosArm64) fun String.toInstantInterval(): InstantInterval
(iosX64) fun String.toInstantInterval(): InstantInterval
(jvm) fun String.toInstantInterval(): InstantInterval
(macosX64) fun String.toInstantInterval(): InstantInterval
(tvosArm64) fun String.toInstantInterval(): InstantInterval
(tvosX64) fun String.toInstantInterval(): InstantInterval
(watchosArm64) fun String.toInstantInterval(): InstantInterval
(watchosX86) fun String.toInstantInterval(): InstantInterval

Convert a string to an InstantInterval.

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

Examples:

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed time is invalid

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

Convert a string to an InstantInterval 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