fluent-bundle/dev.kbroom.fluent.bundle/FluentBundle

FluentBundle

Immutable runtime bundle for localizing messages.

A FluentBundle holds messages, terms, and functions for a specific locale, plus the configuration needed to format them. Construct one through FluentBundleBuilder (or the fluentBundle DSL) — the public constructor is internal so bundles are guaranteed immutable by construction.

Basic usage

val bundle = fluentBundle(locales = listOf(LanguageIdentifier.parse("en-US"))) {
    resource("hello = Hello, { $name }!")
    builtins()
}
val output = bundle.format("hello", fluentArgsOf("name" to "World"))

After build returns, every method on this class is safe to call from multiple threads simultaneously. The internal state is populated once and never mutated.

Properties

locales

val locales: List<LanguageIdentifier>

The list of locales this bundle supports (primary locale is first)

useIsolating

val useIsolating: Boolean

Whether Unicode bidi isolation marks are emitted

Functions

entries

fun entries(): Map<String, Entry>

Snapshot copy of every message and term in this bundle, keyed by ID. Matches fluent-rs's FluentBundle::entries.

format

fun format(id: String, args: FluentArgs? = null): String?

Alias for formatMessage.

formatAttribute

fun formatAttribute(id: String, attribute: String, args: FluentArgs? = null): String?

Format a specific attribute of a message by ID.

formatMessage

fun formatMessage(id: String, args: FluentArgs? = null): String?

Format a message by its ID, resolving all references.

formatMessageWithErrors

fun formatMessageWithErrors(id: String, args: FluentArgs? = null): Pair<String?, List<FluentError>>

Format a message and return both the result and any errors collected during resolution. Returns (null, [...]) for a missing message id and (null, []) for an empty-value message; otherwise (text, errors).

formatPattern