datetime-polyglot/dev.mmauro.datetimepolyglot.localizers.relative/RelativeInstantLocalizer

RelativeInstantLocalizer

class RelativeInstantLocalizer(options: RelativeInstantOptions = RelativeInstantOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceValueLocalizer<Instant> (source)

Localizes an Instant relative to another one.

This class is a simple convenience over RelativeDurationLocalizer, simply calculating the diff and forwarding the localization request to it. As this implements PolyglotReferenceValueLocalizer, this allows to use localizeAsFlow.

For this reason, the options required here are identical to RelativeDurationLocalizer.

Create once and re-use for localizing multiple values with the same options. Use Instant.localizeRelative or Instant.localizeRelativeAsFlow for one-off localizations.

Examples:

10 minutes ago
in 1 hour
4h ago
4 hr. ago
in 2 days

Constructors

RelativeInstantLocalizer

constructor(options: RelativeInstantOptions = RelativeInstantOptions(), locale: PlatformLocale = getDefaultLocale())

Functions

localize

open override fun localize(value: Instant, reference: Zoned<Instant>): TickingValue<String>

fun localize(value: Instant, reference: Instant): TickingValue<String>

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.

RelativeInstantLocalizer

See also

Constructors

Functions