datetime-polyglot/dev.mmauro.datetimepolyglot.localizers

Package-level declarations

Types

PolyglotDateTimeLocalizer

interface PolyglotDateTimeLocalizer<in T> : PolyglotValueLocalizer<T, String>

Specialization of PolyglotValueLocalizer that allows to localize a date/time value T and returns a simple String.

PolyglotDateTimeZonedLocalizer

interface PolyglotDateTimeZonedLocalizer<in T> : PolyglotValueLocalizer<Zoned<T>, String>

Specialization of PolyglotValueLocalizer that allows to localize a Zoned date/time value T and returns a simple String.

PolyglotLocalizer

sealed interface PolyglotLocalizer

Marker interface for all localizer classes of datetime-polyglot.

PolyglotReferenceValueLocalizer

interface PolyglotReferenceValueLocalizer<in T> : PolyglotLocalizer

A generic PolyglotLocalizer that accepts a value of type T and a Zoned<Instant> reference point, and returns a TickingValue of type String.

PolyglotValueLocalizer

interface PolyglotValueLocalizer<in T, out R> : PolyglotLocalizer

A generic PolyglotLocalizer that accepts a just value of type T and returns a result of type R.

Functions

localize

fun <T> PolyglotReferenceValueLocalizer<T>.localize(value: T, clock: Clock = Clock.System): TickingValue<String>

Localizes value by using the given clock's Clock.now as a reference point, rather than passing the reference explicitly.

localizeAsFlow

fun <T> PolyglotReferenceValueLocalizer<T>.localizeAsFlow(value: T, clock: Clock = Clock.System, maxTick: Duration? = null): Flow<String>

Localizes value by using the given clock's Clock.now as a reference point and returns a Flow that emits updated values based on the underlying TickingValue.nextTick. This function assumes that the given clock moves forward linearly.