core / io.islandtime / kotlin.String / toDateTime

toDateTime

(iosArm64) fun String.toDateTime(): DateTime
(iosX64) fun String.toDateTime(): DateTime
(jvm) fun String.toDateTime(): DateTime
(macosX64) fun String.toDateTime(): DateTime
(tvosArm64) fun String.toDateTime(): DateTime
(tvosX64) fun String.toDateTime(): DateTime
(watchosArm64) fun String.toDateTime(): DateTime
(watchosX86) fun String.toDateTime(): DateTime

Convert a string to a DateTime.

The string is assumed to be an ISO-8601 date-time representation in extended format. For example, 2019-08-22T18:00 or 2019-08-22 18:00:30.123456789. The output of DateTime.toString can be safely parsed using this method.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed date-time is invalid

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

Converts a string to a DateTime 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 both a Date and Time.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed date-time is invalid