kotlinx-datetime/kotlinx.datetime.format

Package-level declarations

Types

AmPmMarker

enum AmPmMarker : Enum<AmPmMarker>

The AM/PM marker that indicates whether the hour in range 1..12 is before or after noon.

DateTimeComponents

class DateTimeComponents

A collection of datetime fields used specifically for parsing and formatting.

DateTimeFormat

sealed interface DateTimeFormat<T>

A format for parsing and formatting datetime-related values.

DateTimeFormatBuilder

sealed interface DateTimeFormatBuilder

Common functions for all format builders.

DayOfWeekNames

class DayOfWeekNames(val names: List<String>)

A description of how the names of weekdays are formatted.

FormatStringsInDatetimeFormats

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "Using format strings is discouraged. If the format string is a constant, the corresponding builder-style Kotlin code can be obtained by calling `DateTimeFormat.formatAsKotlinBuilderDsl` on the resulting format.")

annotation class FormatStringsInDatetimeFormats

Marks declarations in the datetime library that use format strings to define datetime formats.

MonthNames

class MonthNames(val names: List<String>)

A description of how month names are formatted.

Padding

enum Padding : Enum<Padding>

The style of padding to use when formatting a value.

Functions

alternativeParsing

fun <T : DateTimeFormatBuilder> T.alternativeParsing(vararg alternativeFormats: T.() -> Unit, primaryFormat: T.() -> Unit)

A format along with other ways to parse the same portion of the value.

byUnicodePattern

@FormatStringsInDatetimeFormats

fun DateTimeFormatBuilder.byUnicodePattern(pattern: String)

Appends a Unicode datetime format string to the DateTimeFormatBuilder.

char

fun DateTimeFormatBuilder.char(value: Char)

A literal character.

format

fun DateTimeFormat<DateTimeComponents>.format(block: DateTimeComponents.() -> Unit): String

Uses this format to format an unstructured DateTimeComponents.

optional

fun <T : DateTimeFormatBuilder> T.optional(ifZero: String = "", format: T.() -> Unit)

An optional section.

parse

fun DateTimeComponents.Companion.parse(input: CharSequence, format: DateTimeFormat<DateTimeComponents>): DateTimeComponents

Parses a DateTimeComponents from input using the given format. Equivalent to calling DateTimeFormat.parse on format with input.

parseOrNull

fun DateTimeComponents.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<DateTimeComponents>): DateTimeComponents?

Parses a DateTimeComponents from input using the given format or returns null if the string does not match the pattern. Equivalent to calling DateTimeFormat.parseOrNull on format with input.

Thanks for your feedback!

Was this page helpful?