core / io.islandtime.parser / DateTimeParserBuilder

DateTimeParserBuilder

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) interface DateTimeParserBuilder

Functions

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

anyOf

Try each of the parsers defined by builders until one succeeds. If none succeed, parsing is considered to have failed.

abstract fun anyOf(vararg builders: DateTimeParserBuilder.() -> Unit): Unit

Try each of the parsers defined by childParsers until one succeeds. If none succeed, parsing is considered to have failed.

abstract fun anyOf(vararg childParsers: DateTimeParser): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

caseInsensitive

Force parsing to be case-insensitive within this block.

abstract fun caseInsensitive(builder: DateTimeParserBuilder.() -> Unit): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

caseSensitive

Force parsing to be case-sensitive within this block.

abstract fun caseSensitive(builder: DateTimeParserBuilder.() -> Unit): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

childParser

Use a parser that has been defined outside of this builder.

abstract fun childParser(childParser: DateTimeParser): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

decimalNumber

Parse a decimal number.

abstract fun decimalNumber(wholeLength: IntRange = 1..19, fractionLength: IntRange = 0..9, fractionScale: Int = 9, builder: DecimalNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

literal

Parse a Char literal.

abstract fun literal(char: Char, builder: LiteralParserBuilder.() -> Unit = {}): Unit

Parse a String literal.

abstract fun literal(string: String, builder: LiteralParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

localizedText

Parse localized text associated with a particular DateTimeField in any of the specified styles. If successful, the field's value will be populated. If no text is known for the field or a match can't be found, the parsing operation will return an error.

abstract fun localizedText(field: DateTimeField, styles: Set<TextStyle>): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

optional

Make parsing optional within a block.

abstract fun optional(builder: DateTimeParserBuilder.() -> Unit): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

sign

Parse a character indicating the sign of a number.

abstract fun sign(builder: SignParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

string

Parse a variable length string.

abstract fun string(length: IntRange = IntRange.EMPTY, builder: StringParserBuilder.() -> Unit): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

unaryPlus

Parse a Char literal.

open operator fun Char.unaryPlus(): Unit

Parse a String literal.

open operator fun String.unaryPlus(): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

wholeNumber

Parse a whole number of fixed length.

abstract fun wholeNumber(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit

Parse a whole number of variable length.

abstract fun wholeNumber(length: IntRange = 1..19, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit