core/dev.mmauro.datetimepolyglot

Package-level declarations

Types

ClockWrapper

class ClockWrapper(val clock: Clock)

This class simply wraps a plain Clock.

DatetimePolyglotProvider

class DatetimePolyglotProvider : ContentProvider

PlatformLocale

actual typealias PlatformLocale = ULocale

typealias PlatformLocale = ULocale

expect class PlatformLocale

actual typealias PlatformLocale = Locale

typealias PlatformLocale = Locale

actual typealias PlatformLocale = Locale

typealias PlatformLocale = Locale

TickingValue

data class TickingValue<out T>(val value: T, val nextTick: Duration?)

This class holds a value of type T and a Duration that indicates how much time needs to pass before recalculating value is required (i.e. how long since its production nextTick is valid for).

TickingValueProvider

fun interface TickingValueProvider<T>

Simple interface that allows implementors to provide a TickingValue for a given reference point.

Zoned

data class Zoned<out T>(val value: T, val timeZone: TimeZone)

Hodler for a generic value T that is associated with a TimeZone

Properties

SYSTEM_CLOCK

actual val SYSTEM_CLOCK: StateFlow<ClockWrapper>

Returns a Flow that emits ClockWrapper of Clock.System every time the system clock updates. Initially, a value is always emitted a first time, and it later waits for changes.

expect val SYSTEM_CLOCK: StateFlow<ClockWrapper>

Returns a Flow that emits ClockWrapper of Clock.System every time the system clock updates. Initially, a value is always emitted a first time, and it later waits for changes.

actual val SYSTEM_CLOCK: StateFlow<ClockWrapper>

Returns a Flow that emits ClockWrapper of Clock.System every time the system clock updates. Initially, a value is always emitted a first time, and it later waits for changes.

actual val SYSTEM_CLOCK: StateFlow<ClockWrapper>

Returns a Flow that emits ClockWrapper of Clock.System every time the system clock updates. Initially, a value is always emitted a first time, and it later waits for changes.

SYSTEM_TIMEZONE

actual val SYSTEM_TIMEZONE: StateFlow<TimeZone>

Returns a Flow that emits the current system TimeZone every time it changes. Initially, the current system TimeZone is always emitted a first time.

expect val SYSTEM_TIMEZONE: StateFlow<TimeZone>

Returns a Flow that emits the current system TimeZone every time it changes. Initially, the current system TimeZone is always emitted a first time.

actual val SYSTEM_TIMEZONE: StateFlow<TimeZone>

Returns a Flow that emits the current system TimeZone every time it changes. Initially, the current system TimeZone is always emitted a first time.

actual val SYSTEM_TIMEZONE: StateFlow<TimeZone>

Returns a Flow that emits the current system TimeZone every time it changes. Initially, the current system TimeZone is always emitted a first time.

Functions

collect

suspend fun <T> TickingValueProvider<T>.collect(clock: Clock, timeZone: TimeZone, maxTick: Duration? = null, initialReference: Zoned<Instant> = Zoned(clock.now(), timeZone), initialValue: TickingValue<T> = this.provide(initialReference), collector: suspend (T) -> Unit)

Function that calls collector with the TickingValue.value calculated by this TickingValueProvider.provide each time there is a new value.

combine

fun <T1, T2, R> TickingValue<T1>.combine(other: TickingValue<T2>, transform: (T1, T2) -> R): TickingValue<R>

Combines two different TickingValues.

flatMap

fun <T, R> TickingValue<T>.flatMap(transform: (T) -> TickingValue<R>): TickingValue<R>

Transforms this TickingValue using the transform function. The resulting TickingValue.nextTick will be the min of the two, see also withNextTickAtMost.

getDefaultLocale

actual fun getDefaultLocale(): PlatformLocale

Returns the current default locale (i.e. system locale)

expect fun getDefaultLocale(): PlatformLocale

Returns the current default locale (i.e. system locale)

actual fun getDefaultLocale(): PlatformLocale

Returns the current default locale (i.e. system locale)

actual fun getDefaultLocale(): PlatformLocale

Returns the current default locale (i.e. system locale)

getLocaleFromTag

actual fun getLocaleFromTag(tag: String): PlatformLocale